m3d.F90 21.7 KB
Newer Older
gotm's avatar
gotm committed
1 2 3 4 5 6 7 8 9 10
#include "cppdefs.h"
!-----------------------------------------------------------------------
!BOP
!
! !MODULE: m3d - 3D model component
!
! !INTERFACE:
   module m3d
!
! !DESCRIPTION:
hb's avatar
hb committed
11
!  This module contains declarations for all variables related to 3D
gotm's avatar
gotm committed
12
!  hydrodynamical calculations. Information about the calculation domain
hb's avatar
hb committed
13
!  is included from the {\tt domain} module.
gotm's avatar
gotm committed
14 15
!  The module contains public subroutines for initialisation, integration
!  and clean up of the 3D model component.
hb's avatar
hb committed
16 17 18 19 20 21 22 23
!  The {\tt m3d} module is initialised in the routine {\tt init\_3d}, see
!  section \ref{sec-init-3d} described on page
!  \pageref{sec-init-3d}.
!  The actual calculation routines are called in {\tt integrate\_3d}
!  (see section \ref{sec-integrate-3d} on page \pageref{sec-integrate-3d}).
!  and are linked in from the library {\tt lib3d.a}.
!  After the simulation, the module is closed in {\tt clean\_3d}, see
!  section \ref{sec-clean-3d} on page \pageref{sec-clean-3d}.
gotm's avatar
gotm committed
24 25
!
! !USES:
26
   use exceptions
gotm's avatar
gotm committed
27
   use parameters, only: avmmol
28
   use domain, only: openbdy,maxdepth,vert_cord,az
29
   use m2d, only: depth_update,uv_advect,uv_diffusion
30
   use variables_2d, only: z,Uint,Vint,UEx,VEx
kbk's avatar
kbk committed
31
#ifndef NO_BAROCLINIC
32 33 34
   use temperature,only: init_temperature, do_temperature, &
            init_temperature_field
   use salinity,   only: init_salinity, do_salinity, init_salinity_field
kbk's avatar
kbk committed
35
   use eqstate,    only: init_eqstate, do_eqstate
36 37
   use internal_pressure, only: init_internal_pressure, do_internal_pressure
   use internal_pressure, only: ip_method
kbk's avatar
kbk committed
38
#endif
39
   use variables_3d
40 41
   use advection, only: NOADV
   use advection_3d, only: init_advection_3d,print_adv_settings_3d,adv_ver_iterations
kbk's avatar
kbk committed
42
   use bdy_3d, only: init_bdy_3d, do_bdy_3d
43
   use bdy_3d, only: bdy3d_tmrlx, bdy3d_tmrlx_ucut, bdy3d_tmrlx_max, bdy3d_tmrlx_min
44
!  Necessary to use halo_zones because update_3d_halos() have been moved out
kbk's avatar
kbk committed
45 46
!  temperature.F90 and salinity.F90 - should be changed at a later stage
   use halo_zones, only: update_3d_halo,wait_halo,D_TAG
kbk's avatar
kbk committed
47

gotm's avatar
gotm committed
48 49 50
   IMPLICIT NONE
!
! !PUBLIC DATA MEMBERS:
kbk's avatar
kbk committed
51
   integer                             :: M=1
52
   REALTYPE                            :: cord_relax=_ZERO_
53 54 55
   integer                             :: vel3d_adv_split=0
   integer                             :: vel3d_adv_hor=1
   integer                             :: vel3d_adv_ver=1
56 57 58
   integer                             :: turb_adv_split=0
   integer                             :: turb_adv_hor=0
   integer                             :: turb_adv_ver=0
59 60
   logical                             :: calc_temp=.true.
   logical                             :: calc_salt=.true.
kbk's avatar
kbk committed
61
   logical                             :: bdy3d=.false.
62
   integer                             :: bdyfmt_3d,bdy3d_ramp
kbk's avatar
kbk committed
63
   character(len=PATH_MAX)             :: bdyfile_3d
kbk's avatar
kbk committed
64
   REALTYPE                            :: ip_fac=_ONE_
65
   integer                             :: vel_check=0
66
   REALTYPE                            :: min_vel=-4*_ONE_,max_vel=4*_ONE_
gotm's avatar
gotm committed
67
!
kbk's avatar
kbk committed
68 69 70
! !REVISION HISTORY:
!  Original author(s): Karsten Bolding & Hans Burchard
!
gotm's avatar
gotm committed
71
! !LOCAL VARIABLES:
Knut's avatar
Knut committed
72
   logical,private :: ufirst=.true.
73
   logical         :: advect_turbulence=.false.
kbk's avatar
kbk committed
74 75 76
#ifdef NO_BAROCLINIC
   integer         :: ip_method
#endif
kbk's avatar
kbk committed
77
   integer         :: ip_ramp=-1
gotm's avatar
gotm committed
78 79 80 81 82 83 84 85
!EOP
!-----------------------------------------------------------------------

   contains

!-----------------------------------------------------------------------
!BOP
!
hb's avatar
hb committed
86
! !IROUTINE: init_3d - initialise 3D related stuff \label{sec-init-3d}
gotm's avatar
gotm committed
87 88 89
!
! !INTERFACE:
   subroutine init_3d(runtype,timestep,hotstart)
90
!
gotm's avatar
gotm committed
91 92 93
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
94
   integer, intent(in)                 :: runtype
kbk's avatar
kbk committed
95 96
   REALTYPE, intent(in)                :: timestep
   logical, intent(in)                 :: hotstart
gotm's avatar
gotm committed
97 98
!
! !DESCRIPTION:
hb's avatar
hb committed
99 100 101 102 103 104
!  Here, the {\tt m3d} namelist is read from {\tt getm.inp}, and the
!  initialisation of variables is called (see routine {\tt init\_variables}
!  described on page \pageref{sec-init-variables}).
!  Furthermore, a number of consistency checks are made for the choices
!  of the momentum advection schemes. When higher-order advection schemes
!  are chosen for the momentum advection, the compiler option {\tt UV\_TVD}
105
!  has to be set. Here, the macro time step $\Delta t$ is calculated
hb's avatar
hb committed
106 107 108
!  from the micro time step $\Delta t_m$ and the split factor {\tt M}.
!  Then, in order to have the vertical coordinate system present already here,
!  {\tt coordinates} (see page \pageref{sec-coordinates}) needs to be called,
109 110
!  in order to enable proper interpolation of initial values for
!  potential temperature $\theta$ and salinity $S$ for cold starts.
hb's avatar
hb committed
111 112 113 114 115 116
!  Those initial values are afterwards read in via the routines
!  {\tt init\_temperature} (page \pageref{sec-init-temperature}) and
!  {\tt init\_salinity} (page \pageref{sec-init-salinity}).
!  Finally, in order to prepare for the first time step, the momentum advection
!  and internal pressure gradient routines are initialised and the
!  internal pressure gradient routine is called.
gotm's avatar
gotm committed
117 118
!
! !LOCAL VARIABLES:
119
   integer         :: rc
kbk's avatar
kbk committed
120
   NAMELIST /m3d/ &
121
             M,cnpar,cord_relax,adv_ver_iterations,       &
122
             bdy3d,bdyfmt_3d,bdy3d_ramp,bdyfile_3d,       &
123 124 125
             bdy3d_tmrlx,bdy3d_tmrlx_ucut,                &
             bdy3d_tmrlx_max,bdy3d_tmrlx_min,             &
             vel3d_adv_split,vel3d_adv_hor,vel3d_adv_ver, &
126
             turb_adv_split,turb_adv_hor,turb_adv_ver,    &
127
             calc_temp,calc_salt,                         &
128
             avmback,avhback,                             &
129
             ip_method,ip_ramp,                           &
130
             vel_check,min_vel,max_vel
gotm's avatar
gotm committed
131 132 133 134 135 136 137 138 139 140 141 142 143 144
!EOP
!-------------------------------------------------------------------------
!BOC
#ifdef DEBUG
   integer, save :: Ncall = 0
   Ncall = Ncall+1
   write(debug,*) 'init_3d() # ',Ncall
#endif

   LEVEL1 'init_3d'
!  Read 3D-model specific things from the namelist.
   read(NAMLST,m3d)
!   rewind(NAMLST)

Knut's avatar
Knut committed
145 146
   LEVEL2 "splitting factor M: ",M

147 148 149 150 151 152 153 154 155
   if (avmback .lt. _ZERO_) then
      LEVEL2 "setting avmback to 0."
      avmback = _ZERO_
   end if
   if (avhback .lt. _ZERO_) then
      LEVEL2 "setting avhback to 0."
      avhback = _ZERO_
   end if

gotm's avatar
gotm committed
156 157
! Allocates memory for the public data members - if not static
   call init_variables_3d(runtype)
158
   call init_advection_3d()
gotm's avatar
gotm committed
159

160
!  Sanity checks for advection specifications
161 162 163 164 165 166 167 168 169 170 171 172 173
   LEVEL2 'Advection of horizontal 3D velocities'
#ifdef NO_ADVECT
   if (vel3d_adv_hor .ne. NOADV) then
      LEVEL2 "reset vel3d_adv_hor= ",NOADV," because of"
      LEVEL2 "obsolete NO_ADVECT macro. Note that this"
      LEVEL2 "behaviour will be removed in the future."
      vel3d_adv_hor = NOADV
   end if
   if (vel3d_adv_ver .ne. NOADV) then
      LEVEL2 "reset vel3d_adv_ver= ",NOADV," because of"
      LEVEL2 "obsolete NO_ADVECT macro. Note that this"
      LEVEL2 "behaviour will be removed in the future."
      vel3d_adv_ver = NOADV
gotm's avatar
gotm committed
174
   end if
175 176
#endif
   call print_adv_settings_3d(vel3d_adv_split,vel3d_adv_hor,vel3d_adv_ver,_ZERO_)
177

178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209

#ifndef CONSTANT_VISCOSITY

   LEVEL2 'Advection of TKE and eps'

#ifdef NO_ADVECT
   if (turb_adv_hor .ne. NOADV) then
      LEVEL2 "reset turb_adv_hor= ",NOADV," because of"
      LEVEL2 "obsolete NO_ADVECT macro. Note that this"
      LEVEL2 "behaviour will be removed in the future."
      turb_adv_hor = NOADV
   end if
   if (turb_adv_ver .ne. NOADV) then
      LEVEL2 "reset turb_adv_ver= ",NOADV," because of"
      LEVEL2 "obsolete NO_ADVECT macro. Note that this"
      LEVEL2 "behaviour will be removed in the future."
      turb_adv_ver = NOADV
   end if
#endif
   call print_adv_settings_3d(turb_adv_split,turb_adv_hor,turb_adv_ver,_ZERO_)

   advect_turbulence = (turb_adv_hor.ne.NOADV .or. turb_adv_ver.ne.NOADV)

#ifdef TURB_ADV
   if (.not. advect_turbulence) then
      LEVEL2 "WARNING: ignored obsolete TURB_ADV macro!"
   end if
#endif

#endif


bjb's avatar
bjb committed
210
!  Sanity checks for bdy 3d
Knut's avatar
Knut committed
211
   if (.not.openbdy .or. runtype.eq.2) bdy3d=.false.
212 213 214 215 216 217 218 219 220 221 222 223 224 225
   if (bdy3d .and. bdy3d_tmrlx) then
      LEVEL2 'bdy3d_tmrlx=.true.'
      LEVEL2 'bdy3d_tmrlx_max=   ',bdy3d_tmrlx_max
      LEVEL2 'bdy3d_tmrlx_min=   ',bdy3d_tmrlx_min
      LEVEL2 'bdy3d_tmrlx_ucut=  ',bdy3d_tmrlx_ucut
      if (bdy3d_tmrlx_min<_ZERO_ .or. bdy3d_tmrlx_min>_ONE_)          &
           call getm_error("init_3d()",                               &
           "bdy3d_tmrlx_min is out of valid range [0:1]")
      if (bdy3d_tmrlx_max<bdy3d_tmrlx_min .or. bdy3d_tmrlx_min>_ONE_) &
           call getm_error("init_3d()",                               &
           "bdy3d_tmrlx_max is out of valid range [bdy3d_tmrlx_max:1]")
      if (bdy3d_tmrlx_ucut<_ZERO_)                                    &
           call getm_error("init_3d()",                               &
           "bdy3d_tmrlx_max is out of valid range [0:inf[")
bjb's avatar
bjb committed
226 227
   end if

kbk's avatar
kbk committed
228 229
   LEVEL2 'ip_ramp=',ip_ramp

230 231
   LEVEL2 'vel_check=',vel_check
   if (vel_check .ne. 0) then
kbk's avatar
kbk committed
232 233 234
      LEVEL3 'doing sanity checks on velocities'
      LEVEL3 'min_vel=',min_vel
      LEVEL3 'max_vel=',max_vel
235 236 237 238 239 240 241 242
      if (vel_check .gt. 0) then
         LEVEL3 'out-of-bound values result in termination of program'
      end if
      if (vel_check .lt. 0) then
         LEVEL3 'out-of-bound values result in warnings only'
      end if
   end if

gotm's avatar
gotm committed
243
   dt = M*timestep
244 245 246 247 248

#ifdef CONSTANT_VISCOSITY
   num=avmback
   nuh=avhback
#else
249 250
   num=1.d-15
   nuh=1.d-15
251
#endif
gotm's avatar
gotm committed
252 253

!  Needed for interpolation of temperature and salinity
kbk's avatar
kbk committed
254
   if (.not. hotstart) then
255
      ssen = z
gotm's avatar
gotm committed
256
      call start_macro()
257
      call coordinates(hotstart)
258
      call hcc_check()
kbk's avatar
kbk committed
259
   end if
gotm's avatar
gotm committed
260

261 262 263 264
   if (runtype .eq. 2) then
      calc_temp = .false.
      calc_salt = .false.
   else
kbk's avatar
kbk committed
265
#ifndef NO_BAROCLINIC
gotm's avatar
gotm committed
266
      T = _ZERO_ ; S = _ZERO_ ; rho = _ZERO_
267 268
      if(calc_temp) call init_temperature()
      if(calc_salt) call init_salinity()
269
#endif
270
   end if
kbk's avatar
kbk committed
271

272
#ifndef NO_BAROCLINIC
kbk's avatar
kbk committed
273
    if (runtype .eq. 3 .or. runtype .eq. 4) then
274
      call init_eqstate()
gotm's avatar
gotm committed
275 276
#ifndef PECS
      call do_eqstate()
277
      call ss_nn()
gotm's avatar
gotm committed
278
#endif
279 280

      if (bdy3d) call init_bdy_3d()
281 282
      if (runtype .ge. 3) call init_internal_pressure()
      if (runtype .eq. 3) call do_internal_pressure()
gotm's avatar
gotm committed
283
   end if
284
#endif
285

286
   if (vert_cord .eq. _ADAPTIVE_COORDS_) call preadapt_coordinates(preadapt)
kb's avatar
kb committed
287

gotm's avatar
gotm committed
288 289 290 291 292 293 294 295
#ifdef DEBUG
   write(debug,*) 'Leaving init_3d()'
   write(debug,*)
#endif
   return
   end subroutine init_3d
!EOC

296 297 298 299 300 301
!-----------------------------------------------------------------------
!BOP
!
! !IROUTINE: postinit_3d - re-initialise some 3D after hotstart read.
!
! !INTERFACE:
Knut's avatar
Knut committed
302
   subroutine postinit_3d(runtype,timestep,hotstart,MinN)
303 304 305 306 307
! !USES:
   use domain, only: imin,imax,jmin,jmax, az,au,av
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
Knut's avatar
Knut committed
308
   integer, intent(in)                 :: runtype,MinN
309 310
   REALTYPE, intent(in)                :: timestep
   logical, intent(in)                 :: hotstart
311 312 313 314 315 316
!
! !INPUT/OUTPUT PARAMETERS:
!
! !OUTPUT PARAMETERS:
!
! !DESCRIPTION:
317 318
!  This routine provides possibility to reset/initialize 3D variables to
!  ensure that velocities are correctly set on land cells after read
319 320 321
!  of a hotstart file.
!
! !LOCAL VARIABLES:
322
   integer                   :: i,j,rc
323 324 325 326 327 328 329 330 331 332 333
!EOP
!-------------------------------------------------------------------------
!BOC
#ifdef DEBUG
   integer, save :: Ncall = 0
   Ncall = Ncall+1
   write(debug,*) 'postinit_3d() # ',Ncall
#endif

   LEVEL1 'postinit_3d'

Knut's avatar
Knut committed
334 335
   ufirst = ( mod(int(ceiling((_ONE_*MinN)/M)),2) .eq. 1 )

336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
   if (do_numerical_analyses) then

      allocate(numdis3d(I3DFIELD),stat=rc)
      if (rc /= 0) stop 'postinit_3d: Error allocating memory (numdis3d)'
      numdis3d = _ZERO_
      allocate(numdis2d(I2DFIELD),stat=rc)
      if (rc /= 0) stop 'postinit_3d: Error allocating memory (numdis2d)'
      numdis2d = _ZERO_

      if (calc_temp) then
         allocate(phymix3d_T(I3DFIELD),stat=rc)
         if (rc /= 0) stop 'postinit_3d: Error allocating memory (phymix3d_T)'
         phymix3d_T = _ZERO_
         allocate(phymix2d_T(I2DFIELD),stat=rc)
         if (rc /= 0) stop 'postinit_3d: Error allocating memory (phymix2d_T)'
         phymix2d_T = _ZERO_
         allocate(nummix3d_T(I3DFIELD),stat=rc)
         if (rc /= 0) stop 'postinit_3d: Error allocating memory (nummix3d_T)'
         nummix3d_T = _ZERO_
         allocate(nummix2d_T(I2DFIELD),stat=rc)
         if (rc /= 0) stop 'postinit_3d: Error allocating memory (nummix2d_T)'
         nummix2d_T = _ZERO_
      end if

      if (calc_salt) then
         allocate(phymix3d_S(I3DFIELD),stat=rc)
         if (rc /= 0) stop 'postinit_3d: Error allocating memory (phymix3d_S)'
         phymix3d_S = _ZERO_
         allocate(phymix2d_S(I2DFIELD),stat=rc)
         if (rc /= 0) stop 'postinit_3d: Error allocating memory (phymix2d_S)'
         phymix2d_S = _ZERO_
         allocate(nummix3d_S(I3DFIELD),stat=rc)
         if (rc /= 0) stop 'postinit_3d: Error allocating memory (nummix3d_S)'
         nummix3d_S = _ZERO_
         allocate(nummix2d_S(I2DFIELD),stat=rc)
         if (rc /= 0) stop 'postinit_3d: Error allocating memory (nummix2d_S)'
         nummix2d_S = _ZERO_
      end if

   end if

377 378
! Hotstart fix - see postinit_2d
   if (hotstart) then
379

380 381 382 383 384 385
      do j=jmin-HALO,jmax+HALO
         do i=imin-HALO,imax+HALO
            if (au(i,j) .eq. 0) then
               uu(i,j,:)  = _ZERO_
            end if
         end do
386
      end do
387 388 389 390 391 392
      do j=jmin-HALO,jmax+HALO
         do i=imin-HALO,imax+HALO
            if (av(i,j) .eq. 0) then
               vv(i,j,:)  = _ZERO_
            end if
         end do
393
      end do
394 395 396 397 398 399 400 401 402 403 404 405 406
!     These may not be necessary, but we clean up anyway just in case.
      do j=jmin-HALO,jmax+HALO
         do i=imin-HALO,imax+HALO
            if(az(i,j) .eq. 0) then
               tke(i,j,:) = _ZERO_
               num(i,j,:) = 1.e-15
               nuh(i,j,:) = 1.e-15
#ifndef NO_BAROCLINIC
               S(i,j,:)   = _ZERO_
               T(i,j,:)   = _ZERO_
#endif
            end if
         end do
407
      end do
408

Knut's avatar
Knut committed
409
      call depth_update(sseo,ssen,Dn,Dveln,Dun,Dvn,from3d=.true.)
410
!     KK-TODO: do not store ss[u|v]n in hotstart file
Knut's avatar
Knut committed
411
!              can be calculated here (if needed at all... use of D[u|v]n)
412 413
!     ssun = Dun - HU
!     ssvn = Dvn - HV
414 415
      call coordinates(hotstart)

416
   end if
417 418 419 420 421

   return
   end subroutine postinit_3d
!EOC

gotm's avatar
gotm committed
422 423 424
!-----------------------------------------------------------------------
!BOP
!
hb's avatar
hb committed
425 426
! !IROUTINE: integrate_3d - calls to do 3D model integration
! \label{sec-integrate-3d}
gotm's avatar
gotm committed
427 428 429
!
! !INTERFACE:
   subroutine integrate_3d(runtype,n)
bjb's avatar
bjb committed
430
   use getm_timers, only: tic, toc, TIM_INTEGR3D
431 432 433
#ifndef NO_BAROCLINIC
   use getm_timers, only: TIM_TEMPH, TIM_SALTH
#endif
gotm's avatar
gotm committed
434 435 436
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
kbk's avatar
kbk committed
437
   integer, intent(in)                 :: runtype,n
gotm's avatar
gotm committed
438 439 440 441 442 443
!
! !INPUT/OUTPUT PARAMETERS:
!
! !OUTPUT PARAMETERS:
!
! !DESCRIPTION:
hb's avatar
hb committed
444
! This is a wrapper routine to call all 3D related subroutines.
445 446 447
! The call position for the {\tt coordinates} routine depends on
! the compiler option
! {\tt MUDFLAT}: If it is defined, then the
hb's avatar
hb committed
448 449
! call to {\tt coordinates} construction is made such that drying and flooding
! is stable. If {\tt MUDFLAT} is not defined, then the adaptive grids with
450
! Lagrangian component which are currently under development are supported.
hb's avatar
hb committed
451 452 453 454 455
! Both, drying and flooding and
! Lagrangian coordinates does not go together yet.
! The call sequence is as follows:
!
! \vspace{0.5cm}
456
!
hb's avatar
hb committed
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
! \begin{tabular}{lll}
! {\tt start\_macro}           & initialising a 3d step & see page
! \pageref{sec-start-macro} \\
! {\tt do\_bdy\_3d}            & boundary conditions for $\theta$ and $S$ & see
! page \pageref{sec-do-bdy-3d} \\
! {\tt coordinates}            & layer heights ({\tt MUTFLAT} defined) & see
! page \pageref{sec-coordinates} \\
! {\tt bottom\_friction\_3d}   & bottom friction & see page
! \pageref{sec-bottom-friction-3d} \\
! {\tt do\_internal\_pressure} & internal pressure gradient & see page
! \pageref{sec-do-internal-pressure} \\
! {\tt uu\_momentum\_3d}       & layer-integrated $u$-velocity & see page
! \pageref{sec-uu-momentum-3d} \\
! {\tt vv\_momentum\_3d}       & layer-integrated $v$-velocity & see page
! \pageref{sec-vv-momentum-3d} \\
! {\tt coordinates}            & layer heights ({\tt MUTFLAT} not defined) & see
! page \pageref{sec-coordinates} \\
! {\tt ww\_momentum\_3d}       & grid-related vertical velocity & see page
! \pageref{sec-ww-momentum-3d} \\
! {\tt uv\_advect\_3d}         & momentum advection & see page
! \pageref{sec-uv-advect-3d} \\
! {\tt uv\_diffusion\_3d}      & momentum diffusion & see page
! \pageref{sec-uv-diffusion-3d} \\
! {\tt stresses\_3d}           & stresses (for GOTM) & see page
! \pageref{sec-stresses-3d} \\
! {\tt ss\_nn}                 & shear and stratification (for GOTM) & see page
! \pageref{sec-ss-nn} \\
! {\tt gotm}                   & interface and call to GOTM & see page
! \pageref{sec-gotm} \\
! {\tt do\_temperature}        & potential temperature equation & see page
! \pageref{sec-do-temperature} \\
! {\tt do\_salinity}           & salinity equation & see page
! \pageref{sec-do-salinity} \\
! {\tt do\_eqstate}            & equation of state & see page
! \pageref{sec-do-eqstate} \\
492
! {\tt do\_spm}                & suspended matter equation & see page
hb's avatar
hb committed
493 494 495 496 497 498 499 500 501 502 503 504 505
! \pageref{sec-do-spm} \\
! {\tt do\_getm\_bio}          & call to GOTM-BIO (not yet released) & \\
! {\tt slow\_bottom\_friction} & slow bottom friction & see page
! \pageref{sec-slow-bottom-friction} \\
! {\tt slow\_advection}        & slow advection terms & see page
! \pageref{sec-slow-advection} \\
! {\tt slow\_diffusion}        & slow diffusion terms & see page
! \pageref{sec-slow-diffusion} \\
! {\tt slow\_terms}            & sum of slow terms & see page
! \pageref{sec-slow-terms} \\
! {\tt stop\_macro}            & finishing a 3d step & see page
! \pageref{sec-stop-macro}
! \end{tabular}
506
!
hb's avatar
hb committed
507 508 509 510 511 512
! \vspace{0.5cm}
!
! Several calls are only executed for certain compiler options. At each
! time step the call sequence for the horizontal momentum equations is
! changed in order to allow for higher order accuracy for the Coriolis
! rotation.
gotm's avatar
gotm committed
513 514 515 516 517 518 519 520 521 522 523 524
!
! !LOCAL VARIABLES:
!
!EOP
!-------------------------------------------------------------------------
!BOC
#ifdef DEBUG
   integer, save :: Ncall = 0
   Ncall = Ncall+1
   write(debug,*) 'integrate_3d() # ',Ncall
#endif
   call start_macro()
kbk's avatar
kbk committed
525 526
#ifndef NO_BAROCLINIC
#endif
527
#ifdef MUDFLAT
528
   call coordinates(.false.)
529
#endif
gotm's avatar
gotm committed
530
#ifndef NO_BOTTFRIC
kbk's avatar
kbk committed
531
   if (kmax .gt. 1) then
gotm's avatar
gotm committed
532 533 534
      call bottom_friction_3d()
   end if
#endif
bjb's avatar
bjb committed
535
   call tic(TIM_INTEGR3D)
gotm's avatar
gotm committed
536
   SS = _ZERO_
bjb's avatar
bjb committed
537
   call toc(TIM_INTEGR3D)
kbk's avatar
kbk committed
538
#ifndef NO_BAROCLINIC
bjb's avatar
bjb committed
539
   call tic(TIM_INTEGR3D)
gotm's avatar
gotm committed
540
   NN = _ZERO_
bjb's avatar
bjb committed
541
   call toc(TIM_INTEGR3D)
542
   if (runtype .eq. 4) call do_internal_pressure()
kbk's avatar
kbk committed
543
#endif
bjb's avatar
bjb committed
544
   call tic(TIM_INTEGR3D)
545 546
   huo=hun
   hvo=hvn
kbk's avatar
kbk committed
547
   ip_fac=_ONE_
frv-bjb's avatar
frv-bjb committed
548
   if (ip_ramp .gt. 0) ip_fac=min( _ONE_ , n*_ONE_/ip_ramp)
bjb's avatar
bjb committed
549
   call toc(TIM_INTEGR3D)
550 551 552
#ifdef STRUCTURE_FRICTION
   call structure_friction_3d
#endif
gotm's avatar
gotm committed
553
   if (ufirst) then
554 555
      call uu_momentum_3d(n,bdy3d)
      call vv_momentum_3d(n,bdy3d)
gotm's avatar
gotm committed
556 557
      ufirst=.false.
   else
558 559
      call vv_momentum_3d(n,bdy3d)
      call uu_momentum_3d(n,bdy3d)
gotm's avatar
gotm committed
560 561
      ufirst=.true.
   end if
562

563
#ifndef MUDFLAT
564 565 566 567
   if (kmax .gt. 1) then
      if (vert_cord .eq. _ADAPTIVE_COORDS_) call ss_nn()
   end if
   call coordinates(.false.)
568
#endif
Knut's avatar
Knut committed
569

gotm's avatar
gotm committed
570
   if (kmax .gt. 1) then
Knut's avatar
Knut committed
571

gotm's avatar
gotm committed
572
      call ww_momentum_3d()
573 574 575 576

      call uv_advect_3d()
      call uv_diffusion_3d()  ! Must be called after uv_advect_3d

577
#ifndef NO_BOTTFRIC
gotm's avatar
gotm committed
578
      call stresses_3d()
579 580
#endif
#ifndef CONSTANT_VISCOSITY
gotm's avatar
gotm committed
581
#ifndef PARABOLIC_VISCOSITY
582
      if (vert_cord .ne. _ADAPTIVE_COORDS_) call ss_nn()
gotm's avatar
gotm committed
583 584
#endif
      call gotm()
585
      if (advect_turbulence) call tke_eps_advect_3d()
gotm's avatar
gotm committed
586
#endif
Knut's avatar
Knut committed
587

588
   end if
Knut's avatar
Knut committed
589

kbk's avatar
kbk committed
590
#ifndef NO_BAROCLINIC
kbk's avatar
kbk committed
591
   if(runtype .eq. 4) then        ! prognostic T and S
gotm's avatar
gotm committed
592 593
      if (calc_temp) call do_temperature(n)
      if (calc_salt) call do_salinity(n)
kbk's avatar
kbk committed
594 595 596 597

!     The following is a bit clumpsy and should be changed when do_bdy_3d()
!     operates on individual fields and not as is the case now - on both
!     T and S.
bjb's avatar
bjb committed
598
      call tic(TIM_INTEGR3D)
kbk's avatar
kbk committed
599 600
      if (bdy3d) call do_bdy_3d(0,T)
      if (calc_temp) then
601
         call tic(TIM_TEMPH)
602
         call update_3d_halo(T,T,az,imin,jmin,imax,jmax,kmax,D_TAG)
kbk's avatar
kbk committed
603
         call wait_halo(D_TAG)
604
         call toc(TIM_TEMPH)
kbk's avatar
kbk committed
605 606 607
         call mirror_bdy_3d(T,D_TAG)
      end if
      if (calc_salt) then
608
         call tic(TIM_SALTH)
609
         call update_3d_halo(S,S,az,imin,jmin,imax,jmax,kmax,D_TAG)
kbk's avatar
kbk committed
610
         call wait_halo(D_TAG)
611
         call toc(TIM_SALTH)
kbk's avatar
kbk committed
612 613
         call mirror_bdy_3d(S,D_TAG)
      end if
bjb's avatar
bjb committed
614
      call toc(TIM_INTEGR3D)
kbk's avatar
kbk committed
615

gotm's avatar
gotm committed
616 617 618 619
#ifndef PECS
      call do_eqstate()
#endif
   end if
kbk's avatar
kbk committed
620
#endif
gotm's avatar
gotm committed
621

622
#ifndef NO_BAROTROPIC
kbk's avatar
kbk committed
623
   if (kmax .gt. 1) then
gotm's avatar
gotm committed
624
#ifndef NO_BOTTFRIC
kbk's avatar
kbk committed
625
      call slow_bottom_friction()
gotm's avatar
gotm committed
626
#endif
627 628

      call tic(TIM_INTEGR3D)
Knut's avatar
Knut committed
629
      call uv_advect(Uint,Vint,Dn,Dveln,Dun,Dvn)
630 631 632
      call uv_diffusion(0,Uint,Vint,Dn,Dun,Dvn) ! Has to be called after uv_advect.
      call toc(TIM_INTEGR3D)

gotm's avatar
gotm committed
633
   end if
gotm's avatar
gotm committed
634

gotm's avatar
gotm committed
635
   call slow_terms()
636
#endif
bjb's avatar
bjb committed
637
   call tic(TIM_INTEGR3D)
gotm's avatar
gotm committed
638
   call stop_macro()
bjb's avatar
bjb committed
639
   call toc(TIM_INTEGR3D)
gotm's avatar
gotm committed
640 641 642 643 644 645 646 647 648 649 650 651

#ifdef DEBUG
     write(debug,*) 'Leaving integrate_3d()'
     write(debug,*)
#endif
   return
   end subroutine integrate_3d
!EOC

!-----------------------------------------------------------------------
!BOP
!
hb's avatar
hb committed
652
! !IROUTINE: clean_3d - cleanup after 3D run \label{sec-clean-3d}
gotm's avatar
gotm committed
653 654 655 656 657 658 659 660 661 662 663 664
!
! !INTERFACE:
   subroutine clean_3d()
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
!
! !INPUT/OUTPUT PARAMETERS:
!
! !OUTPUT PARAMETERS:
!
! !DESCRIPTION:
hb's avatar
hb committed
665 666
! Here, a call to the routine {\tt clean\_variables\_3d} which howewer
! does not do anything yet.
gotm's avatar
gotm committed
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
!
! !LOCAL VARIABLES:
!
!EOP
!-----------------------------------------------------------------------
!BOC
#ifdef DEBUG
   integer, save :: Ncall = 0
   Ncall = Ncall+1
   write(debug,*) 'clean_3d() # ',Ncall
#endif

   call clean_variables_3d()

#ifdef DEBUG
     write(debug,*) 'Leaving clean_3d()'
     write(debug,*)
#endif
   return
   end subroutine clean_3d
!EOC

!-----------------------------------------------------------------------

   end module m3d

!-----------------------------------------------------------------------
! Copyright (C) 2000 - Hans Burchard and Karsten Bolding (BBH)         !
!-----------------------------------------------------------------------