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

Legend:
Removed from v.1.203  
changed lines
  Added in v.1.280

  ViewVC Help
Powered by ViewVC 1.1.22