m3d.F90 10.4 KB
Newer Older
kbk's avatar
kbk committed
1
!$Id: m3d.F90,v 1.4 2003-04-07 16:28:34 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 22
#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
   use domain,     only: vert_cord
kbk's avatar
kbk committed
23 24 25
   use m2d,        only: Am
   use variables_2d, only: D,z
#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 29 30
   use eqstate,    only: init_eqstate, do_eqstate
#endif
#ifndef NO_BAROCLINIC
gotm's avatar
gotm committed
31
   use suspended_matter,	   only: init_spm, do_spm
kbk's avatar
kbk committed
32
#endif
gotm's avatar
gotm committed
33 34 35
   use advection_3d, only: init_advection_3d
   use bdy_3d,     only: init_bdy_3d, do_bdy_3d
   use variables_3d
kbk's avatar
kbk committed
36 37 38 39
#ifdef PARALLEL
use halo_mpi
#endif

gotm's avatar
gotm committed
40 41 42 43
   IMPLICIT NONE
!
! !PUBLIC DATA MEMBERS:
   integer	:: M=1
kbk's avatar
kbk committed
44
   REALTYPE	:: cord_relax=_ZERO_
gotm's avatar
gotm committed
45 46 47 48 49 50 51 52 53
   logical	:: calc_temp=.true.,calc_salt=.true.,calc_spm=.false.
   logical	:: bdy3d=.false.
   integer	:: bdyfmt_3d,bdyramp_3d
   character(len=PATH_MAX)	:: bdyfile_3d
!
! !REVISION HISTORY:
!  Original author(s): Karsten Bolding & Hans Burchard
!
!  $Log: m3d.F90,v $
kbk's avatar
kbk committed
54 55
!  Revision 1.4  2003-04-07 16:28:34  kbk
!  parallel support
gotm's avatar
gotm committed
56 57 58
!
!  Revision 1.1.1.1  2002/05/02 14:00:51  gotm
!  recovering after CVS crash
gotm's avatar
gotm committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 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 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 216 217 218 219 220 221
!
!  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:
   integer	:: vel_hor_adv=1,vel_ver_adv=1,vel_strang=0
!EOP
!-----------------------------------------------------------------------

   contains

!-----------------------------------------------------------------------
!BOP
!
! !IROUTINE: init_3d - initialise 3D relatedstuff.
!
! !INTERFACE:
   subroutine init_3d(runtype,timestep,hotstart)
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
   integer, intent(in)		:: runtype
   REALTYPE, intent(in)		:: timestep
   logical, intent(in)		:: hotstart
!
! !INPUT/OUTPUT PARAMETERS:
!
! !OUTPUT PARAMETERS:
!
! !DESCRIPTION:
!  Allocates memiory for 3D related fields.
!
! !REVISION HISTORY:
!
!  22Apr99   Karsten Bolding & Hans Burchard  Initial code.
!
! !LOCAL VARIABLES:
   integer 		:: rc
   NAMELIST /m3d/ 	M,cnpar,cord_relax,			&
                        bdy3d,bdyfmt_3d,bdyramp_3d,bdyfile_3d,	&
                        vel_hor_adv,vel_ver_adv,vel_strang,	&
			calc_temp,calc_salt,calc_spm
!
!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)

   LEVEL2 'vel_hor_adv= ',vel_hor_adv
   LEVEL2 'vel_ver_adv= ',vel_ver_adv
   LEVEL2 'vel_strang=  ',vel_strang

   if(vel_hor_adv .gt. 1 .or. vel_ver_adv .gt. 1) then
#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.'
      stop 'init_3d'
#endif
   end if
   dt = M*timestep
gotm's avatar
gotm committed
222 223
   num=avmmol
   nuh=avmmol
gotm's avatar
gotm committed
224 225

!  Needed for interpolation of temperature and salinity
kbk's avatar
kbk committed
226
   if (.not. hotstart) then
gotm's avatar
gotm committed
227 228
      call start_macro()
      call coordinates(vert_cord,cord_relax)
kbk's avatar
kbk committed
229
   end if
gotm's avatar
gotm committed
230

kbk's avatar
kbk committed
231
#ifndef NO_BAROCLINIC
gotm's avatar
gotm committed
232
   if (runtype .eq. 3 .or. runtype .eq. 4) then
gotm's avatar
gotm committed
233
      T = _ZERO_ ; S = _ZERO_ ; rho = _ZERO_
gotm's avatar
gotm committed
234 235 236 237 238 239 240 241 242 243 244 245
      if(calc_temp) call init_temperature(1)
      if(calc_salt) call init_salinity(1)
      if(calc_spm)  call init_spm(1)
      call init_eqstate(1)
#ifndef PECS
      call do_eqstate()
#endif
      if (runtype .eq. 3) call internal_pressure()
      if (runtype .eq. 4) then
         call init_advection_3d(2)
      end if
   end if
kbk's avatar
kbk committed
246
#endif
gotm's avatar
gotm committed
247 248 249 250 251 252 253 254 255 256 257 258 259 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

   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:
   integer, intent(in)	:: runtype,n
!
! !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:
  logical, save	:: ufirst=.true.
!
!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
292
#ifndef NO_BAROCLINIC
gotm's avatar
gotm committed
293
   if (bdy3d) call do_bdy_3d(0,T)
kbk's avatar
kbk committed
294
#endif
gotm's avatar
gotm committed
295 296 297

   call coordinates(vert_cord,cord_relax)
#ifndef NO_BOTTFRIC
kbk's avatar
kbk committed
298
   if (kmax .gt. 1) then
gotm's avatar
gotm committed
299 300 301 302
      call bottom_friction_3d()
   end if
#endif
   SS = _ZERO_
kbk's avatar
kbk committed
303
#ifndef NO_BAROCLINIC
gotm's avatar
gotm committed
304 305
   NN = _ZERO_
   if (runtype .eq. 4) call internal_pressure()
kbk's avatar
kbk committed
306
#endif
gotm's avatar
gotm committed
307 308 309 310 311 312 313 314 315 316 317 318 319
   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
320
   if (kmax .gt. 1) then
gotm's avatar
gotm committed
321 322 323 324 325 326 327 328
      call uv_advect_3d(vel_hor_adv,vel_ver_adv,vel_strang)
      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
329

gotm's avatar
gotm committed
330 331
#ifdef CONST_VISC
   num = 1.000e-4
kbk's avatar
kbk committed
332
   nuh = 1.000e-5
gotm's avatar
gotm committed
333 334
#else
#ifndef NO_BOTTFRIC
kbk's avatar
kbk committed
335
   if (kmax .gt. 1) then
gotm's avatar
gotm committed
336 337 338 339 340 341 342 343
      call stresses_3d()
#ifndef PARABOLIC_VISCOSITY
      call ss_nn()
#endif
      call gotm()
   end if
#endif
#endif
kbk's avatar
kbk committed
344
#ifndef NO_BAROCLINIC
gotm's avatar
gotm committed
345 346 347 348 349 350 351 352
   if(runtype .eq. 4) then	! prognostic T and S
      if (calc_temp) call do_temperature(n)
      if (calc_salt) call do_salinity(n)
      if (calc_spm) call do_spm()
#ifndef PECS
      call do_eqstate()
#endif
   end if
kbk's avatar
kbk committed
353
#endif
gotm's avatar
gotm committed
354

kbk's avatar
kbk committed
355
   if (kmax .gt. 1) then
gotm's avatar
gotm committed
356
#ifndef NO_BOTTFRIC
kbk's avatar
kbk committed
357
      call slow_bottom_friction()
gotm's avatar
gotm committed
358 359 360
#endif
#ifndef NO_ADVECT
#ifndef UV_ADV_DIRECT
kbk's avatar
kbk committed
361 362 363 364
      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
365 366 367
#endif
#endif
   end if
gotm's avatar
gotm committed
368

gotm's avatar
gotm committed
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
   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)         !
!-----------------------------------------------------------------------