m3d.F90 21 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
Knut's avatar
Knut committed
56 57
   logical                             :: calc_temp=.false.
   logical                             :: calc_salt=.false.
kbk's avatar
kbk committed
58
   logical                             :: bdy3d=.false.
59
   integer                             :: bdyfmt_3d,bdy3d_ramp
kbk's avatar
kbk committed
60
   character(len=PATH_MAX)             :: bdyfile_3d
kbk's avatar
kbk committed
61
   REALTYPE                            :: ip_fac=_ONE_
62
   integer                             :: vel_check=0
63
   REALTYPE                            :: min_vel=-4*_ONE_,max_vel=4*_ONE_
gotm's avatar
gotm committed
64
!
kbk's avatar
kbk committed
65 66 67
! !REVISION HISTORY:
!  Original author(s): Karsten Bolding & Hans Burchard
!
gotm's avatar
gotm committed
68
! !LOCAL VARIABLES:
69
   logical         :: advect_turbulence=.false.
kbk's avatar
kbk committed
70 71 72
#ifdef NO_BAROCLINIC
   integer         :: ip_method
#endif
kbk's avatar
kbk committed
73
   integer         :: ip_ramp=-1
gotm's avatar
gotm committed
74 75 76 77 78 79 80 81
!EOP
!-----------------------------------------------------------------------

   contains

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

Knut's avatar
Knut committed
147 148
   LEVEL2 "splitting factor M: ",M

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

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

bjb's avatar
bjb committed
180
!  Sanity checks for bdy 3d
Knut's avatar
Knut committed
181
   if (.not.openbdy .or. runtype.eq.2) bdy3d=.false.
182 183 184 185 186 187 188 189 190 191 192 193 194 195
   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
196 197
   end if

kbk's avatar
kbk committed
198 199
   LEVEL2 'ip_ramp=',ip_ramp

200 201
   LEVEL2 'vel_check=',vel_check
   if (vel_check .ne. 0) then
kbk's avatar
kbk committed
202 203 204
      LEVEL3 'doing sanity checks on velocities'
      LEVEL3 'min_vel=',min_vel
      LEVEL3 'max_vel=',max_vel
205 206 207 208 209 210 211 212
      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
213
   dt = M*timestep
214 215 216 217 218

#ifdef CONSTANT_VISCOSITY
   num=avmback
   nuh=avhback
#else
219 220
   num=1.d-15
   nuh=1.d-15
221 222 223 224 225 226 227 228 229 230 231 232

#ifdef TURB_ADV
   if (.not. advect_turbulence) then
      LEVEL2 "reenabled advection of TKE and eps due to"
      LEVEL2 "obsolete TURB_ADV macro. Note that this"
      LEVEL2 "behaviour will be removed in the future!"
      advect_turbulence = .true.
   end if
#endif

   LEVEL2 "advect_turbulence = ",advect_turbulence

233
#endif
gotm's avatar
gotm committed
234 235

!  Needed for interpolation of temperature and salinity
kbk's avatar
kbk committed
236
   if (.not. hotstart) then
237
      ssen = z
gotm's avatar
gotm committed
238
      call start_macro()
239
      Dold = Dn
240
      call coordinates(hotstart)
241
      call hcc_check()
kbk's avatar
kbk committed
242
   end if
gotm's avatar
gotm committed
243

244 245 246 247
   if (runtype .eq. 2) then
      calc_temp = .false.
      calc_salt = .false.
   else
kbk's avatar
kbk committed
248
#ifndef NO_BAROCLINIC
gotm's avatar
gotm committed
249
      T = _ZERO_ ; S = _ZERO_ ; rho = _ZERO_
250 251
      if(calc_temp) call init_temperature()
      if(calc_salt) call init_salinity()
252
#endif
253
   end if
kbk's avatar
kbk committed
254

255
#ifndef NO_BAROCLINIC
kbk's avatar
kbk committed
256
    if (runtype .eq. 3 .or. runtype .eq. 4) then
257
      call init_eqstate()
gotm's avatar
gotm committed
258 259
#ifndef PECS
      call do_eqstate()
260
      call ss_nn()
gotm's avatar
gotm committed
261
#endif
262 263

      if (bdy3d) call init_bdy_3d()
264 265
      if (runtype .ge. 3) call init_internal_pressure()
      if (runtype .eq. 3) call do_internal_pressure()
gotm's avatar
gotm committed
266
   end if
267
#endif
268

269
   if (vert_cord .eq. _ADAPTIVE_COORDS_) call preadapt_coordinates(preadapt)
kb's avatar
kb committed
270

gotm's avatar
gotm committed
271 272 273 274 275 276 277 278
#ifdef DEBUG
   write(debug,*) 'Leaving init_3d()'
   write(debug,*)
#endif
   return
   end subroutine init_3d
!EOC

279 280 281 282 283 284
!-----------------------------------------------------------------------
!BOP
!
! !IROUTINE: postinit_3d - re-initialise some 3D after hotstart read.
!
! !INTERFACE:
285
   subroutine postinit_3d(runtype,timestep,hotstart)
286 287 288 289 290 291
! !USES:
   use domain, only: imin,imax,jmin,jmax, az,au,av
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
   integer, intent(in)                 :: runtype
292 293
   REALTYPE, intent(in)                :: timestep
   logical, intent(in)                 :: hotstart
294 295 296 297 298 299
!
! !INPUT/OUTPUT PARAMETERS:
!
! !OUTPUT PARAMETERS:
!
! !DESCRIPTION:
300 301
!  This routine provides possibility to reset/initialize 3D variables to
!  ensure that velocities are correctly set on land cells after read
302 303 304
!  of a hotstart file.
!
! !LOCAL VARIABLES:
305
   integer                   :: i,j,rc
306 307 308 309 310 311 312 313 314 315 316
!EOP
!-------------------------------------------------------------------------
!BOC
#ifdef DEBUG
   integer, save :: Ncall = 0
   Ncall = Ncall+1
   write(debug,*) 'postinit_3d() # ',Ncall
#endif

   LEVEL1 'postinit_3d'

317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
   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

358 359
! Hotstart fix - see postinit_2d
   if (hotstart) then
360

361 362 363 364 365 366
      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
367
      end do
368 369 370 371 372 373
      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
374
      end do
375 376 377 378 379 380 381 382 383 384 385 386 387
!     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
388
      end do
389

390
      call depth_update(sseo,ssen,Dold,Dn,Dun,Dvn,first=.true.,from3d=.true.)
391 392
      call coordinates(hotstart)

393
   end if
394 395 396 397 398

   return
   end subroutine postinit_3d
!EOC

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

541
#ifndef MUDFLAT
542 543 544 545
   if (kmax .gt. 1) then
      if (vert_cord .eq. _ADAPTIVE_COORDS_) call ss_nn()
   end if
   call coordinates(.false.)
546
#endif
Knut's avatar
Knut committed
547

gotm's avatar
gotm committed
548
   if (kmax .gt. 1) then
Knut's avatar
Knut committed
549

gotm's avatar
gotm committed
550
      call ww_momentum_3d()
551 552 553 554

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

555
#ifndef NO_BOTTFRIC
gotm's avatar
gotm committed
556
      call stresses_3d()
557 558
#endif
#ifndef CONSTANT_VISCOSITY
gotm's avatar
gotm committed
559
#ifndef PARABOLIC_VISCOSITY
560
      if (vert_cord .ne. _ADAPTIVE_COORDS_) call ss_nn()
gotm's avatar
gotm committed
561 562
#endif
      call gotm()
563
      if (advect_turbulence) call tke_eps_advect_3d()
gotm's avatar
gotm committed
564
#endif
Knut's avatar
Knut committed
565

566
   end if
Knut's avatar
Knut committed
567

kbk's avatar
kbk committed
568
#ifndef NO_BAROCLINIC
kbk's avatar
kbk committed
569
   if(runtype .eq. 4) then        ! prognostic T and S
gotm's avatar
gotm committed
570 571
      if (calc_temp) call do_temperature(n)
      if (calc_salt) call do_salinity(n)
kbk's avatar
kbk committed
572 573 574 575

!     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
576
      call tic(TIM_INTEGR3D)
kbk's avatar
kbk committed
577 578
      if (bdy3d) call do_bdy_3d(0,T)
      if (calc_temp) then
579
         call tic(TIM_TEMPH)
580
         call update_3d_halo(T,T,az,imin,jmin,imax,jmax,kmax,D_TAG)
kbk's avatar
kbk committed
581
         call wait_halo(D_TAG)
582
         call toc(TIM_TEMPH)
kbk's avatar
kbk committed
583 584 585
         call mirror_bdy_3d(T,D_TAG)
      end if
      if (calc_salt) then
586
         call tic(TIM_SALTH)
587
         call update_3d_halo(S,S,az,imin,jmin,imax,jmax,kmax,D_TAG)
kbk's avatar
kbk committed
588
         call wait_halo(D_TAG)
589
         call toc(TIM_SALTH)
kbk's avatar
kbk committed
590 591
         call mirror_bdy_3d(S,D_TAG)
      end if
bjb's avatar
bjb committed
592
      call toc(TIM_INTEGR3D)
kbk's avatar
kbk committed
593

gotm's avatar
gotm committed
594 595 596 597
#ifndef PECS
      call do_eqstate()
#endif
   end if
kbk's avatar
kbk committed
598
#endif
gotm's avatar
gotm committed
599

600
#ifndef NO_BAROTROPIC
kbk's avatar
kbk committed
601
   if (kmax .gt. 1) then
gotm's avatar
gotm committed
602
#ifndef NO_BOTTFRIC
kbk's avatar
kbk committed
603
      call slow_bottom_friction()
gotm's avatar
gotm committed
604
#endif
605 606

      call tic(TIM_INTEGR3D)
607
      call uv_advect(Uint,Vint,Dold,Dn,Dun,Dvn)
608 609 610
      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
611
   end if
gotm's avatar
gotm committed
612

gotm's avatar
gotm committed
613
   call slow_terms()
614
#endif
bjb's avatar
bjb committed
615
   call tic(TIM_INTEGR3D)
gotm's avatar
gotm committed
616
   call stop_macro()
bjb's avatar
bjb committed
617
   call toc(TIM_INTEGR3D)
gotm's avatar
gotm committed
618 619 620 621 622 623 624 625 626 627 628 629

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

!-----------------------------------------------------------------------
!BOP
!
hb's avatar
hb committed
630
! !IROUTINE: clean_3d - cleanup after 3D run \label{sec-clean-3d}
gotm's avatar
gotm committed
631 632 633 634 635 636 637 638 639 640 641 642
!
! !INTERFACE:
   subroutine clean_3d()
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
!
! !INPUT/OUTPUT PARAMETERS:
!
! !OUTPUT PARAMETERS:
!
! !DESCRIPTION:
hb's avatar
hb committed
643 644
! Here, a call to the routine {\tt clean\_variables\_3d} which howewer
! does not do anything yet.
gotm's avatar
gotm committed
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
!
! !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)         !
!-----------------------------------------------------------------------