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

Legend:
Removed from v.1.171  
changed lines
  Added in v.1.285

  ViewVC Help
Powered by ViewVC 1.1.22