m3d.F90 20.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
kbk's avatar
kbk committed
29
   use m2d, only: Am
kbk's avatar
kbk committed
30
   use variables_2d, only: D,z,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
gotm's avatar
gotm committed
40
   use advection_3d, only: init_advection_3d
kbk's avatar
kbk committed
41
   use bdy_3d, only: init_bdy_3d, do_bdy_3d
42
   use bdy_3d, only: bdy3d_tmrlx, bdy3d_tmrlx_ucut, bdy3d_tmrlx_max, bdy3d_tmrlx_min
43
!  Necessary to use halo_zones because update_3d_halos() have been moved out
kbk's avatar
kbk committed
44 45
!  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
46

gotm's avatar
gotm committed
47 48 49
   IMPLICIT NONE
!
! !PUBLIC DATA MEMBERS:
kbk's avatar
kbk committed
50
   integer                             :: M=1
51
   REALTYPE                            :: cord_relax=_ZERO_
kbk's avatar
kbk committed
52 53 54 55 56
   logical                             :: calc_temp=.true.
   logical                             :: calc_salt=.true.
   logical                             :: bdy3d=.false.
   integer                             :: bdyfmt_3d,bdyramp_3d
   character(len=PATH_MAX)             :: bdyfile_3d
kbk's avatar
kbk committed
57
   REALTYPE                            :: ip_fac=_ONE_
58
   integer                             :: vel_check=0
59
   REALTYPE                            :: min_vel=-4*_ONE_,max_vel=4*_ONE_
gotm's avatar
gotm committed
60
!
kbk's avatar
kbk committed
61 62 63
! !REVISION HISTORY:
!  Original author(s): Karsten Bolding & Hans Burchard
!
gotm's avatar
gotm committed
64
! !LOCAL VARIABLES:
65
   integer         :: vel_hor_adv=1,vel_ver_adv=1,vel_adv_split=0
kbk's avatar
kbk committed
66 67 68
#ifdef NO_BAROCLINIC
   integer         :: ip_method
#endif
kbk's avatar
kbk committed
69
   integer         :: ip_ramp=-1
gotm's avatar
gotm committed
70 71 72 73 74 75 76 77
!EOP
!-----------------------------------------------------------------------

   contains

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

137 138 139 140 141 142 143 144 145
   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
146 147 148
! Allocates memory for the public data members - if not static
   call init_variables_3d(runtype)

149 150 151 152 153
!  Sanity checks for advection specifications
   LEVEL2 'vel_hor_adv=   ',vel_hor_adv
   LEVEL2 'vel_ver_adv=   ',vel_ver_adv
   LEVEL2 'vel_adv_split= ',vel_adv_split
   if(vel_hor_adv .gt. 1) then
gotm's avatar
gotm committed
154 155 156
#ifndef UV_TVD
      STDERR 'To run the model with higher order advection for momentum'
      STDERR 'you need to re-compile the model with the option -DUV_TVD.'
157
      call getm_error("init_3d()","GETM needs recompilation")
gotm's avatar
gotm committed
158
#endif
159 160 161 162 163 164
   else
      vel_adv_split=-1
      if(vel_ver_adv .ne. 1) then
         LEVEL2 "setting vel_ver_adv to 1 - since vel_hor_adv is 1"
         vel_ver_adv=1
      end if
gotm's avatar
gotm committed
165
   end if
166 167 168 169 170 171 172 173 174 175 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 209 210 211 212 213 214 215
   LEVEL2 "horizontal: ",trim(adv_schemes(vel_hor_adv))," of momentum"
   LEVEL2 "vertical:   ",trim(adv_schemes(vel_ver_adv))," of momentum"

   select case (vel_adv_split)
      case (-1)
      case (0)
         select case (vel_hor_adv)
            case (2,3,4,5,6)
            case default
               call getm_error("init_3d()", &
                    "vel_adv_split=0: vel_hor_adv not valid (2-6)")
         end select
         select case (vel_ver_adv)
            case (2,3,4,5,6)
            case default
               call getm_error("init_3d()", &
                    "vel_adv_split=0: vel_ver_adv not valid (2-6)")
         end select
         LEVEL2 "1D split --> full u, full v, full w"
      case (1)
         select case (vel_hor_adv)
            case (2,3,4,5,6)
            case default
               call getm_error("init_3d()", &
                    "vel_adv_split=1: vel_hor_adv not valid (2-6)")
         end select
         select case (vel_ver_adv)
            case (2,3,4,5,6)
            case default
               call getm_error("init_3d()", &
                    "vel_adv_split=1: vel_ver_adv not valid (2-6)")
         end select
         LEVEL2 "1D split --> half u, half v, full w, half v, half u"
      case (2)
         select case (vel_hor_adv)
            case (2,7)
            case default
               call getm_error("init_3d()", &
                    "vel_adv_split=2: vel_hor_adv not valid (2,7)")
         end select
         select case (vel_ver_adv)
            case (2,3,4,5,6)
            case default
               call getm_error("init_3d()", &
                    "vel_adv_split=2: vel_ver_adv not valid (2-6)")
         end select
         LEVEL2 "2D-hor, 1D-vert split --> full uv, full w"
      case default
   end select

bjb's avatar
bjb committed
216
!  Sanity checks for bdy 3d
Knut's avatar
Knut committed
217
   if (.not.openbdy .or. runtype.eq.2) bdy3d=.false.
218 219 220 221 222 223 224 225 226 227 228 229 230 231
   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
232 233
   end if

kbk's avatar
kbk committed
234 235
   LEVEL2 'ip_ramp=',ip_ramp

236 237
   LEVEL2 'vel_check=',vel_check
   if (vel_check .ne. 0) then
kbk's avatar
kbk committed
238 239 240
      LEVEL3 'doing sanity checks on velocities'
      LEVEL3 'min_vel=',min_vel
      LEVEL3 'max_vel=',max_vel
241 242 243 244 245 246 247 248
      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
249
   dt = M*timestep
250 251 252 253 254

#ifdef CONSTANT_VISCOSITY
   num=avmback
   nuh=avhback
#else
255 256
   num=1.d-15
   nuh=1.d-15
257
#endif
gotm's avatar
gotm committed
258 259

!  Needed for interpolation of temperature and salinity
kbk's avatar
kbk committed
260
   if (.not. hotstart) then
gotm's avatar
gotm committed
261
      call start_macro()
262
      call coordinates(hotstart)
263
      call hcc_check()
kbk's avatar
kbk committed
264
   end if
gotm's avatar
gotm committed
265

kbk's avatar
kbk committed
266
#ifndef NO_BAROCLINIC
gotm's avatar
gotm committed
267
   if (runtype .eq. 3 .or. runtype .eq. 4) then
gotm's avatar
gotm committed
268
      T = _ZERO_ ; S = _ZERO_ ; rho = _ZERO_
gotm's avatar
gotm committed
269 270
      if(calc_temp) call init_temperature(1)
      if(calc_salt) call init_salinity(1)
kbk's avatar
kbk committed
271
   end if
272
#endif
kbk's avatar
kbk committed
273

274 275
    call init_advection_3d(2)

276
#ifndef NO_BAROCLINIC
kbk's avatar
kbk committed
277
    if (runtype .eq. 3 .or. runtype .eq. 4) then
278
      call init_eqstate()
gotm's avatar
gotm committed
279 280
#ifndef PECS
      call do_eqstate()
281
      call ss_nn()
gotm's avatar
gotm committed
282
#endif
283 284

      if (bdy3d) call init_bdy_3d()
285 286
      if (runtype .ge. 3) call init_internal_pressure()
      if (runtype .eq. 3) call do_internal_pressure()
gotm's avatar
gotm committed
287
   end if
288
#endif
289

290
   if (vert_cord .eq. _ADAPTIVE_COORDS_) call preadapt_coordinates(preadapt)
kb's avatar
kb committed
291

gotm's avatar
gotm committed
292 293 294 295 296 297 298 299
#ifdef DEBUG
   write(debug,*) 'Leaving init_3d()'
   write(debug,*)
#endif
   return
   end subroutine init_3d
!EOC

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

   LEVEL1 'postinit_3d'

338 339 340 341 342 343 344 345
! Hotstart fix - see postinit_2d
   if (hotstart) then
      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
346
      end do
347 348 349 350 351 352
      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
353
      end do
354 355 356 357 358 359 360 361 362 363 364 365 366
!     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
367
      end do
368
   end if
369 370 371 372 373

   return
   end subroutine postinit_3d
!EOC

gotm's avatar
gotm committed
374 375 376
!-----------------------------------------------------------------------
!BOP
!
hb's avatar
hb committed
377 378
! !IROUTINE: integrate_3d - calls to do 3D model integration
! \label{sec-integrate-3d}
gotm's avatar
gotm committed
379 380 381
!
! !INTERFACE:
   subroutine integrate_3d(runtype,n)
bjb's avatar
bjb committed
382
   use getm_timers, only: tic, toc, TIM_INTEGR3D
383 384 385
#ifndef NO_BAROCLINIC
   use getm_timers, only: TIM_TEMPH, TIM_SALTH
#endif
gotm's avatar
gotm committed
386 387 388
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
kbk's avatar
kbk committed
389
   integer, intent(in)                 :: runtype,n
gotm's avatar
gotm committed
390 391 392 393 394 395
!
! !INPUT/OUTPUT PARAMETERS:
!
! !OUTPUT PARAMETERS:
!
! !DESCRIPTION:
hb's avatar
hb committed
396
! This is a wrapper routine to call all 3D related subroutines.
397 398 399
! 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
400 401
! 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
402
! Lagrangian component which are currently under development are supported.
hb's avatar
hb committed
403 404 405 406 407
! Both, drying and flooding and
! Lagrangian coordinates does not go together yet.
! The call sequence is as follows:
!
! \vspace{0.5cm}
408
!
hb's avatar
hb committed
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
! \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} \\
444
! {\tt do\_spm}                & suspended matter equation & see page
hb's avatar
hb committed
445 446 447 448 449 450 451 452 453 454 455 456 457
! \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}
458
!
hb's avatar
hb committed
459 460 461 462 463 464
! \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
465 466
!
! !LOCAL VARIABLES:
kbk's avatar
kbk committed
467
  logical, save              :: ufirst=.true.
gotm's avatar
gotm committed
468 469 470 471 472 473 474 475 476 477
!
!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
478 479
#ifndef NO_BAROCLINIC
#endif
480
#ifdef MUDFLAT
481
   call coordinates(.false.)
482
#endif
gotm's avatar
gotm committed
483
#ifndef NO_BOTTFRIC
kbk's avatar
kbk committed
484
   if (kmax .gt. 1) then
gotm's avatar
gotm committed
485 486 487
      call bottom_friction_3d()
   end if
#endif
bjb's avatar
bjb committed
488
   call tic(TIM_INTEGR3D)
gotm's avatar
gotm committed
489
   SS = _ZERO_
bjb's avatar
bjb committed
490
   call toc(TIM_INTEGR3D)
kbk's avatar
kbk committed
491
#ifndef NO_BAROCLINIC
bjb's avatar
bjb committed
492
   call tic(TIM_INTEGR3D)
gotm's avatar
gotm committed
493
   NN = _ZERO_
bjb's avatar
bjb committed
494
   call toc(TIM_INTEGR3D)
495
   if (runtype .eq. 4) call do_internal_pressure()
kbk's avatar
kbk committed
496
#endif
bjb's avatar
bjb committed
497
   call tic(TIM_INTEGR3D)
498 499
   huo=hun
   hvo=hvn
kbk's avatar
kbk committed
500
   ip_fac=_ONE_
frv-bjb's avatar
frv-bjb committed
501
   if (ip_ramp .gt. 0) ip_fac=min( _ONE_ , n*_ONE_/ip_ramp)
bjb's avatar
bjb committed
502
   call toc(TIM_INTEGR3D)
503 504 505
#ifdef STRUCTURE_FRICTION
   call structure_friction_3d
#endif
gotm's avatar
gotm committed
506
   if (ufirst) then
507 508
      call uu_momentum_3d(n,bdy3d)
      call vv_momentum_3d(n,bdy3d)
gotm's avatar
gotm committed
509 510
      ufirst=.false.
   else
511 512
      call vv_momentum_3d(n,bdy3d)
      call uu_momentum_3d(n,bdy3d)
gotm's avatar
gotm committed
513 514
      ufirst=.true.
   end if
515

516
#ifndef MUDFLAT
517 518 519 520
   if (kmax .gt. 1) then
      if (vert_cord .eq. _ADAPTIVE_COORDS_) call ss_nn()
   end if
   call coordinates(.false.)
521
#endif
gotm's avatar
gotm committed
522 523 524 525
   if (kmax .gt. 1) then
      call ww_momentum_3d()
   end if
#ifndef NO_ADVECT
kbk's avatar
kbk committed
526
   if (kmax .gt. 1) then
527
      call uv_advect_3d(vel_hor_adv,vel_ver_adv,vel_adv_split)
gotm's avatar
gotm committed
528 529 530 531 532 533 534
      if (Am .gt. _ZERO_) then
         call uv_diffusion_3d(Am)  ! Must be called after uv_advect_3d
      end if
   end if
#else
   STDERR 'NO_ADVECT 3D'
#endif
kbk's avatar
kbk committed
535
   if (kmax .gt. 1) then
536
#ifndef NO_BOTTFRIC
gotm's avatar
gotm committed
537
      call stresses_3d()
538 539
#endif
#ifndef CONSTANT_VISCOSITY
gotm's avatar
gotm committed
540
#ifndef PARABOLIC_VISCOSITY
541
      if (vert_cord .ne. _ADAPTIVE_COORDS_) call ss_nn()
gotm's avatar
gotm committed
542 543
#endif
      call gotm()
hb's avatar
hb committed
544 545 546
#ifdef TURB_ADV
      call tke_eps_advect_3d(vel_hor_adv,vel_ver_adv,vel_adv_split)
#endif
gotm's avatar
gotm committed
547
#endif
548
   end if
kbk's avatar
kbk committed
549
#ifndef NO_BAROCLINIC
kbk's avatar
kbk committed
550
   if(runtype .eq. 4) then        ! prognostic T and S
gotm's avatar
gotm committed
551 552
      if (calc_temp) call do_temperature(n)
      if (calc_salt) call do_salinity(n)
kbk's avatar
kbk committed
553 554 555 556

!     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
557
      call tic(TIM_INTEGR3D)
kbk's avatar
kbk committed
558 559
      if (bdy3d) call do_bdy_3d(0,T)
      if (calc_temp) then
560
         call tic(TIM_TEMPH)
561
         call update_3d_halo(T,T,az,imin,jmin,imax,jmax,kmax,D_TAG)
kbk's avatar
kbk committed
562
         call wait_halo(D_TAG)
563
         call toc(TIM_TEMPH)
kbk's avatar
kbk committed
564 565 566
         call mirror_bdy_3d(T,D_TAG)
      end if
      if (calc_salt) then
567
         call tic(TIM_SALTH)
568
         call update_3d_halo(S,S,az,imin,jmin,imax,jmax,kmax,D_TAG)
kbk's avatar
kbk committed
569
         call wait_halo(D_TAG)
570
         call toc(TIM_SALTH)
kbk's avatar
kbk committed
571 572
         call mirror_bdy_3d(S,D_TAG)
      end if
bjb's avatar
bjb committed
573
      call toc(TIM_INTEGR3D)
kbk's avatar
kbk committed
574

gotm's avatar
gotm committed
575 576 577 578
#ifndef PECS
      call do_eqstate()
#endif
   end if
kbk's avatar
kbk committed
579
#endif
gotm's avatar
gotm committed
580

581
   call tic(TIM_INTEGR3D)
kbk's avatar
kbk committed
582
   UEx=_ZERO_ ; VEx=_ZERO_
583
   call toc(TIM_INTEGR3D)
584
#ifndef NO_BAROTROPIC
kbk's avatar
kbk committed
585
   if (kmax .gt. 1) then
gotm's avatar
gotm committed
586
#ifndef NO_BOTTFRIC
kbk's avatar
kbk committed
587
      call slow_bottom_friction()
gotm's avatar
gotm committed
588 589 590
#endif
#ifndef NO_ADVECT
#ifndef UV_ADV_DIRECT
kbk's avatar
kbk committed
591 592 593 594
      call slow_advection()
      if (Am .gt. _ZERO_) then
         call slow_diffusion(Am) ! Has to be called after slow_advection.
      end if
gotm's avatar
gotm committed
595 596 597
#endif
#endif
   end if
gotm's avatar
gotm committed
598

gotm's avatar
gotm committed
599
   call slow_terms()
600
#endif
bjb's avatar
bjb committed
601
   call tic(TIM_INTEGR3D)
gotm's avatar
gotm committed
602
   call stop_macro()
bjb's avatar
bjb committed
603
   call toc(TIM_INTEGR3D)
gotm's avatar
gotm committed
604 605 606 607 608 609 610 611 612 613 614 615

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

!-----------------------------------------------------------------------
!BOP
!
hb's avatar
hb committed
616
! !IROUTINE: clean_3d - cleanup after 3D run \label{sec-clean-3d}
gotm's avatar
gotm committed
617 618 619 620 621 622 623 624 625 626 627 628
!
! !INTERFACE:
   subroutine clean_3d()
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
!
! !INPUT/OUTPUT PARAMETERS:
!
! !OUTPUT PARAMETERS:
!
! !DESCRIPTION:
hb's avatar
hb committed
629 630
! Here, a call to the routine {\tt clean\_variables\_3d} which howewer
! does not do anything yet.
gotm's avatar
gotm committed
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
!
! !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)         !
!-----------------------------------------------------------------------