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