variables_3d.F90 8.62 KB
Newer Older
gotm's avatar
gotm committed
1 2 3 4
#include "cppdefs.h"
!-----------------------------------------------------------------------
!BOP
!
5
! !MODULE: variables_3d - global 3D related variables \label{sec-variables-3d}
gotm's avatar
gotm committed
6 7 8 9 10 11 12
!
! !INTERFACE:
   module variables_3d
!
! !DESCRIPTION:
!  This modules contains declarations for all variables related to 3D
!  hydrodynamical calculations. Information about the calculation domain
hb's avatar
hb committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
!  is included from the {\tt domain} module.
!  The variables are either statically defined in {\tt static\_3d.h} or
!  dynamically allocated in {\tt dynamic\_declarations\_3d.h}.
!  The variables which need to be declared have the following dimensions,
!  units and meanings:
!
! \vspace{0.5cm}
! \begin{supertabular}{llll}
! {\tt kmin} & 2D & [-] & lowest index in T-point \\
! {\tt kumin} & 2D &[-]  & lowest index in U-point \\
! {\tt kvmin} & 2D &[-]  & lowest index in V-point \\
! {\tt kmin\_pmz} & 2D &[-]  & lowest index in T-point (poor man's
! $z$-coordinate)\\
! {\tt kumin\_pmz} & 2D &[-]  & lowest index in U-point (poor man's
! $z$-coordinate)\\
! {\tt kvmin\_pmz} & 2D &[-]  & lowest index in V-point (poor man's
! $z$-coordinate)\\
! {\tt uu} & 3D & [m$^2$s$^{-1}$] & layer integrated $u$ transport
! $p_k$\\
! {\tt vv} & 3D & [m$^2$s$^{-1}$] & layer integrated $v$ transport
! $q_k$\\
! {\tt ww} & 3D & [m\,s$^{-1}$] & grid-related vertical velocity
! $\bar w_k$\\
! {\tt ho} & 3D & [m] & old layer height in T-point \\
! {\tt hn} & 3D & [m]& new layer height in T-point \\
! {\tt huo} & 3D &[m]& old layer height in U-point \\
! {\tt hun} & 3D & [m]& new layer height in U-point \\
! {\tt hvo} & 3D & [m]& old layer height in V-point \\
! {\tt hvn} & 3D & [m]& new layer height in V-point \\
! {\tt hcc} & 3D &[-] & hydrostatic consistency index in T-points\\
43
! {\tt uuEx} & 3D & [m$^2$s$^{-2}$] & sum of advection and
hb's avatar
hb committed
44
! diffusion for $u$-equation\\
45
! {\tt vvEx} & 3D &  [m$^2$s$^{-2}$]& sum of advection and
hb's avatar
hb committed
46 47 48 49 50 51 52 53 54 55 56
! diffusion for $v$-equation\\
! {\tt num} & 3D &  [m$^2$s$^{-1}$]& eddy viscosity on $w$-points
! $\nu_t$\\
! {\tt nuh} & 3D &  [m$^2$s$^{-1}$]& eddy diffusivity on $w$-points $\nu'_t$\\
! {\tt tke} & 3D &  [m$^2$s$^{-2}$]& turbulent kinetic energy $k$\\
! {\tt eps} & 3D &  [m$^2$s$^{-3}$]& turbulent dissipation rate
! $\eps$ \\
! {\tt SS} & 3D & [s$^{-2}$]& shear-frequency squared $M^2$ \\
! {\tt NN} & 3D &  [s$^{-2}$]& Brunt-V\"ais\"al\"a frequency squared$N^2$ \\
! {\tt S} & 3D & [psu] & salinity $S$ \\
! {\tt T} & 3D & [$^{\circ}$C]& potential temperature $\theta$ \\
57 58 59
! {\tt rad} & 3D & [Wm$^{-2}$]& Short wave penetration \\
! {\tt rho} & 3D & [kg\,m$^{-3}$]& density $rho$ \\
! {\tt buoy} & 3D & [m\,s$^{-2}$]& buoyancy $b$ \\
hb's avatar
hb committed
60 61 62 63 64 65 66 67 68 69 70
! {\tt idpdx} & 3D & [m$^2$s$^{-2}$] & $x$-component of internal
! pressure gradient \\
! {\tt idpdy} & 3D & [m$^2$s$^{-2}$]& $y$-component of internal
! pressure gradient\\
! {\tt spm} & 3D & [kg\,m$^{-3}$] & suspended matter concentration \\
! {\tt spm\_ws} & 3D & [m\,s$^{-1}$] & settling velocity of
! suspended matter \\
! {\tt spm\_pool} & 2D & [kg\,m$^{-2}$] & bottom pool of suspended
! matter\\
! {\tt uadv} & 3D & [m\,s$^{-1}$] & interpolated $x$-component of
! momentum advection velocity \\
71
! {\tt vadv} & 3D &  [m\,s$^{-1}$]& interpolated $y$-component of
hb's avatar
hb committed
72
! momentum advection velocity \\
73
! {\tt wadv} & 3D &  [m\,s$^{-1}$]& interpolated  vertical component of
hb's avatar
hb committed
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
! momentum advection velocity \\
! {\tt huadv} & 3D &[m] & interpolated height of advective flux
! layer ($x$-component) \\
! {\tt hvadv} & 3D &[m] & interpolated height of advective flux
! layer ($y$-component) \\
! {\tt hoadv} & 3D &[m] & old height of advective finite volume cell
! \\
! {\tt hnadv} & 3D &[m] & new height of advective finite volume
! cell\\
! {\tt sseo} & 2D & [m]& sea surface elevation before macro time
! step (T-point)\\
! {\tt ssen} & 2D & [m]& sea surface elevation after macro time
! step (T-point)\\
! {\tt ssuo} & 2D & [m]& sea surface elevation before macro time
! step (U-point)\\
! {\tt ssun} & 2D & [m]&sea surface elevation after macro time step
! (U-point)\\
! {\tt ssvo} & 2D & [m]& sea surface elevation before macro time
! step (V-point)\\
! {\tt ssvn} & 2D & [m]& sea surface elevation after macro time
! step (V-point)\\
! {\tt rru} & 2D & [m\,s$^{-1}$]&drag coefficient times curret speed
! in U-point\\
! {\tt rrv} & 2D & [m\,s$^{-1}$]&drag coefficient times curret speed
! in V-point\\
! {\tt taus} & 2D & [m$^2$s$^{-2}$]& normalised surface stress
! (T-point) \\
! {\tt taub} & 2D & [m$^2$s$^{-2}$]& normalised bottom stress
! (T-point) \\
! \end{supertabular}
!
! \vspace{0.5cm}
!
! It should be noted that depending on compiler options and runtype not
! all these variables are defined.
!
! The module contains public subroutines to initialise (see
! {\tt init\_variables\_3d}) and cleanup (see {\tt clean\_variables\_3d}).
gotm's avatar
gotm committed
112 113
!
! !USES:
114
   use domain,     only: imin,imax,jmin,jmax,kmax
gotm's avatar
gotm committed
115 116 117
   IMPLICIT NONE
!
! !PUBLIC DATA MEMBERS:
kbk's avatar
kbk committed
118
   REALTYPE                            :: dt,cnpar=0.9
119
   REALTYPE                            :: avmback=_ZERO_,avhback=_ZERO_
120
   logical                             :: do_numerical_analyses=.false.
gotm's avatar
gotm committed
121 122
!
#ifdef STATIC
gotm's avatar
gotm committed
123
#include "static_3d.h"
gotm's avatar
gotm committed
124
#else
gotm's avatar
gotm committed
125
#include "dynamic_declarations_3d.h"
126 127 128 129 130
#endif

#ifdef GETM_BIO
   REALTYPE, allocatable               :: cc3d(:,:,:,:)
   REALTYPE, allocatable               :: ws3d(:,:,:,:)
131 132 133 134
#endif
#ifdef _FABM_
   REALTYPE, allocatable, dimension(:,:,:,:) :: fabm_pel,fabm_diag
   REALTYPE, allocatable, dimension(:,:,:)   :: fabm_ben,fabm_diag_hz
gotm's avatar
gotm committed
135
#endif
kbk's avatar
kbk committed
136 137
   integer                             :: size3d_field
   integer                             :: mem3d
138
   integer                             :: preadapt
gotm's avatar
gotm committed
139
!
kbk's avatar
kbk committed
140 141 142
! !REVISION HISTORY:
!  Original author(s): Karsten Bolding & Hans Burchard
!
gotm's avatar
gotm committed
143 144 145 146 147 148 149 150
!EOP
!-----------------------------------------------------------------------

   contains

!-----------------------------------------------------------------------
!BOP
!
hb's avatar
hb committed
151 152
! !IROUTINE: init_variables_3d - initialise 3D related stuff
! \label{sec-init-variables}
gotm's avatar
gotm committed
153 154 155 156 157 158
!
! !INTERFACE:
   subroutine init_variables_3d(runtype)
   IMPLICIT NONE
!
! !INPUT PARAMETERS:
kbk's avatar
kbk committed
159
   integer, intent(in)                 :: runtype
gotm's avatar
gotm committed
160 161
!
! !DESCRIPTION:
hb's avatar
hb committed
162 163 164
!  Dynamic allocation of memory for 3D related fields via
!  {\tt dynamic\_allocations\_3d.h} (unless the compiler option
!  {\tt STATIC} is set). Furthermore, most variables are initialised here.
gotm's avatar
gotm committed
165 166
!
! !LOCAL VARIABLES:
kbk's avatar
kbk committed
167
   integer                   :: rc
gotm's avatar
gotm committed
168 169 170 171 172 173 174 175 176 177
!EOP
!-------------------------------------------------------------------------
!BOC
#ifdef DEBUG
   integer, save :: Ncall = 0
   Ncall = Ncall+1
   write(debug,*) 'init_variables_3d() # ',Ncall
#endif

   LEVEL2 'init_variables_3d'
178 179
   size3d_field=((imax+HALO)-(imin+HALO)+1)*        &
                ((jmax+HALO)-(jmin+HALO)+1)*(kmax+1)
gotm's avatar
gotm committed
180 181 182 183
   mem3d=n3d_fields*size3d_field*REAL_SIZE

!  Allocates memory for the public data members - if not static
#ifndef STATIC
gotm's avatar
gotm committed
184
#include "dynamic_allocations_3d.h"
gotm's avatar
gotm committed
185 186
#endif

kbk's avatar
kbk committed
187 188
   hn = _ZERO_ ; hun = _ZERO_ ; hvn = _ZERO_
   uu = _ZERO_ ; vv = _ZERO_ ; ww = _ZERO_
Hans Burchard's avatar
Hans Burchard committed
189 190
#ifdef _MOMENTUM_TERMS_
   tdv_u = _ZERO_ ; adv_u = _ZERO_ ; vsd_u = _ZERO_ ; hsd_u = _ZERO_
Karsten Bolding's avatar
Karsten Bolding committed
191
   cor_u = _ZERO_ ; epg_u = _ZERO_ ; ipg_u = _ZERO_
Hans Burchard's avatar
Hans Burchard committed
192
   tdv_v = _ZERO_ ; adv_v = _ZERO_ ; vsd_v = _ZERO_ ; hsd_v = _ZERO_
Karsten Bolding's avatar
Karsten Bolding committed
193
   cor_v = _ZERO_ ; epg_v = _ZERO_ ; ipg_v = _ZERO_
Hans Burchard's avatar
Hans Burchard committed
194
#endif
kbk's avatar
kbk committed
195
   ssen = _ZERO_ ; ssun = _ZERO_ ; ssvn = _ZERO_
196
   Dn = _ZERO_ ; Dun = _ZERO_ ; Dvn = _ZERO_
kbk's avatar
kbk committed
197 198 199
   rru= _ZERO_ ; rrv= _ZERO_
   uuEx= _ZERO_ ; vvEx= _ZERO_
   tke=1.e-10 ; eps=1.e-10
200
   preadapt=0
kbk's avatar
kbk committed
201

kb's avatar
kb committed
202
#ifndef NO_BAROCLINIC
203
   rad=_ZERO_
204
   light=_ONE_
205 206
   idpdx=_ZERO_
   idpdy=_ZERO_
207 208
   nummix3d_S = _ZERO_ ; nummix2d_S = _ZERO_
   nummix3d_T = _ZERO_ ; nummix2d_T = _ZERO_
209
   numdis3d   = _ZERO_ ; numdis2d   = _ZERO_
210 211
#endif

gotm's avatar
gotm committed
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
#ifdef DEBUG
   write(debug,*) 'Leaving init_variables_3d()'
   write(debug,*)
#endif
   return
   end subroutine init_variables_3d
!EOC

!-----------------------------------------------------------------------
!BOP
!
! !IROUTINE: clean_variables_3d - cleanup after 3D run.
!
! !INTERFACE:
   subroutine clean_variables_3d()
   IMPLICIT NONE
!
! !DESCRIPTION:
hb's avatar
hb committed
230
!  This routine cleans up after a 3D integrationby doing nothing so far.
gotm's avatar
gotm committed
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
!
!EOP
!-----------------------------------------------------------------------
!BOC
#ifdef DEBUG
   integer, save :: Ncall = 0
   Ncall = Ncall+1
   write(debug,*) 'clean_3d() # ',Ncall
#endif

! Deallocates memory for the public data members

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

!-----------------------------------------------------------------------

   end module variables_3d

!-----------------------------------------------------------------------
! Copyright (C) 2001 - Hans Burchard and Karsten Bolding (BBH)         !
!-----------------------------------------------------------------------