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

Legend:
Removed from v.1.200  
changed lines
  Added in v.1.271

  ViewVC Help
Powered by ViewVC 1.1.22