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

Legend:
Removed from v.1.193  
changed lines
  Added in v.1.273

  ViewVC Help
Powered by ViewVC 1.1.22