m3d.F90 14 KB
Newer Older
1
!$Id: m3d.F90,v 1.14 2004-04-06 12:42:50 kbk Exp $
gotm's avatar
gotm committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
#include "cppdefs.h"
!-----------------------------------------------------------------------
!BOP
!
! !MODULE: m3d - 3D model component
!
! !INTERFACE:
   module m3d
!
! !DESCRIPTION:
!  This modules contains declarations for all variables related to 3D
!  hydrodynamical calculations. Information about the calculation domain
!  is included from the \emph{domain.F90} module.
!  The module contains public subroutines for initialisation, integration
!  and clean up of the 3D model component.
!  The actual calculation routines are called in integrate\_3d and is linked
!  in from the library lib3d.a.
!
! !USES:
   use parameters, only: avmmol
kbk's avatar
kbk committed
22
   use domain, only: maxdepth,vert_cord
kbk's avatar
kbk committed
23
   use m2d, only: Am
kbk's avatar
kbk committed
24
   use variables_2d, only: D,z,UEx,VEx
kbk's avatar
kbk committed
25
#ifndef NO_BAROCLINIC
gotm's avatar
gotm committed
26 27
   use temperature,only: init_temperature, do_temperature
   use salinity,   only: init_salinity, do_salinity
kbk's avatar
kbk committed
28
   use eqstate,    only: init_eqstate, do_eqstate
29 30
   use internal_pressure, only: init_internal_pressure, do_internal_pressure
   use internal_pressure, only: ip_method
kbk's avatar
kbk committed
31
#endif
32
#ifndef NO_SUSP_MATTER
kbk's avatar
kbk committed
33
   use suspended_matter, only: init_spm, do_spm
kbk's avatar
kbk committed
34
#endif
35
   use variables_3d
gotm's avatar
gotm committed
36
   use advection_3d, only: init_advection_3d
kbk's avatar
kbk committed
37
   use bdy_3d, only: init_bdy_3d, do_bdy_3d
kbk's avatar
kbk committed
38

gotm's avatar
gotm committed
39 40 41
   IMPLICIT NONE
!
! !PUBLIC DATA MEMBERS:
kbk's avatar
kbk committed
42
   integer                             :: M=1
43
   REALTYPE                            :: cord_relax=_ZERO_   
kbk's avatar
kbk committed
44 45 46 47 48 49
   logical                             :: calc_temp=.true.
   logical                             :: calc_salt=.true.
   logical                             :: calc_spm=.false.
   logical                             :: bdy3d=.false.
   integer                             :: bdyfmt_3d,bdyramp_3d
   character(len=PATH_MAX)             :: bdyfile_3d
gotm's avatar
gotm committed
50 51 52 53 54
!
! !REVISION HISTORY:
!  Original author(s): Karsten Bolding & Hans Burchard
!
!  $Log: m3d.F90,v $
55 56 57 58
!  Revision 1.14  2004-04-06 12:42:50  kbk
!  internal pressure calculations now uses wrapper
!
!  Revision 1.13  2004/01/08 10:23:20  kbk
59 60 61
!  NN not needed for barotropic runs, NO_SUSP_MATTER works
!
!  Revision 1.12  2004/01/06 15:04:00  kbk
62 63 64
!  FCT advection + split of advection_3d.F90 + extra adv. input checks
!
!  Revision 1.11  2004/01/05 13:23:27  kbk
kbk's avatar
kbk committed
65 66 67
!  Poor Man's Z-coordinates
!
!  Revision 1.10  2004/01/02 13:54:24  kbk
68 69 70
!  read equation of state info from namelist - Ruiz
!
!  Revision 1.9  2003/12/16 17:02:44  kbk
kbk's avatar
kbk committed
71 72 73
!  removed TABS - 0. -> _ZERO_
!
!  Revision 1.8  2003/12/16 15:58:54  kbk
74 75 76
!  back ground viscosity and diffusivity (manuel)
!
!  Revision 1.7  2003/09/12 16:23:38  kbk
77 78 79
!  fixed order of use statement - now compiles on with IFC 7.1
!
!  Revision 1.6  2003/08/28 15:13:57  kbk
kbk's avatar
kbk committed
80 81 82
!  explicit set UEx and VEx to 0
!
!  Revision 1.5  2003/04/23 12:16:34  kbk
kbk's avatar
kbk committed
83 84 85
!  cleaned code + TABS to spaces
!
!  Revision 1.4  2003/04/07 16:28:34  kbk
kbk's avatar
kbk committed
86
!  parallel support
gotm's avatar
gotm committed
87 88 89
!
!  Revision 1.1.1.1  2002/05/02 14:00:51  gotm
!  recovering after CVS crash
gotm's avatar
gotm committed
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
!
!  Revision 1.30  2001/10/26 09:13:24  bbh
!  Only call slow_diffusion() if Am > 0.
!
!  Revision 1.29  2001/10/23 12:38:58  bbh
!  Forgot cord_relax in one call to coordinates()
!
!  Revision 1.28  2001/10/23 07:53:10  bbh
!  spm -> suspended_matter
!
!  Revision 1.27  2001/10/23 07:05:11  bbh
!  Parabolic viscosity - -DPARABOLIC_VISCOSITY
!
!  Revision 1.26  2001/10/22 11:16:09  bbh
!  Added support for particulate suspended matter - no IO yet
!
!  Revision 1.25  2001/10/22 09:26:41  bbh
!  Added cord_relax
!
!  Revision 1.24  2001/10/22 08:48:30  bbh
!  Am moved from paramters.F90 to m2d.F90
!
!  Revision 1.23  2001/10/12 11:39:20  bbh
!  TVD moved out of ??_momentum_3d.F90 and into uv_advect_3d.F90
!
!  Revision 1.22  2001/10/12 08:49:56  bbh
!  Support for horizontal diffusion
!
!  Revision 1.21  2001/09/19 13:07:00  bbh
!  Moved advection related 3D fields to global allocation
!
!  Revision 1.20  2001/09/03 20:14:03  bbh
!  Fixed reading of vel_{hor,vel,strang
!
!  Revision 1.19  2001/09/03 20:04:21  bbh
!  Allow individual advection settings for momentum, salinity and temperature
!
!  Revision 1.18  2001/09/03 13:02:52  bbh
!  Small changes due to NOMADS
!
!  Revision 1.17  2001/08/31 15:39:49  bbh
!  ifdef for CONSTANCE added
!
!  Revision 1.16  2001/08/30 08:56:26  bbh
!  Preparing for 3D boundary conditions
!
!  Revision 1.15  2001/08/29 12:08:05  bbh
!  temp_adv and salt_adv needs to be public
!
!  Revision 1.14  2001/08/29 11:21:46  bbh
!  namelists read in salinity and temperature + initialisation
!
!  Revision 1.13  2001/08/27 11:51:45  bbh
!  TVD-advection for momentum added, some bugs removed
!
!  Revision 1.12  2001/08/01 08:31:22  bbh
!  CURVILINEAR now implemented
!
!  Revision 1.11  2001/07/26 13:46:06  bbh
!  Included info for salinity and temperature in namelist
!
!  Revision 1.10  2001/06/22 08:19:10  bbh
!  Compiler options such as USE_MASK and OLD_DRY deleted.
!  Open and passive boundary for z created.
!  Various inconsistencies removed.
!  wait_halo added.
!  Checked loop boundaries
!
!  Revision 1.9  2001/05/25 19:36:36  bbh
!  Added call to eqstate
!
!  Revision 1.8  2001/05/21 13:07:19  bbh
!  dt and cnpar is in variables_3d.F90
!
!  Revision 1.7  2001/05/20 07:51:40  bbh
!  Internal pressure included
!
!  Revision 1.6  2001/05/18 08:17:49  bbh
!  Tidying up initialization of salinity and temperature
!
!  Revision 1.5  2001/05/15 11:47:57  bbh
!  Added update_3d_halo for initial S and T
!
!  Revision 1.4  2001/05/10 11:30:16  bbh
!  Added further support for baroclinicity
!
!  Revision 1.3  2001/05/03 20:12:31  bbh
!  Use of variables_3d
!
!  Revision 1.2  2001/04/24 08:39:21  bbh
!  Included runtype as argument to integrate_3d
!
!  Revision 1.1.1.1  2001/04/17 08:43:08  bbh
!  initial import into CVS
!
! !LOCAL VARIABLES:
186
   integer         :: vel_hor_adv=1,vel_ver_adv=1,vel_adv_split=0
gotm's avatar
gotm committed
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
!EOP
!-----------------------------------------------------------------------

   contains

!-----------------------------------------------------------------------
!BOP
!
! !IROUTINE: init_3d - initialise 3D relatedstuff.
!
! !INTERFACE:
   subroutine init_3d(runtype,timestep,hotstart)
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
kbk's avatar
kbk committed
202 203 204
   integer, intent(in)                 :: runtype
   REALTYPE, intent(in)                :: timestep
   logical, intent(in)                 :: hotstart
gotm's avatar
gotm committed
205 206 207 208 209 210 211 212 213 214 215 216 217
!
! !INPUT/OUTPUT PARAMETERS:
!
! !OUTPUT PARAMETERS:
!
! !DESCRIPTION:
!  Allocates memiory for 3D related fields.
!
! !REVISION HISTORY:
!
!  22Apr99   Karsten Bolding & Hans Burchard  Initial code.
!
! !LOCAL VARIABLES:
218
   integer         :: rc
kbk's avatar
kbk committed
219 220 221
   NAMELIST /m3d/ &
             M,cnpar,cord_relax,                        &
             bdy3d,bdyfmt_3d,bdyramp_3d,bdyfile_3d,     &
222
             vel_hor_adv,vel_ver_adv,vel_adv_split,     &
223
             calc_temp,calc_salt,calc_spm,              &
224
             avmback,avhback,ip_method
gotm's avatar
gotm committed
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
!
!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)

! Allocates memory for the public data members - if not static
   call init_variables_3d(runtype)

243 244 245 246 247
!  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
248 249 250
#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.'
251
      call getm_error("init_3d()","GETM needs recompilation")
gotm's avatar
gotm committed
252
#endif
253 254 255 256 257 258
   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
259
   end if
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
   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

gotm's avatar
gotm committed
310
   dt = M*timestep
gotm's avatar
gotm committed
311 312
   num=avmmol
   nuh=avmmol
gotm's avatar
gotm committed
313 314

!  Needed for interpolation of temperature and salinity
kbk's avatar
kbk committed
315
   if (.not. hotstart) then
gotm's avatar
gotm committed
316
      call start_macro()
kbk's avatar
kbk committed
317
      call coordinates(vert_cord,cord_relax,maxdepth)
kbk's avatar
kbk committed
318
   end if
gotm's avatar
gotm committed
319

kbk's avatar
kbk committed
320
#ifndef NO_BAROCLINIC
gotm's avatar
gotm committed
321
   if (runtype .eq. 3 .or. runtype .eq. 4) then
gotm's avatar
gotm committed
322
      T = _ZERO_ ; S = _ZERO_ ; rho = _ZERO_
gotm's avatar
gotm committed
323 324
      if(calc_temp) call init_temperature(1)
      if(calc_salt) call init_salinity(1)
325
#ifndef NO_SUSP_MATTER
gotm's avatar
gotm committed
326
      if(calc_spm)  call init_spm(1)
327
#endif
328
      call init_eqstate()
gotm's avatar
gotm committed
329 330 331
#ifndef PECS
      call do_eqstate()
#endif
332 333
      if (runtype .ge. 3) call init_internal_pressure()
      if (runtype .eq. 3) call do_internal_pressure()
gotm's avatar
gotm committed
334 335 336 337
      if (runtype .eq. 4) then
         call init_advection_3d(2)
      end if
   end if
kbk's avatar
kbk committed
338
#endif
gotm's avatar
gotm committed
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359

   if (bdy3d) call init_bdy_3d()

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

!-----------------------------------------------------------------------
!BOP
!
! !IROUTINE: integrate_3d - sequence of calls to do 3D model integration
!
! !INTERFACE:
   subroutine integrate_3d(runtype,n)
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
kbk's avatar
kbk committed
360
   integer, intent(in)                 :: runtype,n
gotm's avatar
gotm committed
361 362 363 364 365 366 367 368 369 370 371 372
!
! !INPUT/OUTPUT PARAMETERS:
!
! !OUTPUT PARAMETERS:
!
! !DESCRIPTION:
! A wrapper to call all 3D related subroutines in one subroutine.
!
! !REVISION HISTORY:
!  See log for module
!
! !LOCAL VARIABLES:
kbk's avatar
kbk committed
373
  logical, save              :: ufirst=.true.
gotm's avatar
gotm committed
374 375 376 377 378 379 380 381 382 383
!
!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
384
#ifndef NO_BAROCLINIC
gotm's avatar
gotm committed
385
   if (bdy3d) call do_bdy_3d(0,T)
kbk's avatar
kbk committed
386
#endif
gotm's avatar
gotm committed
387

kbk's avatar
kbk committed
388
   call coordinates(vert_cord,cord_relax,maxdepth)
gotm's avatar
gotm committed
389
#ifndef NO_BOTTFRIC
kbk's avatar
kbk committed
390
   if (kmax .gt. 1) then
gotm's avatar
gotm committed
391 392 393 394
      call bottom_friction_3d()
   end if
#endif
   SS = _ZERO_
kbk's avatar
kbk committed
395
#ifndef NO_BAROCLINIC
gotm's avatar
gotm committed
396
   NN = _ZERO_
397
   if (runtype .eq. 4) call do_internal_pressure()
kbk's avatar
kbk committed
398
#endif
gotm's avatar
gotm committed
399 400 401 402 403 404 405 406 407 408 409 410 411
   if (ufirst) then
      call uu_momentum_3d(bdy3d)
      call vv_momentum_3d(bdy3d)
      ufirst=.false.
   else
      call vv_momentum_3d(bdy3d)
      call uu_momentum_3d(bdy3d)
      ufirst=.true.
   end if
   if (kmax .gt. 1) then
      call ww_momentum_3d()
   end if
#ifndef NO_ADVECT
kbk's avatar
kbk committed
412
   if (kmax .gt. 1) then
413
      call uv_advect_3d(vel_hor_adv,vel_ver_adv,vel_adv_split)
gotm's avatar
gotm committed
414 415 416 417 418 419 420
      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
421

gotm's avatar
gotm committed
422 423
#ifdef CONST_VISC
   num = 1.000e-4
kbk's avatar
kbk committed
424
   nuh = 1.000e-5
gotm's avatar
gotm committed
425 426
#else
#ifndef NO_BOTTFRIC
kbk's avatar
kbk committed
427
   if (kmax .gt. 1) then
gotm's avatar
gotm committed
428 429 430 431 432 433 434 435
      call stresses_3d()
#ifndef PARABOLIC_VISCOSITY
      call ss_nn()
#endif
      call gotm()
   end if
#endif
#endif
kbk's avatar
kbk committed
436
#ifndef NO_BAROCLINIC
kbk's avatar
kbk committed
437
   if(runtype .eq. 4) then        ! prognostic T and S
gotm's avatar
gotm committed
438 439
      if (calc_temp) call do_temperature(n)
      if (calc_salt) call do_salinity(n)
440
#ifndef NO_SUSP_MATTER
gotm's avatar
gotm committed
441
      if (calc_spm) call do_spm()
442
#endif
gotm's avatar
gotm committed
443 444 445 446
#ifndef PECS
      call do_eqstate()
#endif
   end if
kbk's avatar
kbk committed
447
#endif
gotm's avatar
gotm committed
448

kbk's avatar
kbk committed
449
   UEx=_ZERO_ ; VEx=_ZERO_
kbk's avatar
kbk committed
450
   if (kmax .gt. 1) then
gotm's avatar
gotm committed
451
#ifndef NO_BOTTFRIC
kbk's avatar
kbk committed
452
      call slow_bottom_friction()
gotm's avatar
gotm committed
453 454 455
#endif
#ifndef NO_ADVECT
#ifndef UV_ADV_DIRECT
kbk's avatar
kbk committed
456 457 458 459
      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
460 461 462
#endif
#endif
   end if
gotm's avatar
gotm committed
463

gotm's avatar
gotm committed
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 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
   call slow_terms()
   call stop_macro()

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

!-----------------------------------------------------------------------
!BOP
!
! !IROUTINE: clean_3d - cleanup after 3D run.
!
! !INTERFACE:
   subroutine clean_3d()
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
!
! !INPUT/OUTPUT PARAMETERS:
!
! !OUTPUT PARAMETERS:
!
! !DESCRIPTION:
!  This routine cleans up after a 3D integration. Close open files etc.
!
! !REVISION HISTORY:
!  22Nov Author name Initial code
!
! !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)         !
!-----------------------------------------------------------------------