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