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