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