/[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.168 by jmc, Wed Sep 28 01:34:01 2005 UTC revision 1.281 by jmc, Mon Jan 11 22:48:22 2016 UTC
# Line 14  C     here. Notes describing the paramet Line 14  C     here. Notes describing the paramet
14    
15  CEOP  CEOP
16    
 C     Macros for special grid options  
 #include "PARAMS_MACROS.h"  
   
17  C--   Contants  C--   Contants
18  C     Useful physical values  C     Useful physical values
19        Real*8 PI        Real*8 PI
# Line 24  C     Useful physical values Line 21  C     Useful physical values
21        Real*8 deg2rad        Real*8 deg2rad
22        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
23    
 C     Symbolic values  
 C     precXXXX :: Used to indicate what precision to use for  
 C                dumping model state.  
       INTEGER precFloat32  
       PARAMETER ( precFloat32 = 32 )  
       INTEGER precFloat64  
       PARAMETER ( precFloat64 = 64 )  
 C     UNSET_xxx :: Used to indicate variables that have not been given a value  
       Real*8 UNSET_FLOAT8  
       PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )  
       Real*4 UNSET_FLOAT4  
       PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )  
       _RL    UNSET_RL      
       PARAMETER ( UNSET_RL     = 1.234567D5 )  
       _RS    UNSET_RS      
       PARAMETER ( UNSET_RS     = 1.234567E5 )  
       INTEGER UNSET_I  
       PARAMETER ( UNSET_I      = 123456789  )  
   
 C     Checkpoint data  
       INTEGER maxNoChkptLev  
       PARAMETER ( maxNoChkptLev = 2 )  
   
24  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
25  C     checkPtSuff :: List of checkpoint file suffices  C     buoyancyRelation :: Flag used to indicate which relation to use to
26    C                         get buoyancy.
27    C     eosType         :: choose the equation of state:
28    C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
29    C     pickupSuff      :: force to start from pickup files (even if nIter0=0)
30    C                        and read pickup files with this suffix (max 10 Char.)
31    C     mdsioLocalDir   :: read-write tiled file from/to this directory name
32    C                        (+ 4 digits Processor-Rank) instead of current dir.
33    C     adTapeDir       :: read-write checkpointing tape files from/to this
34    C                        directory name instead of current dir. Conflicts
35    C                        mdsioLocalDir, so only one of the two can be set.
36    C                        In contrast to mdsioLocalDir, if specified adTapeDir
37    C                        must exist before the model starts.
38    C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
39    C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
40    C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
41    C     delRFile      :: File containing vertical grid spacing delR  (1.D array)
42    C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)
43    C     hybSigmFile   :: File containing hybrid-sigma vertical coord. coeff. (2x 1.D)
44  C     delXFile      :: File containing X-spacing grid definition (1.D array)  C     delXFile      :: File containing X-spacing grid definition (1.D array)
45  C     delYFile      :: File containing Y-spacing grid definition (1.D array)  C     delYFile      :: File containing Y-spacing grid definition (1.D array)
46  C     horizGridFile :: File containing horizontal-grid definition  C     horizGridFile :: File containing horizontal-grid definition
47  C                        (only when using curvilinear_grid)  C                        (only when using curvilinear_grid)
48  C     bathyFile   :: File containing bathymetry. If not defined bathymetry  C     bathyFile       :: File containing bathymetry. If not defined bathymetry
49  C                   is taken from inline function.  C                        is taken from inline function.
50  C     topoFile    :: File containing the topography of the surface (unit=m)  C     topoFile        :: File containing the topography of the surface (unit=m)
51  C                   (mainly used for the atmosphere = ground height).  C                        (mainly used for the atmosphere = ground height).
52  C     hydrogThetaFile :: File containing initial hydrographic data for potential  C     addWwallFile    :: File containing 2-D additional Western  cell-edge wall
53  C                       temperature.  C     addSwallFile    :: File containing 2-D additional Southern cell-edge wall
54  C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.  C                        (e.g., to add "thin-wall" where it is =1)
55    C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
56    C                        for potential temperature.
57    C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
58    C                        for salinity.
59    C     diffKrFile      :: File containing 3D specification of vertical diffusivity
60    C     viscAhDfile     :: File containing 3D specification of horizontal viscosity
61    C     viscAhZfile     :: File containing 3D specification of horizontal viscosity
62    C     viscA4Dfile     :: File containing 3D specification of horizontal viscosity
63    C     viscA4Zfile     :: File containing 3D specification of horizontal viscosity
64  C     zonalWindFile   :: File containing zonal wind data  C     zonalWindFile   :: File containing zonal wind data
65  C     meridWindFile   :: File containing meridional wind data  C     meridWindFile   :: File containing meridional wind data
66  C     thetaClimFile   :: File containing theta climataology used  C     thetaClimFile   :: File containing surface theta climataology used
67  C                       in relaxation term -lambda(theta-theta*)  C                        in relaxation term -lambda(theta-theta*)
68  C     saltClimFile    :: File containing salt climataology used  C     saltClimFile    :: File containing surface salt climataology used
69  C                       in relaxation term -lambda(salt-salt*)  C                        in relaxation term -lambda(salt-salt*)
70  C     surfQfile       :: File containing surface heat flux, excluding SW  C     surfQfile       :: File containing surface heat flux, excluding SW
71  C                        (old version, kept for backward compatibility)  C                        (old version, kept for backward compatibility)
72  C     surfQnetFile    :: File containing surface net heat flux  C     surfQnetFile    :: File containing surface net heat flux
73  C     surfQswFile     :: File containing surface shortwave radiation  C     surfQswFile     :: File containing surface shortwave radiation
 C     dQdTfile        :: File containing thermal relaxation coefficient  
74  C     EmPmRfile       :: File containing surface fresh water flux  C     EmPmRfile       :: File containing surface fresh water flux
75    C           NOTE: for backward compatibility EmPmRfile is specified in
76    C                 m/s when using external_fields_load.F.  It is converted
77    C                 to kg/m2/s by multiplying by rhoConstFresh.
78  C     saltFluxFile    :: File containing surface salt flux  C     saltFluxFile    :: File containing surface salt flux
79  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
80  C     eddyTauxFile    :: File containing zonal Eddy stress data  C     addMassFile     :: File containing source/sink of fluid in the interior
81  C     eddyTauyFile    :: File containing meridional Eddy stress data  C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data
82  C     buoyancyRelation :: Flag used to indicate which relation to use to  C     eddyPsiYFile    :: File containing meridional Eddy streamfunction data
 C                        get buoyancy.  
 C     eosType         :: choose the equation of state:  
 C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS  
83  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
84        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/
85         &                buoyancyRelation, eosType,
86         &                pickupSuff, mdsioLocalDir, adTapeDir,
87         &                tRefFile, sRefFile, rhoRefFile,
88         &                delRFile, delRcFile, hybSigmFile,
89       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
90       &                bathyFile, topoFile,       &                bathyFile, topoFile, addWwallFile, addSwallFile,
91       &                hydrogThetaFile, hydrogSaltFile,       &                viscAhDfile, viscAhZfile,
92         &                viscA4Dfile, viscA4Zfile,
93         &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
94       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
95       &                saltClimFile, buoyancyRelation,       &                saltClimFile,
96       &                EmPmRfile, saltFluxFile,       &                EmPmRfile, saltFluxFile,
97       &                surfQfile, surfQnetFile, surfQswFile,       &                surfQfile, surfQnetFile, surfQswFile,
98       &                lambdaThetaFile, lambdaSaltFile,       &                lambdaThetaFile, lambdaSaltFile,
99       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
100       &                dQdTfile, ploadFile,       &                pLoadFile, addMassFile,
101       &                eddyTauxFile, eddyTauyFile,       &                eddyPsiXFile, eddyPsiYFile, geothermalFile,
      &                eosType, pickupSuff,  
      &                mdsioLocalDir,  
102       &                the_run_name       &                the_run_name
103        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
104          CHARACTER*(6)  eosType
105          CHARACTER*(10) pickupSuff
106          CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
107          CHARACTER*(MAX_LEN_FNAM) adTapeDir
108          CHARACTER*(MAX_LEN_FNAM) tRefFile
109          CHARACTER*(MAX_LEN_FNAM) sRefFile
110          CHARACTER*(MAX_LEN_FNAM) rhoRefFile
111          CHARACTER*(MAX_LEN_FNAM) delRFile
112          CHARACTER*(MAX_LEN_FNAM) delRcFile
113          CHARACTER*(MAX_LEN_FNAM) hybSigmFile
114        CHARACTER*(MAX_LEN_FNAM) delXFile        CHARACTER*(MAX_LEN_FNAM) delXFile
115        CHARACTER*(MAX_LEN_FNAM) delYFile        CHARACTER*(MAX_LEN_FNAM) delYFile
116        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
117        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
118        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) addWwallFile, addSwallFile
119        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
120          CHARACTER*(MAX_LEN_FNAM) diffKrFile
121          CHARACTER*(MAX_LEN_FNAM) viscAhDfile
122          CHARACTER*(MAX_LEN_FNAM) viscAhZfile
123          CHARACTER*(MAX_LEN_FNAM) viscA4Dfile
124          CHARACTER*(MAX_LEN_FNAM) viscA4Zfile
125        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
126        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
127        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
# Line 112  C     the_run_name    :: string identify Line 131  C     the_run_name    :: string identify
131        CHARACTER*(MAX_LEN_FNAM) surfQswFile        CHARACTER*(MAX_LEN_FNAM) surfQswFile
132        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
133        CHARACTER*(MAX_LEN_FNAM) saltFluxFile        CHARACTER*(MAX_LEN_FNAM) saltFluxFile
       CHARACTER*(MAX_LEN_FNAM) buoyancyRelation  
134        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
135        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
136        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
137        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) pLoadFile
138        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) addMassFile
139        CHARACTER*(MAX_LEN_FNAM) eddyTauxFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile
140        CHARACTER*(MAX_LEN_FNAM) eddyTauyFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile
141          CHARACTER*(MAX_LEN_FNAM) geothermalFile
142        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
143        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
144        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_PREC/2) the_run_name
       CHARACTER*(MAX_LEN_FNAM) the_run_name  
       CHARACTER*(6) eosType  
       CHARACTER*(10) pickupSuff  
145    
146  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
147  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
148  C                           two-dimensional con. grad solver.  C                            two-dimensional con. grad solver.
149  C     cg2dChkResFreq      :: Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
150  C                           in con. grad solver.  C                            in con. grad solver.
151  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
152  C                            (non-linear free-surf.)  C                            (non-linear free-surf.)
153    C     cg2dUseMinResSol    :: =0 : use last-iteration/converged solution
154    C                            =1 : use solver minimum-residual solution
155  C     cg3dMaxIters        :: Maximum number of iterations in the  C     cg3dMaxIters        :: Maximum number of iterations in the
156  C                           three-dimensional con. grad solver.  C                            three-dimensional con. grad solver.
157  C     cg3dChkResFreq      :: Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
158  C                           in con. grad solver.  C                            in con. grad solver.
159    C     printResidualFreq   :: Frequency for printing residual in CG iterations
160  C     nIter0              :: Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
161  C     nTimeSteps          :: Number of timesteps to execute  C     nTimeSteps          :: Number of timesteps to execute
162  C     numStepsPerPickup   :: For offline setup. Frequency of pickup  C     nTimeSteps_l2       :: Number of inner timesteps to execute per timestep
 C                           of flow fields.  
163  C     writeStatePrec      :: Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
164  C     writeBinaryPrec     :: Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
165  C     readBinaryPrec      :: Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
166  C     nCheckLev           :: Holds current checkpoint level  C     selectCoriMap       :: select setting of Coriolis parameter map:
167    C                           =0 f-Plane (Constant Coriolis, = f0)
168    C                           =1 Beta-Plane Coriolis (= f0 + beta.y)
169    C                           =2 Spherical Coriolis (= 2.omega.sin(phi))
170    C                           =3 Read Coriolis 2-d fields from files.
171    C     selectSigmaCoord    :: option related to sigma vertical coordinate
172  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
173  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
174  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
175  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
176    C     selectNHfreeSurf    :: option for Non-Hydrostatic (free-)Surface formulation:
177    C                           =0 (default) hydrostatic surf. ; > 0 add NH effects.
178    C     selectAddFluid      :: option to add mass source/sink of fluid in the interior
179    C                            (3-D generalisation of oceanic real-fresh water flux)
180    C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
181    C     momForcingOutAB     :: =1: take momentum forcing contribution
182    C                            out of (=0: in) Adams-Bashforth time stepping.
183    C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
184    C                            out of (=0: in) Adams-Bashforth time stepping.
185  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
186  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
187  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
188  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
189  C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)  C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)
190  C     debugLevel          :: debug level selector: higher -> more writing  C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)
191    C     selectBotDragQuadr  :: quadratic bottom drag discretisation option:
192    C                           =0: average KE from grid center to U & V location
193    C                           =1: use local velocity norm @ U & V location
194    C                           =2: same with wet-point averaging of other component
195    C     monitorSelect       :: select group of variables to monitor
196    C                            =1 : dynvars ; =2 : + vort ; =3 : + surface
197    C-    debugLevel          :: controls printing of algorithm intermediate results
198    C                            and statistics ; higher -> more writing
199    
200        COMMON /PARM_I/        COMMON /PARM_I/
201       &        cg2dMaxIters,       &        cg2dMaxIters, cg2dChkResFreq,
202       &        cg2dChkResFreq, cg2dPreCondFreq,       &        cg2dPreCondFreq, cg2dUseMinResSol,
203       &        cg3dMaxIters,       &        cg3dMaxIters, cg3dChkResFreq,
204       &        cg3dChkResFreq,       &        printResidualFreq,
205       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nTimeSteps_l2, nEndIter,
206       &        numStepsPerPickup,       &        writeStatePrec,
      &        writeStatePrec, nCheckLev,  
207       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
208         &        selectCoriMap,
209         &        selectSigmaCoord,
210       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
211         &        selectNHfreeSurf,
212         &        selectAddFluid,
213         &        momForcingOutAB, tracForcingOutAB,
214       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
215       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
216       &        selectKEscheme,       &        selectKEscheme, selectVortScheme,
217       &        debugLevel       &        selectBotDragQuadr,
218         &        monitorSelect, debugLevel
219        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
220        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
221        INTEGER cg2dPreCondFreq        INTEGER cg2dPreCondFreq
222          INTEGER cg2dUseMinResSol
223        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
224        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
225          INTEGER printResidualFreq
226        INTEGER nIter0        INTEGER nIter0
227        INTEGER nTimeSteps        INTEGER nTimeSteps
228          INTEGER nTimeSteps_l2
229        INTEGER nEndIter        INTEGER nEndIter
       INTEGER numStepsPerPickup  
230        INTEGER writeStatePrec        INTEGER writeStatePrec
231        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
232        INTEGER readBinaryPrec        INTEGER readBinaryPrec
233        INTEGER nCheckLev        INTEGER selectCoriMap
234          INTEGER selectSigmaCoord
235        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
236        INTEGER select_rStar        INTEGER select_rStar
237          INTEGER selectNHfreeSurf
238          INTEGER selectAddFluid
239          INTEGER momForcingOutAB, tracForcingOutAB
240        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
241        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
242        INTEGER selectKEscheme        INTEGER selectKEscheme
243          INTEGER selectVortScheme
244          INTEGER selectBotDragQuadr
245          INTEGER monitorSelect
246        INTEGER debugLevel        INTEGER debugLevel
247    
 C  
       INTEGER debLevZero  
       PARAMETER(debLevZero=0)  
       INTEGER debLevA  
       PARAMETER(debLevA=1)  
       INTEGER debLevB  
       PARAMETER(debLevB=2)  
   
248  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
249    C- Coordinate + Grid params:
250    C     fluidIsAir       :: Set to indicate that the fluid major constituent
251    C                         is air
252    C     fluidIsWater     :: Set to indicate that the fluid major constituent
253    C                         is water
254    C     usingPCoords     :: Set to indicate that we are working in a pressure
255    C                         type coordinate (p or p*).
256    C     usingZCoords     :: Set to indicate that we are working in a height
257    C                         type coordinate (z or z*)
258    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
259    C                         this requires specific code for restart & exchange
260  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
261  C                          coordinate frame.  C                           coordinate frame.
262  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
263  C                               spherical polar frame.  C                                spherical polar frame.
264    C     rotateGrid      :: rotate grid coordinates to geographical coordinates
265    C                        according to Euler angles phiEuler, thetaEuler, psiEuler
266  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
267  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
268    C     hasWetCSCorners :: domain contains CS-type corners where dynamics is solved
269    C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
270    C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
271    C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
272    C- Momentum params:
273    C     no_slip_sides  :: Impose "no-slip" at lateral boundaries.
274  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
275  C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V  C     bottomVisc_pCell :: account for partial-cell in bottom visc. (no-slip BC)
276    C     useSmag3D      :: Use isotropic 3-D Smagorinsky
277    C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
278    C                       on irregular grids)
279    C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
280    C     useAreaViscLength :: Set to true to use old scaling for viscous lengths,
281    C                          e.g., L2=Raz.  May be preferable for cube sphere.
282  C     momViscosity  :: Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
283  C     momAdvection  :: Flag which turns advection of momentum on and off.  C     momAdvection  :: Flag which turns advection of momentum on and off.
284  C     momForcing    :: Flag which turns external forcing of momentum on  C     momForcing    :: Flag which turns external forcing of momentum on
285  C                     and off.  C                      and off.
286  C     momPressureForcing :: Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
287  C                          on and off.  C                          on and off.
288  C     metricTerms   :: Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
289  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
 C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.  
290  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
291  C     tempAdvection :: Flag which turns advection of temperature on  C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
 C                     and off.  
 C     tempForcing   :: Flag which turns external forcing of temperature on  
 C                     and off.  
 C     saltAdvection :: Flag which turns advection of salinity on  
 C                     and off.  
 C     saltForcing   :: Flag which turns external forcing of salinity on  
 C                     and off.  
 C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  
 C                         as a real Fresh Water (=> changes the Sea Level)  
 C                         if F, converts P+R-E to salt flux (no SL effect)  
 C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable  
 C                       on irregular grids)  
 C     useAreaViscLength :: Set to true to use old scaling for viscous  
 C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.  
 C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms  
 C     rigidLid            :: Set to true to use rigid lid  
 C     implicitFreeSurface :: Set to true to use implcit free surface  
 C     exactConserv        :: Set to true to conserve exactly the total Volume  
 C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the  
 C                           linear relation Phi_surf = Bo_surf*eta  
 C     momStepping   :: Turns momentum equation time-stepping off  
 C     tempStepping  :: Turns temperature equation time-stepping off  
 C     saltStepping  :: Turns salinity equation time-stepping off  
 C     useConstantF  :: Coriolis parameter set to f0  
 C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  
 C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  
292  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
293  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
294    C                                (default = F = use mom_fluxform package)
295    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986)
296  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
 C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny  
297  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
298  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
 C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)  
299  C     useAbsVorticity :: work with f+zeta in Coriolis terms  C     useAbsVorticity :: work with f+zeta in Coriolis terms
300    C     upwindShear     :: use 1rst order upwind interp. (V.I., vertical advection)
301    C     momStepping    :: Turns momentum equation time-stepping off
302    C     calc_wVelocity :: Turns vertical velocity calculation off
303    C- Temp. & Salt params:
304    C     tempStepping   :: Turns temperature equation time-stepping on/off
305    C     saltStepping   :: Turns salinity equation time-stepping on/off
306    C     addFrictionHeating :: account for frictional heating
307    C     tempAdvection  :: Flag which turns advection of temperature on and off.
308    C     tempVertDiff4  :: use vertical bi-harmonic diffusion for temperature
309    C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
310    C     tempForcing    :: Flag which turns external forcing of temperature on/off
311    C     saltAdvection  :: Flag which turns advection of salinity on and off.
312    C     saltVertDiff4  :: use vertical bi-harmonic diffusion for salinity
313    C     saltIsActiveTr :: Salinity  is a dynamically active tracer
314    C     saltForcing    :: Flag which turns external forcing of salinity on/off
315    C     maskIniTemp    :: apply mask to initial Pot.Temp.
316    C     maskIniSalt    :: apply mask to initial salinity
317    C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
318    C     checkIniSalt   :: check for points with identically zero initial salinity
319    C- Pressure solver related parameters (PARM02)
320    C     useSRCGSolver  :: Set to true to use conjugate gradient
321    C                       solver with single reduction (only one call of
322    C                       s/r mpi_allreduce), default is false
323    C- Time-stepping & free-surface params:
324    C     rigidLid            :: Set to true to use rigid lid
325    C     implicitFreeSurface :: Set to true to use implicit free surface
326    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
327    C                            linear relation Phi_surf = Bo_surf*eta
328    C     uniformFreeSurfLev  :: TRUE if free-surface level-index is uniform (=1)
329    C     exactConserv        :: Set to true to conserve exactly the total Volume
330    C     linFSConserveTr     :: Set to true to correct source/sink of tracer
331    C                            at the surface due to Linear Free Surface
332    C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
333    C                         as a real Fresh Water (=> changes the Sea Level)
334    C                         if F, converts P+R-E to salt flux (no SL effect)
335    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
336    C     nonHydrostatic   :: Using non-hydrostatic algorithm
337    C     use3Dsolver      :: set to true to use 3-D pressure solver
338    C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
339    C     staggerTimeStep   :: enable a Stagger time stepping U,V (& W) then T,S
340    C     applyExchUV_early :: Apply EXCH to U,V earlier, just before integr_continuity
341    C     doResetHFactors   :: Do reset thickness factors @ beginning of each time-step
342  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
343  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
344  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature  C     implBottomFriction :: Turns on implicit bottom friction (drag & no-slip BC)
345  C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity  C     tempImplVertAdv   :: Turns on implicit vertical advection for Temperature
346  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum  C     saltImplVertAdv   :: Turns on implicit vertical advection for Salinity
347    C     momImplVertAdv    :: Turns on implicit vertical advection for Momentum
348  C     multiDimAdvection :: Flag that enable multi-dimension advection  C     multiDimAdvection :: Flag that enable multi-dimension advection
349  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
350  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution  C     momDissip_In_AB   :: if False, put Dissipation tendency contribution
351  C                      out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
352  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
353    C                          apply AB on tracer tendencies (rather than on Tracer)
354    C- Other forcing params -
355    C     balanceEmPmR    :: substract global mean of EmPmR at every time step
356    C     balanceQnet     :: substract global mean of Qnet at every time step
357    C     balancePrintMean:: print substracted global means to STDOUT
358  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
359  C                        climatology is required.  C                        climatology is required.
360  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
361  C                        climatology is required.  C                        climatology is required.
362  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     balanceThetaClimRelax :: substract global mean effect at every time step
363  C     usingPCoords     :: Set to indicate that we are working in a pressure  C     balanceSaltClimRelax :: substract global mean effect at every time step
 C                        type coordinate (p or p*).  
 C     usingZCoords     :: Set to indicate that we are working in a height  
 C                        type coordinate (z or z*)  
 C     fluidIsAir       :: Set to indicate that the fluid major constituent  
 C                        is air  
 C     fluidIsWater     :: Set to indicate that the fluid major constituent  
 C                        is water  
 C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)  
 C                         this requires specific code for restart & exchange  
 C     setCenterDr    :: set cell Center depth and put Interface at the middle  
 C     nonHydrostatic :: Using non-hydrostatic terms  
 C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm  
 C     globalFiles    :: Selects between "global" and "tiled" files  
 C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  
 C                       slow (f77) or does not work (f90).  When  
 C                       useSingleCpuIO is set, mdsio_writefield.F  
 C                       outputs from master mpi process only.  
364  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
365  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     periodicExternalForcing :: Set true if forcing is time-dependant
366    C- I/O parameters -
367    C     globalFiles    :: Selects between "global" and "tiled" files.
368    C                       On some platforms with MPI, option globalFiles is either
369    C                       slow or does not work. Use useSingleCpuIO instead.
370    C     useSingleCpuIO :: moved to EEPARAMS.h
371    C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
372    C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
373    C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
374    C                           before checkpoint-54a, Jul 06, 2004.
375  C     pickup_write_mdsio :: use mdsio to write pickups  C     pickup_write_mdsio :: use mdsio to write pickups
376  C     pickup_read_mdsio  :: use mdsio to read  pickups  C     pickup_read_mdsio  :: use mdsio to read  pickups
377  C     pickup_write_immed :: echo the pickup immediately (for conversion)  C     pickup_write_immed :: echo the pickup immediately (for conversion)
378    C     writePickupAtEnd   :: write pickup at the last timestep
379  C     timeave_mdsio      :: use mdsio for timeave output  C     timeave_mdsio      :: use mdsio for timeave output
380  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
381  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
382  C     calendarDumps :: When set, approximate months (30-31 days) and years (360-372 days)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
 C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,  
 C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact  
 C                      calendar months and years.  Requires pkg/cal.  
 C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  
383  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
384        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,  C     printDomain     :: controls printing of domain fields (bathy, hFac ...).
385       & usingCurvilinearGrid, usingCylindricalGrid,  
386       & no_slip_sides,no_slip_bottom,        COMMON /PARM_L/
387       & staggerTimeStep,       & fluidIsAir, fluidIsWater,
388       & momViscosity, momAdvection, momForcing, useCoriolis,       & usingPCoords, usingZCoords, useDynP_inEos_Zc,
389       & momPressureForcing, vectorInvariantMomentum,       & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
390       & tempAdvection, tempForcing,       & usingCylindricalGrid, usingCurvilinearGrid, hasWetCSCorners,
391       & saltAdvection, saltForcing,       & deepAtmosphere, setInterFDr, setCenterDr,
392       & useRealFreshWaterFlux,       & no_slip_sides, no_slip_bottom, bottomVisc_pCell, useSmag3D,
393       & useFullLeith, useStrainTensionVisc,       & useFullLeith, useStrainTensionVisc, useAreaViscLength,
394       & useAreaViscLength,       & momViscosity, momAdvection, momForcing,
395       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & momPressureForcing, metricTerms, useNHMTerms,
396       & momStepping, tempStepping, saltStepping,       & useCoriolis, use3dCoriolis,
397       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & useCDscheme, vectorInvariantMomentum,
      & useConstantF, useBetaPlaneF, useSphereF,  
      & useCDscheme,  
398       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
399       & SadournyCoriolis, upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
400       & useAbsVorticity, upwindShear,       & useAbsVorticity, upwindShear,
401       & implicitDiffusion, implicitViscosity,       & momStepping, calc_wVelocity, tempStepping, saltStepping,
402         & addFrictionHeating,
403         & tempAdvection, tempVertDiff4, tempIsActiveTr, tempForcing,
404         & saltAdvection, saltVertDiff4, saltIsActiveTr, saltForcing,
405         & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
406         & useSRCGSolver,
407         & rigidLid, implicitFreeSurface,
408         & uniformLin_PhiSurf, uniformFreeSurfLev,
409         & exactConserv, linFSConserveTr, useRealFreshWaterFlux,
410         & quasiHydrostatic, nonHydrostatic, use3Dsolver,
411         & implicitIntGravWave, staggerTimeStep,
412         & applyExchUV_early, doResetHFactors,
413         & implicitDiffusion, implicitViscosity, implBottomFriction,
414       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
415       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,       & multiDimAdvection, useMultiDimAdvec,
416       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & momDissip_In_AB, doAB_onGtGs,
417       & periodicExternalForcing,       & balanceEmPmR, balanceQnet, balancePrintMean,
418       & fluidIsAir, fluidIsWater,       & balanceThetaClimRelax, balanceSaltClimRelax,
419       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,       & doThetaClimRelax, doSaltClimRelax,
420       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & allowFreezing,
421       & allowFreezing, useOldFreezing,       & periodicExternalForcing,
422       & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,       & globalFiles,
423         & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
424       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
425         & writePickupAtEnd,
426       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
427       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast,
428       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & printDomain
      & calendarDumps  
429    
430          LOGICAL fluidIsAir
431          LOGICAL fluidIsWater
432          LOGICAL usingPCoords
433          LOGICAL usingZCoords
434          LOGICAL useDynP_inEos_Zc
435        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
436        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid, rotateGrid
437        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
438        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid, hasWetCSCorners
439        LOGICAL usingSphericalPolarMTerms        LOGICAL deepAtmosphere
440        LOGICAL useNHMTerms        LOGICAL setInterFDr
441          LOGICAL setCenterDr
442    
443        LOGICAL no_slip_sides        LOGICAL no_slip_sides
444        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
445        LOGICAL staggerTimeStep        LOGICAL bottomVisc_pCell
446          LOGICAL useSmag3D
447          LOGICAL useFullLeith
448          LOGICAL useStrainTensionVisc
449          LOGICAL useAreaViscLength
450        LOGICAL momViscosity        LOGICAL momViscosity
451        LOGICAL momAdvection        LOGICAL momAdvection
452        LOGICAL momForcing        LOGICAL momForcing
453        LOGICAL momPressureForcing        LOGICAL momPressureForcing
       LOGICAL useCoriolis  
       LOGICAL vectorInvariantMomentum  
       LOGICAL tempAdvection  
       LOGICAL tempForcing  
       LOGICAL saltAdvection  
       LOGICAL saltForcing  
       LOGICAL useRealFreshWaterFlux  
       LOGICAL useFullLeith  
       LOGICAL useStrainTensionVisc  
       LOGICAL useAreaViscLength  
       LOGICAL rigidLid  
       LOGICAL implicitFreeSurface  
       LOGICAL exactConserv  
       LOGICAL uniformLin_PhiSurf  
       LOGICAL momStepping  
       LOGICAL tempStepping  
       LOGICAL saltStepping  
454        LOGICAL metricTerms        LOGICAL metricTerms
455        LOGICAL useConstantF        LOGICAL useNHMTerms
456        LOGICAL useBetaPlaneF  
457        LOGICAL useSphereF        LOGICAL useCoriolis
458          LOGICAL use3dCoriolis
459        LOGICAL useCDscheme        LOGICAL useCDscheme
460          LOGICAL vectorInvariantMomentum
461        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
462        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
463        LOGICAL useJamartMomAdv        LOGICAL useJamartMomAdv
       LOGICAL SadournyCoriolis  
464        LOGICAL upwindVorticity        LOGICAL upwindVorticity
465        LOGICAL highOrderVorticity        LOGICAL highOrderVorticity
466        LOGICAL useAbsVorticity        LOGICAL useAbsVorticity
467        LOGICAL upwindShear        LOGICAL upwindShear
468          LOGICAL momStepping
469          LOGICAL calc_wVelocity
470          LOGICAL tempStepping
471          LOGICAL saltStepping
472          LOGICAL addFrictionHeating
473          LOGICAL tempAdvection
474          LOGICAL tempVertDiff4
475          LOGICAL tempIsActiveTr
476          LOGICAL tempForcing
477          LOGICAL saltAdvection
478          LOGICAL saltVertDiff4
479          LOGICAL saltIsActiveTr
480          LOGICAL saltForcing
481          LOGICAL maskIniTemp
482          LOGICAL maskIniSalt
483          LOGICAL checkIniTemp
484          LOGICAL checkIniSalt
485          LOGICAL useSRCGSolver
486          LOGICAL rigidLid
487          LOGICAL implicitFreeSurface
488          LOGICAL uniformLin_PhiSurf
489          LOGICAL uniformFreeSurfLev
490          LOGICAL exactConserv
491          LOGICAL linFSConserveTr
492          LOGICAL useRealFreshWaterFlux
493          LOGICAL quasiHydrostatic
494          LOGICAL nonHydrostatic
495          LOGICAL use3Dsolver
496          LOGICAL implicitIntGravWave
497          LOGICAL staggerTimeStep
498          LOGICAL applyExchUV_early
499          LOGICAL doResetHFactors
500        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
501        LOGICAL implicitViscosity        LOGICAL implicitViscosity
502        LOGICAL tempImplVertAdv        LOGICAL implBottomFriction
503        LOGICAL saltImplVertAdv        LOGICAL tempImplVertAdv
504          LOGICAL saltImplVertAdv
505        LOGICAL momImplVertAdv        LOGICAL momImplVertAdv
506        LOGICAL multiDimAdvection        LOGICAL multiDimAdvection
507        LOGICAL useMultiDimAdvec        LOGICAL useMultiDimAdvec
508        LOGICAL forcing_In_AB        LOGICAL momDissip_In_AB
509          LOGICAL doAB_onGtGs
510          LOGICAL balanceEmPmR
511          LOGICAL balanceQnet
512          LOGICAL balancePrintMean
513        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
514        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
515        LOGICAL doTr1ClimRelax        LOGICAL balanceThetaClimRelax
516          LOGICAL balanceSaltClimRelax
517          LOGICAL allowFreezing
518        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
       LOGICAL fluidIsAir  
       LOGICAL fluidIsWater  
       LOGICAL usingPCoords  
       LOGICAL usingZCoords  
       LOGICAL useDynP_inEos_Zc  
       LOGICAL setCenterDr  
       LOGICAL nonHydrostatic  
       LOGICAL quasiHydrostatic  
519        LOGICAL globalFiles        LOGICAL globalFiles
520        LOGICAL useSingleCpuIO        LOGICAL pickupStrictlyMatch
       LOGICAL allowFreezing  
       LOGICAL useOldFreezing  
       LOGICAL usePickupBeforeC35  
521        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
522        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
       LOGICAL dumpInitAndLast  
       LOGICAL debugMode  
523        LOGICAL pickup_read_mdsio, pickup_write_mdsio        LOGICAL pickup_read_mdsio, pickup_write_mdsio
524        LOGICAL pickup_write_immed        LOGICAL pickup_write_immed, writePickupAtEnd
525        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
526        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
527        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL dumpInitAndLast
528        LOGICAL calendarDumps        LOGICAL printDomain
529    
530  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
531  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 438  C           defaults to 0.51 but can be Line 551  C           defaults to 0.51 but can be
551  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
552  C     delRc     :: Vertical grid spacing between cell centers (r unit).  C     delRc     :: Vertical grid spacing between cell centers (r unit).
553  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
554  C     delY        on input flags.  C     delY         on input flags. Note: moved to header file SET_GRID.h
555  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
556    C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
557    C                :: parameter but it makes geographical references simple.)
558    C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
559    C                :: most face (Lat-Lon grid).
560    C     gravity    :: Accel. due to gravity ( m/s^2 )
561  C     recip_gravity and its inverse  C     recip_gravity and its inverse
562  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 )
563  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil     :: Reference density for the linear equation of state
564  C     rhoConst  :: Vertically constant reference density  C     rhoConst   :: Vertically constant reference density (Boussinesq)
565    C     thetaConst :: Constant reference for potential temperature
566    C     rhoFacC    :: normalized (by rhoConst) reference density at cell-Center
567    C     rhoFacF    :: normalized (by rhoConst) reference density at cell-interFace
568  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
569  C     tRef      :: reference vertical profile for potential temperature  C     rho1Ref    :: reference vertical profile for density
570  C     sRef      :: reference vertical profile for salinity/specific humidity  C     tRef       :: reference vertical profile for potential temperature
571  C     phiMin    :: Latitude of southern most cell face.  C     sRef       :: reference vertical profile for salinity/specific humidity
572  C     thetaMin  :: Longitude of western most cell face (this  C     phiRef     :: reference potential (pressure/rho, geopotential) profile
573  C                 is an "inert" parameter but it is included  C     dBdrRef    :: vertical gradient of reference buoyancy  [(m/s/r)^2]:
574  C                 to make geographical references simple.)  C                :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
575  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).  C                :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
576  C     recip_RSphere  :: Reciprocal radius of sphere ( m ).  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
577  C     f0        :: Reference coriolis parameter ( 1/s )  C                :: from r-coordinate vertical velocity to vertical velocity [m/s].
578  C                 ( Southern edge f for beta plane )  C                :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit
579  C     beta      :: df/dy ( s^-1.m^-1 )  C     wUnit2rVel :: units conversion factor (Non-Hydrostatic code),
580  C     omega     :: Angular velocity ( rad/s )  C                :: from vertical velocity [m/s] to r-coordinate vertical velocity.
581    C                :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel
582    C     mass2rUnit :: units conversion factor (surface forcing),
583    C                :: from mass per unit area [kg/m2] to vertical r-coordinate unit.
584    C                :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ;
585    C                :: p-coord: = gravity    ( [kg/m2] *  g = [Pa] ) ;
586    C     rUnit2mass :: units conversion factor (surface forcing),
587    C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
588    C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
589    C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
590    C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
591    C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
592    C     radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
593    C     f0         :: Reference coriolis parameter ( 1/s )
594    C                   ( Southern edge f for beta plane )
595    C     beta       :: df/dy ( s^-1.m^-1 )
596    C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
597    C                   of rotation (reference value = 2.Omega.Cos(Phi))
598    C     omega      :: Angular velocity ( rad/s )
599  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
600  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
601  C                 momentum laterally ( m^2/s )  C                   for vertical mixing of momentum ( units of r^2/s )
602  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical  C     viscAh     :: Eddy viscosity coeff. for mixing of
 C                 momentum laterally, no effect for hydrostatic  
 C                 model, defaults to viscAh if unset ( m^2/s )  
 C     viscAr    :: Eddy viscosity coeff. for mixing of  
 C                 momentum vertically ( units of r^2/s )  
 C     viscA4    :: Biharmonic viscosity coeff. for mixing of  
 C                 momentum laterally ( m^4/s )  
 C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical  
 C                 momentum laterally, no effect for hydrostatic  
 C                 model, defaults to viscA4 if unset ( m^2/s )  
 C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally  
 C                  (act on Divergence part) ( m^2/s )  
 C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally  
 C                  (act on Vorticity  part) ( m^2/s )  
 C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally  
 C                  (act on Divergence part) ( m^4/s )  
 C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  
 C                  (act on Vorticity  part) ( m^4/s )  
 C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))  
 C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))  
 C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor (harmonic)  
 C     viscC4smag  :: Smagorinsky non-dimensional viscosity factor (biharmonic)  
 C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  
603  C                   momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
604  C     viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
605  C                   coeff. for mixing of momentum laterally (non-dim)  C                   momentum laterally, no effect for hydrostatic
606    C                   model, defaults to viscAhD if unset ( m^2/s )
607    C                   Not used if variable horiz. viscosity is used.
608    C     viscA4     :: Biharmonic viscosity coeff. for mixing of
609    C                   momentum laterally ( m^4/s )
610    C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
611    C                   momentum laterally, no effect for hydrostatic
612    C                   model, defaults to viscA4D if unset ( m^2/s )
613    C                   Not used if variable horiz. viscosity is used.
614    C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
615    C                   (act on Divergence part) ( m^2/s )
616    C     viscAhZ    :: Eddy viscosity coeff. for mixing of momentum laterally
617    C                   (act on Vorticity  part) ( m^2/s )
618    C     viscA4D    :: Biharmonic viscosity coeff. for mixing of momentum laterally
619    C                   (act on Divergence part) ( m^4/s )
620    C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
621    C                   (act on Vorticity  part) ( m^4/s )
622    C     smag3D_coeff :: Isotropic 3-D Smagorinsky coefficient (-)
623    C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
624    C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
625    C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
626    C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
627    C     viscC2smag   :: Smagorinsky non-dimensional viscosity factor (harmonic)
628    C     viscC4smag   :: Smagorinsky non-dimensional viscosity factor (biharmonic)
629    C     viscAhMax    :: Maximum eddy viscosity coeff. for mixing of
630    C                    momentum laterally ( m^2/s )
631    C     viscAhReMax  :: Maximum gridscale Reynolds number for eddy viscosity
632    C                     coeff. for mixing of momentum laterally (non-dim)
633    C     viscAhGrid   :: non-dimensional grid-size dependent viscosity
634  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
635  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
636  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max    :: Maximum biharmonic viscosity coeff. for mixing of
637  C                 momentum laterally ( m^4/s )  C                     momentum laterally ( m^4/s )
638  C     viscA4ReMax :: Maximum Gridscale Reynolds number for  C     viscA4ReMax  :: Maximum Gridscale Reynolds number for
639  C                  biharmonic viscosity coeff. momentum laterally (non-dim)  C                     biharmonic viscosity coeff. momentum laterally (non-dim)
640  C     viscAhGrid:: non-dimensional grid-size dependent viscosity  C     viscA4Grid   :: non-dimensional grid-size dependent bi-harmonic viscosity
 C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity  
641  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
642  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
 C     viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))  
 C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))  
643  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
644  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
 C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.  
 C                 for mixing of heat vertically ( units of r^2/s )  
645  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
646  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
647    C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
648    C                 for mixing of heat vertically ( units of r^2/s )
649    C     diffKr4T  :: vertical profile of Biharmonic diffusion coeff.
650    C                 for mixing of heat vertically ( units of r^4/s )
651  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
652  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
 C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.  
 C                 for mixing of salt vertically ( units of r^2/s ),  
653  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
654  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
655    C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
656    C                 for mixing of salt vertically ( units of r^2/s ),
657    C     diffKr4S  :: vertical profile of Biharmonic diffusion coeff.
658    C                 for mixing of salt vertically ( units of r^4/s )
659  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
660  C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979  C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
661  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
662  C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979  C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
663    C     BL79LatVary    :: polarwise of this latitude diffKrBL79 is applied with
664    C                       gradual transition to diffKrBLEQ towards Equator
665    C     diffKrBLEQsurf :: same as diffKrBL79surf but at Equator
666    C     diffKrBLEQdeep :: same as diffKrBL79deep but at Equator
667    C     diffKrBLEQscl  :: same as diffKrBL79scl but at Equator
668    C     diffKrBLEQHo   :: same as diffKrBL79Ho but at Equator
669  C     deltaT    :: Default timestep ( s )  C     deltaT    :: Default timestep ( s )
670  C     deltaTClock  :: Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
671  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
# Line 523  C                    Frequency of checkp Line 675  C                    Frequency of checkp
675  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
676  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
677  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
678  C     deltaTfreesurf :: Timestep for free-surface equation ( s )  C     deltaTFreeSurf :: Timestep for free-surface equation ( s )
679  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freeSurfFac  :: Parameter to turn implicit free surface term on or off
680  C                    freesurfac = 1. uses implicit free surface  C                     freeSurFac = 1. uses implicit free surface
681  C                    freesurfac = 0. uses rigid lid  C                     freeSurFac = 0. uses rigid lid
682  C     abEps        :: Adams-Bashforth-2 stabilizing weight  C     abEps        :: Adams-Bashforth-2 stabilizing weight
683  C     alph_AB      :: Adams-Bashforth-3 primary factor  C     alph_AB      :: Adams-Bashforth-3 primary factor
684  C     beta_AB      :: Adams-Bashforth-3 secondary factor  C     beta_AB      :: Adams-Bashforth-3 secondary factor
# Line 534  C     implicSurfPress :: parameter of th Line 686  C     implicSurfPress :: parameter of th
686  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
687  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
688  C                     Implicit part of barotropic flow Divergence ( 0-1 )  C                     Implicit part of barotropic flow Divergence ( 0-1 )
689    C     implicitNHPress :: parameter of the Crank-Nickelson time stepping :
690    C                     Implicit part of Non-Hydrostatic Pressure Gradient ( 0-1 )
691  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
692  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    :: Minimum dimensional size of a cell (affects hFacC etc..., m)
693  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    :: Minimum dimensional size of a cell (affects hFacC etc..., Pa)
694  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)  C     hFacMinDr    :: Minimum dimensional size of a cell (-> hFacC etc..., r units)
695  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
696  C     hFacSup        that control vanishing and creating levels  C     hFacSup          that control vanishing and creating levels
697  C     tauCD        :: CD scheme coupling timescale ( 1/s )  C     tauCD         :: CD scheme coupling timescale ( s )
698  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )  C     rCD           :: CD scheme normalised coupling parameter (= 1 - deltaT/tauCD)
699    C     epsAB_CD      :: Adams-Bashforth-2 stabilizing weight used in CD scheme
700  C     baseTime      :: model base time (time origin) = time @ iteration zero  C     baseTime      :: model base time (time origin) = time @ iteration zero
701  C     startTime     :: Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
702  C     endTime       :: Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
703  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
704  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
705  C     dumpFreq      :: Frequency with which model state is written to  C     dumpFreq      :: Frequency with which model state is written to
706  C                     post-processing files ( s ).  C                      post-processing files ( s ).
707  C     diagFreq      :: Frequency with which model writes diagnostic output  C     diagFreq      :: Frequency with which model writes diagnostic output
708  C                     of intermediate quantities.  C                      of intermediate quantities.
709  C     afFacMom      :: Advection of momentum term tracer parameter  C     afFacMom      :: Advection of momentum term tracer parameter
710  C     vfFacMom      :: Momentum viscosity tracer parameter  C     vfFacMom      :: Momentum viscosity tracer parameter
711  C     pfFacMom      :: Momentum pressure forcing tracer parameter  C     pfFacMom      :: Momentum pressure forcing tracer parameter
# Line 560  C     mtFacMom      :: Metric terms trac Line 715  C     mtFacMom      :: Metric terms trac
715  C     cosPower      :: Power of cosine of latitude to multiply viscosity  C     cosPower      :: Power of cosine of latitude to multiply viscosity
716  C     cAdjFreq      :: Frequency of convective adjustment  C     cAdjFreq      :: Frequency of convective adjustment
717  C  C
718  C     taveFreq      :: Frequency with which time-averaged model state  C     taveFreq      :: Frequency with which time-averaged model state
719  C                      is written to post-processing files ( s ).  C                      is written to post-processing files ( s ).
720  C     tave_lastIter :: (for state variable only) fraction of the last time  C     tave_lastIter :: (for state variable only) fraction of the last time
721  C                      step (of each taveFreq period) put in the time average.  C                      step (of each taveFreq period) put in the time average.
722  C                      (fraction for 1rst iter = 1 - tave_lastIter)  C                      (fraction for 1rst iter = 1 - tave_lastIter)
723  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
724  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
# Line 575  C                          (note: extern Line 730  C                          (note: extern
730  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
731  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
732  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
733  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
734  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
735  C        (notes: a) tracer content of Rain/Evap only used if both  C     temp_addMass :: temperature of addMass array
736    C     salt_addMass :: salinity of addMass array
737    C        (notes: a) tracer content of Rain/Evap only used if both
738  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
739  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
740  C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.  C     hMixCriteria:: criteria for mixed-layer diagnostic
741  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).  C     dRhoSmall   :: parameter for mixed-layer diagnostic
742  C                          ( g*rho if horiz in m and vertical in Pa ).  C     hMixSmooth  :: Smoothing parameter for mixed-layer diag (default=0=no smoothing)
743  C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
744  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
745  C     bottomDragLinear   :: Drag coefficient built in to core dynamics  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
746  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )  C     rSigmaBnd   :: vertical position (in r-unit) of r/sigma transition (Hybrid-Sigma)
747        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
748    C                           (default=2: full drag ; =1: gives half-slip BC)
749    C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
750    C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
751    C               (if using zcoordinate, units becomes linear: m/s, quadratic: [-])
752    C     smoothAbsFuncRange :: 1/2 of interval around zero, for which FORTRAN ABS
753    C                           is to be replace by a smoother function
754    C                           (affects myabs, mymin, mymax)
755    C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
756    C                      (i.e. allows convection at different Rayleigh numbers)
757    C     tCylIn        :: Temperature of the cylinder inner boundary
758    C     tCylOut       :: Temperature of the cylinder outer boundary
759    C     phiEuler      :: Euler angle, rotation about original z-axis
760    C     thetaEuler    :: Euler angle, rotation about new x-axis
761    C     psiEuler      :: Euler angle, rotation about new z-axis
762          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
763       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
764       & delR, delRc, delX, delY,       & delR, delRc, xgOrigin, ygOrigin,
765       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTMom, dTtracerLev, deltaTFreeSurf, deltaTClock,
766       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
767       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & rSphere, recip_rSphere, radius_fromHorizGrid,
768       & viscAh, viscAhW, viscAhMax,       & f0, beta, fPrime, omega, rotationPeriod,
769       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscFacAdj, viscAh, viscAhW, smag3D_coeff,
770         & viscAhMax, viscAhGrid, viscAhGridMax, viscAhGridMin,
771       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
772       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
773       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
774       & viscA4, viscA4W,       & viscA4, viscA4W, viscA4Max,
775       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Grid, viscA4GridMax, viscA4GridMin,
776       & viscAhRemax, viscA4Remax,       & viscAhReMax, viscA4ReMax,
777       & viscC4leith, viscC4leithD, viscAr,       & viscC4leith, viscC4leithD, viscArNr,
778       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT, diffKr4T,
779       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS, diffKr4S,
780       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
781       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & BL79LatVary,
782         & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
783         & tauCD, rCD, epsAB_CD,
784         & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
785       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
786       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_gravity, gBaro,
787       & recip_rhoConst, rhoConst,       & rhoNil, rhoConst, recip_rhoConst, thetaConst,
788       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
789       & baseTime, startTime, endTime,       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
790       & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
791         & baseTime, startTime, endTime,
792         & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
793       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
794       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
795       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq,
796       & tauThetaClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
      & tauSaltClimRelax,  
      & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,  
797       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
798       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
799       & hFacMinDr, hFacMinDp,       & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
800       & horiVertRatio, recip_horiVertRatio,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth,
801       & ivdc_kappa, Ro_SeaLevel,       & Ro_SeaLevel, rSigmaBnd,
802       & bottomDragLinear,bottomDragQuadratic,nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
803       & tCylIn, tCylOut       & smoothAbsFuncRange,
804         & tCylIn, tCylOut,
805         & phiEuler, thetaEuler, psiEuler
806    
       _RL nh_Am2  
807        _RL cg2dTargetResidual        _RL cg2dTargetResidual
808        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
809        _RL cg3dTargetResidual        _RL cg3dTargetResidual
810        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
811        _RL delR(Nr)        _RL delR(Nr)
812        _RL delRc(Nr+1)        _RL delRc(Nr+1)
813        _RL delX(Nx)        _RL xgOrigin
814        _RL delY(Ny)        _RL ygOrigin
815        _RL deltaT        _RL deltaT
816        _RL deltaTClock        _RL deltaTClock
817        _RL deltaTmom        _RL deltaTMom
818        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
819        _RL deltaTfreesurf        _RL deltaTFreeSurf
820        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
       _RL phiMin  
       _RL thetaMin  
821        _RL rSphere        _RL rSphere
822        _RL recip_RSphere        _RL recip_rSphere
823          _RL radius_fromHorizGrid
824        _RL f0        _RL f0
825          _RL beta
826          _RL fPrime
827          _RL omega
828          _RL rotationPeriod
829        _RL freeSurfFac        _RL freeSurfFac
830        _RL implicSurfPress        _RL implicSurfPress
831        _RL implicDiv2Dflow        _RL implicDiv2Dflow
832          _RL implicitNHPress
833        _RL hFacMin        _RL hFacMin
834        _RL hFacMinDz        _RL hFacMinDz
835        _RL hFacMinDp        _RL hFacMinDp
836        _RL hFacMinDr        _RL hFacMinDr
837        _RL hFacInf        _RL hFacInf
838        _RL hFacSup        _RL hFacSup
839        _RL beta        _RL viscArNr(Nr)
840          _RL viscFacAdj
841        _RL viscAh        _RL viscAh
842        _RL viscAhW        _RL viscAhW
843        _RL viscAhD        _RL viscAhD
844        _RL viscAhZ        _RL viscAhZ
845          _RL smag3D_coeff
846        _RL viscAhMax        _RL viscAhMax
847        _RL viscAhReMax        _RL viscAhReMax
848        _RL viscAhGrid        _RL viscAhGrid, viscAhGridMax, viscAhGridMin
       _RL viscAhGridMax  
       _RL viscAhGridMin  
849        _RL viscC2leith        _RL viscC2leith
850        _RL viscC2leithD        _RL viscC2leithD
851        _RL viscC2smag        _RL viscC2smag
852        _RL viscC4smag        _RL viscA4
       _RL viscAr  
       _RL viscA4  
853        _RL viscA4W        _RL viscA4W
854        _RL viscA4D        _RL viscA4D
855        _RL viscA4Z        _RL viscA4Z
# Line 679  C      --"-"--  Quadratic  ( linear: 1/s Line 858  C      --"-"--  Quadratic  ( linear: 1/s
858        _RL viscA4Grid, viscA4GridMax, viscA4GridMin        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
859        _RL viscC4leith        _RL viscC4leith
860        _RL viscC4leithD        _RL viscC4leithD
861        _RL diffKhT        _RL viscC4smag
862          _RL diffKhT
863          _RL diffK4T
864        _RL diffKrNrT(Nr)        _RL diffKrNrT(Nr)
865        _RL diffK4T        _RL diffKr4T(Nr)
866        _RL diffKhS        _RL diffKhS
867          _RL diffK4S
868        _RL diffKrNrS(Nr)        _RL diffKrNrS(Nr)
869        _RL diffK4S        _RL diffKr4S(Nr)
870        _RL diffKrBL79surf        _RL diffKrBL79surf
871        _RL diffKrBL79deep        _RL diffKrBL79deep
872        _RL diffKrBL79scl        _RL diffKrBL79scl
873        _RL diffKrBL79Ho        _RL diffKrBL79Ho
874        _RL delt        _RL BL79LatVary
875        _RL tauCD        _RL diffKrBLEQsurf
876        _RL rCD        _RL diffKrBLEQdeep
877          _RL diffKrBLEQscl
878          _RL diffKrBLEQHo
879          _RL tauCD, rCD, epsAB_CD
880        _RL gravity        _RL gravity
881        _RL recip_gravity        _RL recip_gravity
882        _RL gBaro        _RL gBaro
883        _RL rhonil        _RL rhoNil
884        _RL recip_rhonil        _RL rhoConst,      recip_rhoConst
885        _RL rhoConst        _RL thetaConst
886        _RL recip_rhoConst        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
887          _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
888        _RL rhoConstFresh        _RL rhoConstFresh
889        _RL convertEmP2rUnit        _RL rho1Ref(Nr)
890        _RL tRef(Nr)        _RL tRef(Nr)
891        _RL sRef(Nr)        _RL sRef(Nr)
892          _RL phiRef(2*Nr+1)
893          _RL dBdrRef(Nr)
894          _RL rVel2wUnit(Nr+1), wUnit2rVel(Nr+1)
895          _RL mass2rUnit, rUnit2mass
896        _RL baseTime        _RL baseTime
897        _RL startTime        _RL startTime
898        _RL endTime        _RL endTime
# Line 720  C      --"-"--  Quadratic  ( linear: 1/s Line 910  C      --"-"--  Quadratic  ( linear: 1/s
910        _RL pfFacMom        _RL pfFacMom
911        _RL cfFacMom        _RL cfFacMom
912        _RL foFacMom        _RL foFacMom
913        _RL mTFacMom        _RL mtFacMom
914        _RL cosPower        _RL cosPower
915        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
       _RL rotationPeriod  
916        _RL tauThetaClimRelax        _RL tauThetaClimRelax
917        _RL tauSaltClimRelax        _RL tauSaltClimRelax
       _RL tauTr1ClimRelax  
       _RL lambdaTr1ClimRelax  
918        _RL latBandClimRelax        _RL latBandClimRelax
919        _RL externForcingCycle        _RL externForcingCycle
920        _RL externForcingPeriod        _RL externForcingPeriod
921        _RL convertFW2Salt        _RL convertFW2Salt
922        _RL temp_EvPrRn        _RL temp_EvPrRn
923        _RL salt_EvPrRn        _RL salt_EvPrRn
924        _RL horiVertRatio        _RL temp_addMass
925        _RL recip_horiVertRatio        _RL salt_addMass
926        _RL ivdc_kappa        _RL ivdc_kappa
927          _RL hMixCriteria
928          _RL dRhoSmall
929          _RL hMixSmooth
930        _RL Ro_SeaLevel        _RL Ro_SeaLevel
931          _RL rSigmaBnd
932          _RL sideDragFactor
933        _RL bottomDragLinear        _RL bottomDragLinear
934        _RL bottomDragQuadratic        _RL bottomDragQuadratic
935        _RL tCylIn        _RL smoothAbsFuncRange
936        _RL tCylOut        _RL nh_Am2
937          _RL tCylIn, tCylOut
938          _RL phiEuler, thetaEuler, psiEuler
939    
940  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
941        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp
942        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
       _RL recip_Cp  
943    
944  C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)  C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
945  C     celsius2K :: convert centigrade (Celsius) degree to Kelvin  C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
# Line 758  C     atm_kappa :: kappa = R/Cp (R: cons Line 950  C     atm_kappa :: kappa = R/Cp (R: cons
950  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
951  C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])  C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
952  C     integr_GeoPot :: option to select the way we integrate the geopotential  C     integr_GeoPot :: option to select the way we integrate the geopotential
953  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
954  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
955  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
956        COMMON /PARM_ATM/        COMMON /PARM_ATM/
957       &            celsius2K,       &            celsius2K,
958       &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,       &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
959       &            integr_GeoPot, selectFindRoSurf       &            integr_GeoPot, selectFindRoSurf
# Line 770  C             derived from the orography Line 962  C             derived from the orography
962        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
963    
964  C Logical flags for selecting packages  C Logical flags for selecting packages
965          LOGICAL useGAD
966          LOGICAL useOBCS
967          LOGICAL useSHAP_FILT
968          LOGICAL useZONAL_FILT
969        LOGICAL useOPPS        LOGICAL useOPPS
970        LOGICAL usePP81        LOGICAL usePP81
971          LOGICAL useKL10
972        LOGICAL useMY82        LOGICAL useMY82
973        LOGICAL useGGL90        LOGICAL useGGL90
974        LOGICAL useKPP        LOGICAL useKPP
975        LOGICAL useGMRedi        LOGICAL useGMRedi
976        LOGICAL useOBCS        LOGICAL useDOWN_SLOPE
977        LOGICAL useAIM        LOGICAL useBBL
978        LOGICAL useLand        LOGICAL useCAL
979          LOGICAL useEXF
980          LOGICAL useBulkForce
981          LOGICAL useEBM
982          LOGICAL useCheapAML
983          LOGICAL useAUTODIFF
984        LOGICAL useGrdchk        LOGICAL useGrdchk
985          LOGICAL useSMOOTH
986          LOGICAL usePROFILES
987        LOGICAL useECCO        LOGICAL useECCO
988        LOGICAL useSHAP_FILT        LOGICAL useCTRL
989        LOGICAL useZONAL_FILT        LOGICAL useSBO
990        LOGICAL useFLT        LOGICAL useFLT
991        LOGICAL usePTRACERS        LOGICAL usePTRACERS
992        LOGICAL useGCHEM        LOGICAL useGCHEM
993        LOGICAL useSBO        LOGICAL useRBCS
994          LOGICAL useOffLine
995          LOGICAL useMATRIX
996          LOGICAL useFRAZIL
997        LOGICAL useSEAICE        LOGICAL useSEAICE
998        LOGICAL useBulkForce        LOGICAL useSALT_PLUME
999          LOGICAL useShelfIce
1000          LOGICAL useStreamIce
1001          LOGICAL useICEFRONT
1002        LOGICAL useThSIce        LOGICAL useThSIce
1003        LOGICAL usefizhi        LOGICAL useLand
1004        LOGICAL usegridalt        LOGICAL useATM2d
1005        LOGICAL usediagnostics        LOGICAL useAIM
1006        LOGICAL useEBM        LOGICAL useAtm_Phys
1007          LOGICAL useFizhi
1008          LOGICAL useGridAlt
1009          LOGICAL useDiagnostics
1010          LOGICAL useREGRID
1011          LOGICAL useLayers
1012        LOGICAL useMNC        LOGICAL useMNC
       LOGICAL useMATRIX  
1013        LOGICAL useRunClock        LOGICAL useRunClock
1014          LOGICAL useEMBED_FILES
1015          LOGICAL useMYPACKAGE
1016        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
1017       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
1018       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useOPPS, usePP81, useKL10, useMY82, useGGL90, useKPP,
1019       &        usePTRACERS, useGCHEM,       &        useGMRedi, useBBL, useDOWN_SLOPE,
1020       &        useSBO, useSEAICE, useThSIce, useBulkForce,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
1021       &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,       &        useGrdchk, useSMOOTH, usePROFILES, useECCO, useCTRL,
1022       &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,       &        useSBO, useFLT, useAUTODIFF,
1023       &        useRunClock       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
1024         &        useFRAZIL, useSEAICE, useSALT_PLUME, useShelfIce,
1025         &        useStreamIce, useICEFRONT, useThSIce, useLand,
1026         &        useATM2D, useAIM, useAtm_Phys, useFizhi, useGridAlt,
1027         &        useDiagnostics, useREGRID, useLayers, useMNC,
1028         &        useRunClock, useEMBED_FILES,
1029         &        useMYPACKAGE
1030    
1031  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
1032  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***

Legend:
Removed from v.1.168  
changed lines
  Added in v.1.281

  ViewVC Help
Powered by ViewVC 1.1.22