m3d.F90 21.3 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 30
   use m2d, only: uv_advect,uv_diffusion
   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
kbk's avatar
kbk committed
59 60 61
   logical                             :: calc_temp=.true.
   logical                             :: calc_salt=.true.
   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:
72
   logical         :: advect_turbulence=.false.
kbk's avatar
kbk committed
73 74 75
#ifdef NO_BAROCLINIC
   integer         :: ip_method
#endif
kbk's avatar
kbk committed
76
   integer         :: ip_ramp=-1
gotm's avatar
gotm committed
77 78 79 80 81 82 83 84
!EOP
!-----------------------------------------------------------------------

   contains

!-----------------------------------------------------------------------
!BOP
!
hb's avatar
hb committed
85
! !IROUTINE: init_3d - initialise 3D related stuff \label{sec-init-3d}
gotm's avatar
gotm committed
86 87
!
! !INTERFACE:
88
   subroutine init_3d(runtype,timestep,hotstart)
89
!
gotm's avatar
gotm committed
90 91 92
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
kbk's avatar
kbk committed
93 94 95
   integer, intent(in)                 :: runtype
   REALTYPE, intent(in)                :: timestep
   logical, intent(in)                 :: hotstart
gotm's avatar
gotm committed
96 97
!
! !DESCRIPTION:
hb's avatar
hb committed
98 99 100 101 102 103
!  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}
104
!  has to be set. Here, the macro time step $\Delta t$ is calculated
hb's avatar
hb committed
105 106 107
!  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,
108 109
!  in order to enable proper interpolation of initial values for
!  potential temperature $\theta$ and salinity $S$ for cold starts.
hb's avatar
hb committed
110 111 112 113 114 115
!  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
116 117
!
! !LOCAL VARIABLES:
118
   integer         :: rc
kbk's avatar
kbk committed
119
   NAMELIST /m3d/ &
120
             M,cnpar,cord_relax,adv_ver_iterations,       &
121
             bdy3d,bdyfmt_3d,bdy3d_ramp,bdyfile_3d,       &
122 123 124
             bdy3d_tmrlx,bdy3d_tmrlx_ucut,                &
             bdy3d_tmrlx_max,bdy3d_tmrlx_min,             &
             vel3d_adv_split,vel3d_adv_hor,vel3d_adv_ver, &
125
             turb_adv_split,turb_adv_hor,turb_adv_ver,    &
126
             calc_temp,calc_salt,                         &
127
             avmback,avhback,                             &
128
             ip_method,ip_ramp,                           &
129
             vel_check,min_vel,max_vel
gotm's avatar
gotm committed
130 131 132 133 134 135 136 137 138 139 140 141 142 143
!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
144 145
   LEVEL2 "splitting factor M: ",M

146 147 148 149 150 151 152 153 154
   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
155
! Allocates memory for the public data members - if not static
156
   call init_variables_3d(runtype)
157
   call init_advection_3d()
gotm's avatar
gotm committed
158

159
!  Sanity checks for advection specifications
160 161 162 163 164 165 166 167 168 169 170 171 172
   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
173
   end if
174 175
#endif
   call print_adv_settings_3d(vel3d_adv_split,vel3d_adv_hor,vel3d_adv_ver,_ZERO_)
176

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

#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
209
!  Sanity checks for bdy 3d
Knut's avatar
Knut committed
210
   if (.not.openbdy .or. runtype.eq.2) bdy3d=.false.
211 212 213 214 215 216 217 218
   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]")
219
      if (bdy3d_tmrlx_max<bdy3d_tmrlx_min .or. bdy3d_tmrlx_max>_ONE_) &
220
           call getm_error("init_3d()",                               &
221
           "bdy3d_tmrlx_max is out of valid range [bdy3d_tmrlx_min:1]")
222 223 224
      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
225 226
   end if

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

229 230
   LEVEL2 'vel_check=',vel_check
   if (vel_check .ne. 0) then
kbk's avatar
kbk committed
231 232 233
      LEVEL3 'doing sanity checks on velocities'
      LEVEL3 'min_vel=',min_vel
      LEVEL3 'max_vel=',max_vel
234 235 236 237 238 239 240 241
      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
242
   dt = M*timestep
243 244 245 246 247

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

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

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

271
#ifndef NO_BAROCLINIC
kbk's avatar
kbk committed
272
    if (runtype .eq. 3 .or. runtype .eq. 4) then
273
      call init_eqstate()
gotm's avatar
gotm committed
274
#ifndef PECS
275
!     KK-TODO: in case of hotstart no layer heights are available at this point
gotm's avatar
gotm committed
276
      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:
302
   subroutine postinit_3d(runtype,timestep,hotstart)
303 304 305 306 307 308
! !USES:
   use domain, only: imin,imax,jmin,jmax, az,au,av
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
   integer, intent(in)                 :: runtype
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'

334 335 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
   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

375 376
! Hotstart fix - see postinit_2d
   if (hotstart) then
377

378 379 380 381 382 383
      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
384
      end do
385 386 387 388 389 390
      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
391
      end do
392 393 394 395 396 397 398 399
!     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
400 401
               S(i,j,:)   = -9999.0
               T(i,j,:)   = -9999.0
402 403 404
#endif
            end if
         end do
405
      end do
406 407 408

      call coordinates(hotstart)

409
   end if
410 411 412 413 414

   return
   end subroutine postinit_3d
!EOC

gotm's avatar
gotm committed
415 416 417
!-----------------------------------------------------------------------
!BOP
!
hb's avatar
hb committed
418 419
! !IROUTINE: integrate_3d - calls to do 3D model integration
! \label{sec-integrate-3d}
gotm's avatar
gotm committed
420 421 422
!
! !INTERFACE:
   subroutine integrate_3d(runtype,n)
bjb's avatar
bjb committed
423
   use getm_timers, only: tic, toc, TIM_INTEGR3D
424 425 426
#ifndef NO_BAROCLINIC
   use getm_timers, only: TIM_TEMPH, TIM_SALTH
#endif
gotm's avatar
gotm committed
427 428 429
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
kbk's avatar
kbk committed
430
   integer, intent(in)                 :: runtype,n
gotm's avatar
gotm committed
431 432 433 434 435 436
!
! !INPUT/OUTPUT PARAMETERS:
!
! !OUTPUT PARAMETERS:
!
! !DESCRIPTION:
hb's avatar
hb committed
437
! This is a wrapper routine to call all 3D related subroutines.
438 439 440
! 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
441 442
! 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
443
! Lagrangian component which are currently under development are supported.
hb's avatar
hb committed
444 445 446 447 448
! Both, drying and flooding and
! Lagrangian coordinates does not go together yet.
! The call sequence is as follows:
!
! \vspace{0.5cm}
449
!
hb's avatar
hb committed
450 451 452 453 454 455 456 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
! \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} \\
485
! {\tt do\_spm}                & suspended matter equation & see page
hb's avatar
hb committed
486 487 488 489 490 491 492 493 494
! \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\_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}
495
!
hb's avatar
hb committed
496 497 498 499 500 501
! \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
502 503
!
! !LOCAL VARIABLES:
kbk's avatar
kbk committed
504
  logical, save              :: ufirst=.true.
gotm's avatar
gotm committed
505 506 507 508 509 510 511 512 513 514
!
!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
515 516
#ifndef NO_BAROCLINIC
#endif
517
#ifdef MUDFLAT
518
   call coordinates(.false.)
519
#endif
gotm's avatar
gotm committed
520
#ifndef NO_BOTTFRIC
kbk's avatar
kbk committed
521
   if (kmax .gt. 1) then
gotm's avatar
gotm committed
522 523 524
      call bottom_friction_3d()
   end if
#endif
bjb's avatar
bjb committed
525
   call tic(TIM_INTEGR3D)
gotm's avatar
gotm committed
526
   SS = _ZERO_
bjb's avatar
bjb committed
527
   call toc(TIM_INTEGR3D)
kbk's avatar
kbk committed
528
#ifndef NO_BAROCLINIC
bjb's avatar
bjb committed
529
   call tic(TIM_INTEGR3D)
gotm's avatar
gotm committed
530
   NN = _ZERO_
bjb's avatar
bjb committed
531
   call toc(TIM_INTEGR3D)
532
   if (runtype .eq. 4) call do_internal_pressure()
kbk's avatar
kbk committed
533
#endif
bjb's avatar
bjb committed
534
   call tic(TIM_INTEGR3D)
535 536
   huo=hun
   hvo=hvn
kbk's avatar
kbk committed
537
   ip_fac=_ONE_
frv-bjb's avatar
frv-bjb committed
538
   if (ip_ramp .gt. 0) ip_fac=min( _ONE_ , n*_ONE_/ip_ramp)
bjb's avatar
bjb committed
539
   call toc(TIM_INTEGR3D)
540 541 542
#ifdef STRUCTURE_FRICTION
   call structure_friction_3d
#endif
gotm's avatar
gotm committed
543
   if (ufirst) then
544 545
      call uu_momentum_3d(n,bdy3d)
      call vv_momentum_3d(n,bdy3d)
gotm's avatar
gotm committed
546 547
      ufirst=.false.
   else
548 549
      call vv_momentum_3d(n,bdy3d)
      call uu_momentum_3d(n,bdy3d)
gotm's avatar
gotm committed
550 551
      ufirst=.true.
   end if
552

553
#ifndef MUDFLAT
554 555 556 557
   if (kmax .gt. 1) then
      if (vert_cord .eq. _ADAPTIVE_COORDS_) call ss_nn()
   end if
   call coordinates(.false.)
558
#endif
Knut's avatar
Knut committed
559

gotm's avatar
gotm committed
560
   if (kmax .gt. 1) then
Knut's avatar
Knut committed
561

gotm's avatar
gotm committed
562
      call ww_momentum_3d()
563 564 565 566

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

567
#ifndef NO_BOTTFRIC
gotm's avatar
gotm committed
568
      call stresses_3d()
569 570
#endif
#ifndef CONSTANT_VISCOSITY
gotm's avatar
gotm committed
571
#ifndef PARABOLIC_VISCOSITY
572
      if (vert_cord .ne. _ADAPTIVE_COORDS_) call ss_nn()
gotm's avatar
gotm committed
573 574
#endif
      call gotm()
575
      if (advect_turbulence) call tke_eps_advect_3d()
gotm's avatar
gotm committed
576
#endif
Knut's avatar
Knut committed
577

578
   end if
Knut's avatar
Knut committed
579

kbk's avatar
kbk committed
580
#ifndef NO_BAROCLINIC
kbk's avatar
kbk committed
581
   if(runtype .eq. 4) then        ! prognostic T and S
gotm's avatar
gotm committed
582 583
      if (calc_temp) call do_temperature(n)
      if (calc_salt) call do_salinity(n)
kbk's avatar
kbk committed
584 585 586 587

!     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
588
      call tic(TIM_INTEGR3D)
kbk's avatar
kbk committed
589 590
      if (bdy3d) call do_bdy_3d(0,T)
      if (calc_temp) then
591
         call tic(TIM_TEMPH)
592
         call update_3d_halo(T,T,az,imin,jmin,imax,jmax,kmax,D_TAG)
kbk's avatar
kbk committed
593
         call wait_halo(D_TAG)
594
         call toc(TIM_TEMPH)
kbk's avatar
kbk committed
595 596 597
         call mirror_bdy_3d(T,D_TAG)
      end if
      if (calc_salt) then
598
         call tic(TIM_SALTH)
599
         call update_3d_halo(S,S,az,imin,jmin,imax,jmax,kmax,D_TAG)
kbk's avatar
kbk committed
600
         call wait_halo(D_TAG)
601
         call toc(TIM_SALTH)
kbk's avatar
kbk committed
602 603
         call mirror_bdy_3d(S,D_TAG)
      end if
bjb's avatar
bjb committed
604
      call toc(TIM_INTEGR3D)
kbk's avatar
kbk committed
605

gotm's avatar
gotm committed
606 607 608 609
#ifndef PECS
      call do_eqstate()
#endif
   end if
kbk's avatar
kbk committed
610
#endif
gotm's avatar
gotm committed
611

612
#ifndef NO_BAROTROPIC
kbk's avatar
kbk committed
613
   if (kmax .gt. 1) then
gotm's avatar
gotm committed
614
#ifndef NO_BOTTFRIC
kbk's avatar
kbk committed
615
      call slow_bottom_friction()
gotm's avatar
gotm committed
616
#endif
617 618 619 620 621 622

      call tic(TIM_INTEGR3D)
      call uv_advect(Uint,Vint,Dun,Dvn)
      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
623
   end if
gotm's avatar
gotm committed
624

gotm's avatar
gotm committed
625
   call slow_terms()
626
#endif
bjb's avatar
bjb committed
627
   call tic(TIM_INTEGR3D)
gotm's avatar
gotm committed
628
   call stop_macro()
bjb's avatar
bjb committed
629
   call toc(TIM_INTEGR3D)
gotm's avatar
gotm committed
630 631 632 633 634 635 636 637 638 639 640 641

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

!-----------------------------------------------------------------------
!BOP
!
hb's avatar
hb committed
642
! !IROUTINE: clean_3d - cleanup after 3D run \label{sec-clean-3d}
gotm's avatar
gotm committed
643 644 645 646 647 648 649 650 651 652 653 654
!
! !INTERFACE:
   subroutine clean_3d()
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
!
! !INPUT/OUTPUT PARAMETERS:
!
! !OUTPUT PARAMETERS:
!
! !DESCRIPTION:
hb's avatar
hb committed
655 656
! Here, a call to the routine {\tt clean\_variables\_3d} which howewer
! does not do anything yet.
gotm's avatar
gotm committed
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
!
! !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)         !
!-----------------------------------------------------------------------