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