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

Legend:
Removed from v.1.142  
changed lines
  Added in v.1.282

  ViewVC Help
Powered by ViewVC 1.1.22