/[MITgcm]/MITgcm/model/inc/PARAMS.h
ViewVC logotype

Diff of /MITgcm/model/inc/PARAMS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.12 by adcroft, Thu May 28 16:19:50 1998 UTC revision 1.65.4.4 by heimbach, Tue Jun 24 23:05:05 2003 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2    C $Name$
3  C  C
4  C     /==========================================================\  CBOP
5  C     | PARAMS.h                                                 |  C    !ROUTINE: PARAMS.h
6  C     | o Header file defining model "parameters".               |  C    !INTERFACE:
7  C     |==========================================================|  C    include PARAMS.h
8  C     | The values from the model's standard input file are      |  C    !DESCRIPTION: \bv
9  C     | stored into the variables held here. Notes describing    |  C     *==========================================================*
10  C     | the parameters can also be found here.                   |  C     | PARAMS.h                                                  
11  C     \==========================================================/  C     | o Header file defining model "parameters".                
12    C     *==========================================================*
13    C     | The values from the model standard input file are        
14    C     | stored into the variables held here. Notes describing    
15    C     | the parameters can also be found here.                    
16    C     *==========================================================*
17    C     \ev
18    CEOP
19    
20    C     Macros for special grid options
21    #include "PARAMS_MACROS.h"
22    
23  C--   Contants  C--   Contants
24  C     Useful physical values  C     Useful physical values
# Line 17  C     Useful physical values Line 28  C     Useful physical values
28        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
29    
30  C     Symbolic values  C     Symbolic values
31  C     precXXXX - Used to indicate what precision to use for  C     precXXXX :: Used to indicate what precision to use for
32  C                dumping model state.  C                dumping model state.
33        INTEGER precFloat32        INTEGER precFloat32
34        PARAMETER ( precFloat32 = 0 )        PARAMETER ( precFloat32 = 32 )
35        INTEGER precFloat64        INTEGER precFloat64
36        PARAMETER ( precFloat64 = 1 )        PARAMETER ( precFloat64 = 64 )
37    C     UNSET_xxx :: Used to indicate variables that have not been given a value
38          Real*8 UNSET_FLOAT8
39          PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
40          Real*4 UNSET_FLOAT4
41          PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
42          _RL    UNSET_RL    
43          PARAMETER ( UNSET_RL     = 1.234567D5 )
44          _RS    UNSET_RS    
45          PARAMETER ( UNSET_RS     = 1.234567E5 )
46          INTEGER UNSET_I
47          PARAMETER ( UNSET_I      = 123456789  )
48    
49  C     Checkpoint data  C     Checkpoint data
50        INTEGER maxNoChkptLev        INTEGER maxNoChkptLev
51        PARAMETER ( maxNoChkptLev = 2 )        PARAMETER ( maxNoChkptLev = 2 )
52    
53  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
54  C     checkPtSuff - List of checkpoint file suffices  C     checkPtSuff :: List of checkpoint file suffices
55        COMMON /PARM_C/ checkPtSuff  C     bathyFile   :: File containing bathymetry. If not defined bathymetry
56    C                   is taken from inline function.
57    C     topoFile    :: File containing the topography of the surface (unit=m)
58    C                   (mainly used for the atmosphere = ground height).
59    C     hydrogThetaFile :: File containing initial hydrographic data for potential
60    C                       temperature.
61    C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.
62    C     zonalWindFile   :: File containing zonal wind data
63    C     meridWindFile   :: File containing meridional wind data
64    C     thetaClimFile   :: File containing theta climataology used
65    C                       in relaxation term -lambda(theta-theta*)
66    C     saltClimFile    :: File containing salt climataology used
67    C                       in relaxation term -lambda(salt-salt*)
68    C     surfQfile       :: File containing surface heat flux
69    C     surfQswfile     :: File containing surface shortwave radiation
70    C     dQdTfile        :: File containing thermal relaxation coefficient
71    C     EmPmRfile       :: File containing surface fresh water flux
72    C     pLoadFile       :: File containing pressure loading
73    C     buoyancyRelation :: Flag used to indicate which relation to use to
74    C                        get buoyancy.
75    C     eosType         :: choose the equation of state:
76    C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
77          COMMON /PARM_C/ checkPtSuff,
78         &                bathyFile, topoFile,
79         &                hydrogThetaFile, hydrogSaltFile,
80         &                zonalWindFile, meridWindFile, thetaClimFile,
81         &                saltClimFile, buoyancyRelation,
82         &                EmPmRfile, surfQfile, surfQswfile,
83         &                uVelInitFile, vVelInitFile, pSurfInitFile,
84         &                dQdTfile, ploadFile,
85         &                eosType, pickupSuff
86        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
87          CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
88          CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
89          CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
90          CHARACTER*(MAX_LEN_FNAM) zonalWindFile
91          CHARACTER*(MAX_LEN_FNAM) meridWindFile
92          CHARACTER*(MAX_LEN_FNAM) thetaClimFile
93          CHARACTER*(MAX_LEN_FNAM) saltClimFile
94          CHARACTER*(MAX_LEN_FNAM) surfQfile
95          CHARACTER*(MAX_LEN_FNAM) surfQswfile
96          CHARACTER*(MAX_LEN_FNAM) EmPmRfile
97          CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
98          CHARACTER*(MAX_LEN_FNAM) uVelInitFile
99          CHARACTER*(MAX_LEN_FNAM) vVelInitFile
100          CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
101          CHARACTER*(MAX_LEN_FNAM) dQdTfile
102          CHARACTER*(MAX_LEN_FNAM) ploadFile
103          CHARACTER*(6) eosType
104          CHARACTER*(10) pickupSuff
105    
106  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
107  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
108  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
109  C     cg2dChkResFreq      - Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
110    C                           in con. grad solver.
111    C     cg3dMaxIters        :: Maximum number of iterations in the
112    C                           three-dimensional con. grad solver.
113    C     cg3dChkResFreq      :: Frequency with which to check residual
114  C                           in con. grad solver.  C                           in con. grad solver.
115  C     nIter0              - Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
116  C     nTimeSteps          - Number of timesteps to execute  C     nTimeSteps          :: Number of timesteps to execute
117  C     numStepsPerPickup   - For offline setup. Frequency of pickup  C     numStepsPerPickup   :: For offline setup. Frequency of pickup
118  C                           of flow fields.  C                           of flow fields.
119  C     writeStatePrec      - Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
120  C     writeBinaryPrec     - Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
121  C     readBinaryPrec      - Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
122  C     nCheckLev           - Holds current checkpoint level  C     nCheckLev           :: Holds current checkpoint level
123    C     nonlinFreeSurf      :: option related to non-linear free surface
124    C                           =0 Linear free surface ; >0 Non-linear
125    C     select_rStar        :: option related to r* vertical coordinate
126    C                           =0 (default) use r coord. ; > 0 use r*
127    
128        COMMON /PARM_I/        COMMON /PARM_I/
129       &        cg2dMaxIters,       &        cg2dMaxIters,
130       &        cg2dChkResFreq,       &        cg2dChkResFreq,
131       &        nIter0, nTimeSteps,       &        cg3dMaxIters,
132         &        cg3dChkResFreq,
133         &        nIter0, nTimeSteps, nEndIter,
134       &        numStepsPerPickup,       &        numStepsPerPickup,
135       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
136       &        writeBinaryPrec, readBinaryPrec       &        writeBinaryPrec, readBinaryPrec,
137         &        nonlinFreeSurf, select_rStar,
138         &        tempAdvScheme, saltAdvScheme, tracerAdvScheme
139        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
140        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
141          INTEGER cg3dMaxIters
142          INTEGER cg3dChkResFreq
143        INTEGER nIter0        INTEGER nIter0
144        INTEGER nTimeSteps        INTEGER nTimeSteps
145          INTEGER nEndIter
146        INTEGER numStepsPerPickup        INTEGER numStepsPerPickup
147        INTEGER writeStatePrec        INTEGER writeStatePrec
148        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
149        INTEGER readBinaryPrec        INTEGER readBinaryPrec
150        INTEGER nCheckLev        INTEGER nCheckLev
151          INTEGER nonlinFreeSurf
152          INTEGER select_rStar
153          INTEGER tempAdvScheme
154          INTEGER saltAdvScheme
155          INTEGER tracerAdvScheme
156    
157  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
158  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
159  C                          coordinate frame.  C                          coordinate frame.
160  C     usingSphericalPolarGrid - If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
161  C                               spherical polar frame.  C                               spherical polar frame.
162  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
163  C     momAdvection  - Flag which turns advection of momentum on and off.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
164  C     momForcing    - Flag which turns external forcing of momentum on  C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
165    C     momViscosity  :: Flag which turns momentum friction terms on and off.
166    C     momAdvection  :: Flag which turns advection of momentum on and off.
167    C     momForcing    :: Flag which turns external forcing of momentum on
168  C                     and off.  C                     and off.
169  C     momPressureForcing - Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
170  C                          on and off.  C                          on and off.
171  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     metricTerms   :: Flag which turns metric terms on or off.
172  C     tempDiffusion - Flag which turns diffusion of temperature on  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
173    C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.
174    C     useCoriolis   :: Flag which turns the coriolis terms on and off.
175    C     tempDiffusion :: Flag which turns diffusion of temperature on
176  C                     and off.  C                     and off.
177  C     tempAdvection - Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
178  C                     and off.  C                     and off.
179  C     tempForcing   - Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
180  C                     and off.  C                     and off.
181  C     saltDiffusion - Flag which turns diffusion of salinit on  C     saltDiffusion :: Flag which turns diffusion of salinity on
182  C                     and off.  C                     and off.
183  C     saltAdvection - Flag which turns advection of salinit on  C     saltAdvection :: Flag which turns advection of salinity on
184  C                     and off.  C                     and off.
185  C     saltForcing   - Flag which turns external forcing of salinit on  C     saltForcing   :: Flag which turns external forcing of salinity on
186  C                     and off.  C                     and off.
187  C     implicitFreeSurface - Set to true to use implcit free surface  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
188  C     rigidLid            - Set to true to use rigid lid  C                         as a real Fresh Water (=> changes the Sea Level)
189  C     momStepping   - Turns momentum equation time-stepping off  C                         if F, converts P+R-E to salt flux (no SL effect)
190  C     momStepping   - Turns temperature equation time-stepping off  C     rigidLid            :: Set to true to use rigid lid
191    C     implicitFreeSurface :: Set to true to use implcit free surface
192    C     exactConserv        :: Set to true to conserve exactly the total Volume
193    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
194    C                           linear relation Phi_surf = Bo_surf*eta
195    C     momStepping   :: Turns momentum equation time-stepping off
196    C     tempStepping  :: Turns temperature equation time-stepping off
197    C     saltStepping  :: Turns salinity equation time-stepping off
198    C     tr1Stepping   :: Turns passive tracer 1 time-stepping on/off
199    C     useConstantF  :: Coriolis parameter set to f0
200    C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
201    C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
202    C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
203    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
204    C     implicitDiffusion :: Turns implicit vertical diffusion on
205    C     implicitViscosity :: Turns implicit vertical viscosity on
206    C     multiDimAdvection :: Flag that enable multi-dimension advection
207    C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
208    C                      out off Adams-Bashforth time stepping.
209    C     doThetaClimRelax :: Set true if relaxation to temperature
210    C                        climatology is required.
211    C     doSaltClimRelax  :: Set true if relaxation to salinity
212    C                        climatology is required.
213    C     periodicExternalForcing :: Set true if forcing is time-dependant
214    C     usingPCoords     :: Set to indicate that we are working in pressure
215    C                        coords. (jmc: is it still used ?)
216    C     usingZCoords     :: Set to indicate that we are working in height
217    C                        coords. (jmc: is it still used ?)
218    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
219    C                         this requires specific code for restart & exchange
220    C     setCenterDr    :: set cell Center depth and put Interface at the middle
221    C     nonHydrostatic :: Using non-hydrostatic terms
222    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
223    C     globalFiles    :: Selects between "global" and "tiled" files
224    C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
225    C                       slow (f77) or does not work (f90).  When
226    C                       useSingleCpuIO is set, mdsio_writefield.F
227    C                       outputs from master mpi process only.
228    C     allowFreezing  :: Allows water to freeze and form ice
229    C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
230        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
231       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,       & usingCurvilinearGrid,
232         & no_slip_sides,no_slip_bottom,
233         & staggerTimeStep,
234         & momViscosity, momAdvection, momForcing, useCoriolis,
235         & momPressureForcing, vectorInvariantMomentum,
236       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
237       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
238       & implicitFreeSurface, rigidLid, momStepping, tempStepping       & useRealFreshWaterFlux,
239         & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
240         & momStepping, tempStepping, saltStepping, tr1Stepping,
241         & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
242         & useConstantF, useBetaPlaneF, useSphereF,
243         & useCDscheme,
244         & useEnergyConservingCoriolis, useJamartWetPoints,
245         & implicitDiffusion, implicitViscosity,
246         & multiDimAdvection, forcing_In_AB,
247         & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
248         & periodicExternalForcing,
249         & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
250         & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
251         & allowFreezing, groundAtK1,
252         & usePickupBeforeC35, debugMode,
253         & readPickupWithTracer, writePickupWithTracer
254        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
255        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
256          LOGICAL usingCurvilinearGrid
257          LOGICAL usingSphericalPolarMTerms
258          LOGICAL useNHMTerms
259          LOGICAL no_slip_sides
260          LOGICAL no_slip_bottom
261          LOGICAL staggerTimeStep
262        LOGICAL momViscosity        LOGICAL momViscosity
263        LOGICAL momAdvection        LOGICAL momAdvection
264        LOGICAL momForcing        LOGICAL momForcing
265        LOGICAL momPressureForcing        LOGICAL momPressureForcing
266        LOGICAL useCoriolis        LOGICAL useCoriolis
267          LOGICAL vectorInvariantMomentum
268        LOGICAL tempDiffusion        LOGICAL tempDiffusion
269        LOGICAL tempAdvection        LOGICAL tempAdvection
270        LOGICAL tempForcing        LOGICAL tempForcing
271        LOGICAL saltDiffusion        LOGICAL saltDiffusion
272        LOGICAL saltAdvection        LOGICAL saltAdvection
273        LOGICAL saltForcing        LOGICAL saltForcing
274        LOGICAL implicitFreeSurface        LOGICAL useRealFreshWaterFlux
275        LOGICAL rigidLid        LOGICAL rigidLid
276          LOGICAL implicitFreeSurface
277          LOGICAL exactConserv
278          LOGICAL uniformLin_PhiSurf
279        LOGICAL momStepping        LOGICAL momStepping
280        LOGICAL tempStepping        LOGICAL tempStepping
281          LOGICAL saltStepping
282          LOGICAL tr1Stepping
283          LOGICAL metricTerms
284          LOGICAL useConstantF
285          LOGICAL useBetaPlaneF
286          LOGICAL useSphereF
287          LOGICAL useCDscheme
288          LOGICAL useEnergyConservingCoriolis
289          LOGICAL useJamartWetPoints
290          LOGICAL implicitDiffusion
291          LOGICAL implicitViscosity
292          LOGICAL multiDimAdvection
293          LOGICAL forcing_In_AB
294          LOGICAL doThetaClimRelax
295          LOGICAL doSaltClimRelax
296          LOGICAL doTr1ClimRelax
297          LOGICAL periodicExternalForcing
298          LOGICAL usingPCoords
299          LOGICAL usingZCoords
300          LOGICAL useDynP_inEos_Zc
301          LOGICAL setCenterDr
302          LOGICAL nonHydrostatic
303          LOGICAL quasiHydrostatic
304          LOGICAL globalFiles
305          LOGICAL useSingleCpuIO
306          LOGICAL allowFreezing
307          LOGICAL groundAtK1
308          LOGICAL usePickupBeforeC35
309          LOGICAL debugMode
310          LOGICAL readPickupWithTracer
311          LOGICAL writePickupWithTracer
312    
313  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
314  C     cg2dTargetResidual  C     gg2dTargetResidual
315  C               - Target residual for cg2d solver.  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
316  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dTargetResWunit
317    C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
318    C     cg3dTargetResidual
319    C               :: Target residual for cg3d solver.
320    C     cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
321  C     Note. 20th May 1998  C     Note. 20th May 1998
322  C           I made a weird discovery! In the model paper we argue  C           I made a weird discovery! In the model paper we argue
323  C           for the form of the preconditioner used here ( see  C           for the form of the preconditioner used here ( see
# Line 131  C           number of iterations for con Line 331  C           number of iterations for con
331  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
332  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
333  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
334  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     delP      :: Vertical grid spacing ( Pa ).
335  C                 between "w" surfaces.  C     delZ      :: Vertical grid spacing ( m  ).
336  C     delX      - Separation between cell faces (m) or (deg), depending  C     delR      :: Vertical grid spacing ( units of r ).
337    C     delRc     :: Vertical grid spacing between cell centers (r unit).
338    C     delX      :: Separation between cell faces (m) or (deg), depending
339  C     delY        on input flags.  C     delY        on input flags.
340  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
341  C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )  C     recip_gravity and its inverse
342  C     ronil     - Reference density  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
343  C     startTime - Start time for model ( s )  C     rhoNil    :: Reference density for the linear equation of state
344  C     phiMin    - Latitude of southern most cell face.  C     rhoConst  :: Vertically constant reference density
345  C     thetaMin  - Longitude of western most cell face (this  C     rhoConstFresh :: Constant reference density for fresh water (rain)
346    C     startTime :: Start time for model ( s )
347    C     phiMin    :: Latitude of southern most cell face.
348    C     thetaMin  :: Longitude of western most cell face (this
349  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
350  C                 to make geographical references simple.)  C                 to make geographical references simple.)
351  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).
352  C     f0        - Reference coriolis parameter ( 1/s )  C     recip_RSphere  :: Reciprocal radius of sphere ( m ).
353    C     f0        :: Reference coriolis parameter ( 1/s )
354  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
355  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
356  C     viscAh    - Eddy viscosity coeff. for mixing of  C     omega     :: Angular velocity ( rad/s )
357    C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
358    C     viscAh    :: Eddy viscosity coeff. for mixing of
359  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
360  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    :: Eddy viscosity coeff. for mixing of
361  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
362  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscAp    :: Eddy viscosity coeff. for mixing of
363    C                 momentum vertically ( Pa^2/s )
364    C     viscAr    :: Eddy viscosity coeff. for mixing of
365    C                 momentum vertically ( units of r^2/s )
366    C     viscA4    :: Biharmonic viscosity coeff. for mixing of
367  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
368  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
369  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
370  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   :: Laplacian diffusion coeff. for mixing of
371  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
372  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffKpT   :: Laplacian diffusion coeff. for mixing of
373    C                 heat vertically ( Pa^2/s )
374    C     diffKrT   :: Laplacian diffusion coeff. for mixing of
375    C                 heat vertically ( units of r^2/s )
376    C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
377  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
378  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
379  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
380  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   :: Laplacian diffusion coeff. for mixing of
381  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
382  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffKpS   :: Laplacian diffusion coeff. for mixing of
383    C                 salt vertically ( Pa^2/s )
384    C     diffKrS   :: Laplacian diffusion coeff. for mixing of
385    C                 salt vertically ( units of r^2/s )
386    C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
387  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
388  C     deltaT    - Default timestep ( s )  C     deltaT    :: Default timestep ( s )
389  C     deltaTClock  - Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
390  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
391  C                    be totally different to the dynamical time. Typically  C                    be totally different to the dynamical time. Typically
392  C                    it will be the deep-water timestep for accelerated runs.  C                    it will be the deep-water timestep for accelerated runs.
393  C                    Frequency of checkpointing and dumping of the model state  C                    Frequency of checkpointing and dumping of the model state
394  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
395  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
396  C     deltaTtracer - Timestep for tracer equations ( s )  C     deltaTtracer :: Timestep for tracer equations ( s )
397  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
398    C     freesurfFac  :: Parameter to turn implicit free surface term on or off
399  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
400  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
401  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
402  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
403  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
404  C     GMlength  - Length to use in Visbeck et al. formula for K (m)  C                     Implicit part of barotropic flow Divergence ( 0-1 )
405  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
406  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)
407  C     GMkbackground - background value of GM/Redi coefficient  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
408  C     startTime - Starting time for this integration ( s ).  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
409  C     endTime   - Ending time for this integration ( s ).  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
410  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     hFacSup        that control vanishing and creating levels
411  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     tauCD        :: CD scheme coupling timescale ( 1/s )
412  C     dumpFreq  - Frequency with which model state is written to  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
413  C                 post-processing files ( s ).  C     startTime     :: Starting time for this integration ( s ).
414  C     afFacMom  - Advection of momentum term scaling parameter  C     endTime       :: Ending time for this integration ( s ).
415  C     vfFacMom  - Momentum viscosity scaling parameter  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
416  C     pfFacMom  - Momentum pressure forcing parameter  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
417  C     cfFacMom  - Coriolis term scaling parameter  C     dumpFreq      :: Frequency with which model state is written to
418  C     foFacMom  - Momentum forcing scaling parameter  C                     post-processing files ( s ).
419  C     cAdjFreq  - Frequency of convective adjustment  C     diagFreq      :: Frequency with which model writes diagnostic output
420        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,  C                     of intermediate quantities.
421       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,  C     afFacMom      :: Advection of momentum term tracer parameter
422       & thetaMin, rSphere, f0, fCori, beta, viscAh, viscAz, viscA4,  C     vfFacMom      :: Momentum viscosity tracer parameter
423       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,  C     pfFacMom      :: Momentum pressure forcing tracer parameter
424       & tauCD, rCD, freeSurfFac,  C     cfFacMom      :: Coriolis term tracer parameter
425       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,  C     foFacMom      :: Momentum forcing tracer parameter
426       & gravity, gBaro, rhonil, tRef, sRef,  C     mtFacMom      :: Metric terms tracer parameter
427    C     cosPower      :: Power of cosine of latitude to multiply viscosity
428    C     cAdjFreq      :: Frequency of convective adjustment
429    C
430    C     taveFreq      :: Frequency with which time-averaged model state
431    C                      is written to post-processing files ( s ).
432    C     tave_lastIter :: (for state variable only) fraction of the last time
433    C                      step (of each taveFreq period) put in the time average.
434    C                      (fraction for 1rst iter = 1 - tave_lastIter)
435    C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
436    C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
437    C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
438    C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
439    C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
440    C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
441    C                          (note: externForcingCycle must be an integer
442    C                           number times externForcingPeriod)
443    C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
444    C                       (use model surface (local) value if set to -1)
445    C     temp_EvPrRn :: temperature of Rain & Evap.
446    C     salt_EvPrRn :: salinity of Rain & Evap.
447    C     trac_EvPrRn :: tracer concentration in Rain & Evap.
448    C        (notes: a) tracer content of Rain/Evap only used if both
449    C                     NonLin_FrSurf & useRealFreshWater are set.
450    C                b) use model surface (local) value if set to UNSET_RL)
451    C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.
452    C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
453    C                          ( g*rho if horiz in m and vertical in Pa ).
454    C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as
455    C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
456    C     bottomDragLinear   :: Drag coefficient built in to core dynamics
457    C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
458          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
459         & cg2dpcOffDFac, cg3dTargetResidual,
460         & delP, delZ, delR, delRc, delX, delY,
461         & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
462         & abeps, startTime,
463         & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
464         & fCori, fCoriG, fCoriCos,
465         & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,
466         & diffKhT, diffKzT, diffK4T, diffKrT,
467         & diffKhS, diffKzS, diffK4S, diffKrS,
468         & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
469         & hFacMin, hFacMinDz, hFacInf, hFacSup,
470         & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
471         & recip_rhoConst, rhoConst,
472         & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
473       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
474       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom,       & diagFreq, taveFreq, tave_lastIter, monitorFreq,
475       & cAdjFreq       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
476         & cosPower, cAdjFreq, omega, rotationPeriod,
477         & tauThetaClimRelax, lambdaThetaClimRelax,
478         & tauSaltClimRelax, lambdaSaltClimRelax,
479         & tauTr1ClimRelax, lambdaTr1ClimRelax,
480         & externForcingCycle, externForcingPeriod,
481         & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
482         & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
483         & horiVertRatio, recip_horiVertRatio,
484         & ivdc_kappa, Ro_SeaLevel,
485         & bottomDragLinear,bottomDragQuadratic
486    
487        _RL cg2dTargetResidual        _RL cg2dTargetResidual
488          _RL cg2dTargetResWunit
489          _RL cg3dTargetResidual
490        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
491        _RL delZ(Nz)        _RL delZ(Nr)
492          _RL delP(Nr)
493          _RL delR(Nr)
494          _RL delRc(Nr+1)
495        _RL delX(Nx)        _RL delX(Nx)
496        _RL delY(Ny)        _RL delY(Ny)
497        _RL deltaT        _RL deltaT
498        _RL deltaTClock        _RL deltaTClock
499        _RL deltaTmom        _RL deltaTmom
500        _RL deltaTtracer        _RL deltaTtracer
501          _RL deltaTfreesurf
502        _RL abeps        _RL abeps
503        _RL phiMin        _RL phiMin
504        _RL thetaMin        _RL thetaMin
505        _RL rSphere        _RL rSphere
506          _RL recip_RSphere
507        _RL f0        _RL f0
508        _RL freeSurfFac        _RL freeSurfFac
509          _RL implicSurfPress
510          _RL implicDiv2Dflow
511          _RL hFacMin
512          _RL hFacMinDz
513          _RL hFacMinDp
514          _RL hFacMinDr
515          _RL hFacInf
516          _RL hFacSup
517        _RL beta        _RL beta
518        _RL viscAh        _RL viscAh
519          _RL viscAstrain
520          _RL viscAtension
521        _RL viscAz        _RL viscAz
522          _RL viscAp
523          _RL viscAr
524        _RL viscA4        _RL viscA4
525        _RL diffKhT        _RL diffKhT
526          _RL diffKrT
527        _RL diffKzT        _RL diffKzT
528          _RL diffKpT
529        _RL diffK4T        _RL diffK4T
530        _RL diffKhS        _RL diffKhS
531          _RL diffKrS
532        _RL diffKzS        _RL diffKzS
533          _RL diffKpS
534        _RL diffK4S        _RL diffK4S
535        _RL delt        _RL delt
536        _RL tauCD        _RL tauCD
537        _RL rCD        _RL rCD
       _RL GMmaxslope  
       _RL GMlength  
       _RL GMalpha  
       _RL GMdepth  
       _RL GMkbackground  
538        _RL gravity        _RL gravity
539          _RL recip_gravity
540        _RL gBaro        _RL gBaro
541        _RL rhonil        _RL rhonil
542        _RL tRef(Nz)        _RL recip_rhonil
543        _RL sRef(Nz)        _RL rhoConst
544        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL recip_rhoConst
545          _RL rhoConstFresh
546          _RL convertEmP2rUnit
547          _RL tRef(Nr)
548          _RL sRef(Nr)
549          _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
550          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
551          _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
552        _RL startTime        _RL startTime
553        _RL endTime        _RL endTime
554        _RL chkPtFreq        _RL chkPtFreq
555        _RL pChkPtFreq        _RL pChkPtFreq
556        _RL dumpFreq        _RL dumpFreq
557          _RL diagFreq
558          _RL taveFreq
559          _RL tave_lastIter
560          _RL monitorFreq
561        _RL afFacMom        _RL afFacMom
562        _RL vfFacMom        _RL vfFacMom
563        _RL pfFacMom        _RL pfFacMom
564        _RL cfFacMom        _RL cfFacMom
565        _RL foFacMom        _RL foFacMom
566          _RL mTFacMom
567          _RL cosPower
568        _RL cAdjFreq        _RL cAdjFreq
569          _RL omega
570          _RL rotationPeriod
571          _RL tauThetaClimRelax
572          _RL lambdaThetaClimRelax
573          _RL tauSaltClimRelax
574          _RL lambdaSaltClimRelax
575          _RL tauTr1ClimRelax
576          _RL lambdaTr1ClimRelax
577          _RL externForcingCycle
578          _RL externForcingPeriod
579          _RL convertFW2Salt
580          _RL temp_EvPrRn
581          _RL salt_EvPrRn
582          _RL trac_EvPrRn
583          _RL horiVertRatio
584          _RL recip_horiVertRatio
585          _RL ivdc_kappa
586          _RL Ro_SeaLevel
587          _RL bottomDragLinear
588          _RL bottomDragQuadratic
589    
590        COMMON /PARM_A/ HeatCapacity_Cp,  C--   COMMON /PARM_A/ Thermodynamics constants ?
591       &                Lamba_theta        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
592        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
593        _RL Lamba_theta        _RL recip_Cp
594    
595  C Equation of State (polynomial coeffients)  C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
596        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS  C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
597        _RL eosC(9,Nz+1),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)  C     atm_Po    :: standard reference pressure
598  C Linear equation of state  C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
599  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     atm_Rd    :: gas constant for dry air
600  C     sBeta     - Linear EOS haline contraction coefficient.  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
601        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType  C     integr_GeoPot :: option to select the way we integrate the geopotential
602        _RL tAlpha  C                     (still a subject of discussions ...)
603        _RL sBeta  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
604        character*(6) eosType  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
605          COMMON /PARM_ATM/
606         &            celsius2K,
607         &            atm_Cp, atm_Rd, atm_kappa, atm_Po,
608         &            integr_GeoPot, selectFindRoSurf
609          _RL celsius2K
610          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa
611          INTEGER integr_GeoPot, selectFindRoSurf
612    
613    C Logical flags for selecting packages
614          LOGICAL useKPP
615          LOGICAL useGMRedi
616          LOGICAL useOBCS
617          LOGICAL useAIM
618          LOGICAL useLand
619          LOGICAL useGrdchk
620          LOGICAL useECCO
621          LOGICAL useSHAP_FILT
622          LOGICAL useZONAL_FILT
623          LOGICAL useFLT
624          LOGICAL usePTRACERS
625          LOGICAL useSBO
626          LOGICAL useSEAICE
627    cswdblk -- add ---
628          LOGICAL useBulkforce
629          LOGICAL useThermSEAICE
630    cswdblk --- end add ---
631          COMMON /PARM_PACKAGES/
632         &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
633         &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
634         &        usePTRACERS,  useSBO, useSEAICE,
635    cswdblk -- add ---
636         &        useThermSEAICE, useBulkforce
637    cswdblk --- end add ---
Legend:
Removed from v.1.12  
changed lines
  Added in v.1.65.4.4
  ViewVC Help
Powered by ViewVC 1.1.22