/[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.185 by heimbach, Wed Jun 7 01:55:12 2006 UTC revision 1.268 by jmc, Mon Apr 22 02:32:47 2013 UTC
# Line 24  C     Useful physical values Line 24  C     Useful physical values
24        Real*8 deg2rad        Real*8 deg2rad
25        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
26    
 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 )  
   
27  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
28  C     checkPtSuff :: List of checkpoint file suffices  C     buoyancyRelation :: Flag used to indicate which relation to use to
29    C                         get buoyancy.
30    C     eosType         :: choose the equation of state:
31    C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
32    C     pickupSuff      :: force to start from pickup files (even if nIter0=0)
33    C                        and read pickup files with this suffix (max 10 Char.)
34    C     mdsioLocalDir   :: read-write tiled file from/to this directory name
35    C                        (+ 4 digits Processor-Rank) instead of current dir.
36    C     adTapeDir       :: read-write checkpointing tape files from/to this
37    C                        directory name instead of current dir. Conflicts
38    C                        mdsioLocalDir, so only one of the two can be set.
39    C                        In contrast to mdsioLocalDir, if specified adTapeDir
40    C                        must exist before the model starts.
41    C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
42    C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
43    C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
44    C     delRFile      :: File containing vertical grid spacing delR  (1.D array)
45    C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)
46    C     hybSigmFile   :: File containing hybrid-sigma vertical coord. coeff. (2x 1.D)
47  C     delXFile      :: File containing X-spacing grid definition (1.D array)  C     delXFile      :: File containing X-spacing grid definition (1.D array)
48  C     delYFile      :: File containing Y-spacing grid definition (1.D array)  C     delYFile      :: File containing Y-spacing grid definition (1.D array)
49  C     horizGridFile :: File containing horizontal-grid definition  C     horizGridFile :: File containing horizontal-grid definition
50  C                        (only when using curvilinear_grid)  C                        (only when using curvilinear_grid)
51  C     bathyFile   :: File containing bathymetry. If not defined bathymetry  C     bathyFile       :: File containing bathymetry. If not defined bathymetry
52  C                   is taken from inline function.  C                        is taken from inline function.
53  C     topoFile    :: File containing the topography of the surface (unit=m)  C     topoFile        :: File containing the topography of the surface (unit=m)
54  C                   (mainly used for the atmosphere = ground height).  C                        (mainly used for the atmosphere = ground height).
55  C     shelfIceFile:: File containing the topography of the shelfice draught  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
56  C                    (unit=m)  C                        for potential temperature.
57  C     hydrogThetaFile :: File containing initial hydrographic data for potential  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
58  C                       temperature.  C                        for salinity.
59  C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.  C     diffKrFile      :: File containing 3D specification of vertical diffusivity
60    C     viscAhDfile     :: File containing 3D specification of horizontal viscosity
61    C     viscAhZfile     :: File containing 3D specification of horizontal viscosity
62    C     viscA4Dfile     :: File containing 3D specification of horizontal viscosity
63    C     viscA4Zfile     :: File containing 3D specification of horizontal viscosity
64  C     zonalWindFile   :: File containing zonal wind data  C     zonalWindFile   :: File containing zonal wind data
65  C     meridWindFile   :: File containing meridional wind data  C     meridWindFile   :: File containing meridional wind data
66  C     thetaClimFile   :: File containing theta climataology used  C     thetaClimFile   :: File containing surface theta climataology used
67  C                       in relaxation term -lambda(theta-theta*)  C                        in relaxation term -lambda(theta-theta*)
68  C     saltClimFile    :: File containing salt climataology used  C     saltClimFile    :: File containing surface salt climataology used
69  C                       in relaxation term -lambda(salt-salt*)  C                        in relaxation term -lambda(salt-salt*)
70  C     surfQfile       :: File containing surface heat flux, excluding SW  C     surfQfile       :: File containing surface heat flux, excluding SW
71  C                        (old version, kept for backward compatibility)  C                        (old version, kept for backward compatibility)
72  C     surfQnetFile    :: File containing surface net heat flux  C     surfQnetFile    :: File containing surface net heat flux
73  C     surfQswFile     :: File containing surface shortwave radiation  C     surfQswFile     :: File containing surface shortwave radiation
 C     dQdTfile        :: File containing thermal relaxation coefficient  
74  C     EmPmRfile       :: File containing surface fresh water flux  C     EmPmRfile       :: File containing surface fresh water flux
75    C           NOTE: for backward compatibility EmPmRfile is specified in
76    C                 m/s when using external_fields_load.F.  It is converted
77    C                 to kg/m2/s by multiplying by rhoConstFresh.
78  C     saltFluxFile    :: File containing surface salt flux  C     saltFluxFile    :: File containing surface salt flux
79  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
80  C     eddyTauxFile    :: File containing zonal Eddy stress data  C     addMassFile     :: File containing source/sink of fluid in the interior
81  C     eddyTauyFile    :: File containing meridional Eddy stress data  C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data
82  C     buoyancyRelation :: Flag used to indicate which relation to use to  C     eddyPsiYFile    :: File containing meridional Eddy streamfunction data
 C                        get buoyancy.  
 C     eosType         :: choose the equation of state:  
 C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS  
83  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
84        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/
85         &                buoyancyRelation, eosType,
86         &                pickupSuff, mdsioLocalDir, adTapeDir,
87         &                tRefFile, sRefFile, rhoRefFile,
88         &                delRFile, delRcFile, hybSigmFile,
89       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
90       &                bathyFile, topoFile, shelfIceFile,       &                bathyFile, topoFile,
91       &                hydrogThetaFile, hydrogSaltFile,       &                viscAhDfile, viscAhZfile,
92         &                viscA4Dfile, viscA4Zfile,
93         &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
94       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
95       &                saltClimFile, buoyancyRelation,       &                saltClimFile,
96       &                EmPmRfile, saltFluxFile,       &                EmPmRfile, saltFluxFile,
97       &                surfQfile, surfQnetFile, surfQswFile,       &                surfQfile, surfQnetFile, surfQswFile,
98       &                lambdaThetaFile, lambdaSaltFile,       &                lambdaThetaFile, lambdaSaltFile,
99       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
100       &                dQdTfile, ploadFile,       &                pLoadFile, addMassFile,
101       &                eddyTauxFile, eddyTauyFile,       &                eddyPsiXFile, eddyPsiYFile,
      &                eosType, pickupSuff,  
      &                mdsioLocalDir,  
102       &                the_run_name       &                the_run_name
103        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
104          CHARACTER*(6)  eosType
105          CHARACTER*(10) pickupSuff
106          CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
107          CHARACTER*(MAX_LEN_FNAM) adTapeDir
108          CHARACTER*(MAX_LEN_FNAM) tRefFile
109          CHARACTER*(MAX_LEN_FNAM) sRefFile
110          CHARACTER*(MAX_LEN_FNAM) rhoRefFile
111          CHARACTER*(MAX_LEN_FNAM) delRFile
112          CHARACTER*(MAX_LEN_FNAM) delRcFile
113          CHARACTER*(MAX_LEN_FNAM) hybSigmFile
114        CHARACTER*(MAX_LEN_FNAM) delXFile        CHARACTER*(MAX_LEN_FNAM) delXFile
115        CHARACTER*(MAX_LEN_FNAM) delYFile        CHARACTER*(MAX_LEN_FNAM) delYFile
116        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
117        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
118        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
119        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) diffKrFile
120          CHARACTER*(MAX_LEN_FNAM) viscAhDfile
121          CHARACTER*(MAX_LEN_FNAM) viscAhZfile
122          CHARACTER*(MAX_LEN_FNAM) viscA4Dfile
123          CHARACTER*(MAX_LEN_FNAM) viscA4Zfile
124        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
125        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
126        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
# Line 114  C     the_run_name    :: string identify Line 130  C     the_run_name    :: string identify
130        CHARACTER*(MAX_LEN_FNAM) surfQswFile        CHARACTER*(MAX_LEN_FNAM) surfQswFile
131        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
132        CHARACTER*(MAX_LEN_FNAM) saltFluxFile        CHARACTER*(MAX_LEN_FNAM) saltFluxFile
       CHARACTER*(MAX_LEN_FNAM) buoyancyRelation  
133        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
134        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
135        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
136        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) pLoadFile
137        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) addMassFile
138        CHARACTER*(MAX_LEN_FNAM) eddyTauxFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile
139        CHARACTER*(MAX_LEN_FNAM) eddyTauyFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile
140        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
141        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
142        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_PREC/2) the_run_name
       CHARACTER*(MAX_LEN_FNAM) the_run_name  
       CHARACTER*(6) eosType  
       CHARACTER*(10) pickupSuff  
143    
144  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
145  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
146  C                           two-dimensional con. grad solver.  C                            two-dimensional con. grad solver.
147  C     cg2dChkResFreq      :: Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
148  C                           in con. grad solver.  C                            in con. grad solver.
149  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
150  C                            (non-linear free-surf.)  C                            (non-linear free-surf.)
151    C     cg2dUseMinResSol    :: =0 : use last-iteration/converged solution
152    C                            =1 : use solver minimum-residual solution
153  C     cg3dMaxIters        :: Maximum number of iterations in the  C     cg3dMaxIters        :: Maximum number of iterations in the
154  C                           three-dimensional con. grad solver.  C                            three-dimensional con. grad solver.
155  C     cg3dChkResFreq      :: Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
156  C                           in con. grad solver.  C                            in con. grad solver.
157    C     printResidualFreq   :: Frequency for printing residual in CG iterations
158  C     nIter0              :: Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
159  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.  
160  C     writeStatePrec      :: Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
161  C     writeBinaryPrec     :: Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
162  C     readBinaryPrec      :: Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
163  C     nCheckLev           :: Holds current checkpoint level  C     selectCoriMap       :: select setting of Coriolis parameter map:
164    C                           =0 f-Plane (Constant Coriolis, = f0)
165    C                           =1 Beta-Plane Coriolis (= f0 + beta.y)
166    C                           =2 Spherical Coriolis (= 2.omega.sin(phi))
167    C                           =3 Read Coriolis 2-d fields from files.
168    C     selectSigmaCoord    :: option related to sigma vertical coordinate
169  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
170  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
171  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
172  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
173    C     selectNHfreeSurf    :: option for Non-Hydrostatic (free-)Surface formulation:
174    C                           =0 (default) hydrostatic surf. ; > 0 add NH effects.
175    C     selectAddFluid      :: option to add mass source/sink of fluid in the interior
176    C                            (3-D generalisation of oceanic real-fresh water flux)
177    C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
178  C     momForcingOutAB     :: =1: take momentum forcing contribution  C     momForcingOutAB     :: =1: take momentum forcing contribution
179  C                           out of (=0: in) Adams-Bashforth time stepping.  C                            out of (=0: in) Adams-Bashforth time stepping.
180  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
181  C                           out of (=0: in) Adams-Bashforth time stepping.  C                            out of (=0: in) Adams-Bashforth time stepping.
182  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
183  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
184  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
185  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
186  C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)  C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)
187  C     debugLevel          :: debug level selector: higher -> more writing  C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)
188    C     monitorSelect       :: select group of variables to monitor
189    C                            =1 : dynvars ; =2 : + vort ; =3 : + surface
190    C-    debugLevel          :: controls printing of algorithm intermediate results
191    C                            and statistics ; higher -> more writing
192    
193        COMMON /PARM_I/        COMMON /PARM_I/
194       &        cg2dMaxIters,       &        cg2dMaxIters, cg2dChkResFreq,
195       &        cg2dChkResFreq, cg2dPreCondFreq,       &        cg2dPreCondFreq, cg2dUseMinResSol,
196       &        cg3dMaxIters,       &        cg3dMaxIters, cg3dChkResFreq,
197       &        cg3dChkResFreq,       &        printResidualFreq,
198       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
199       &        numStepsPerPickup,       &        writeStatePrec,
      &        writeStatePrec, nCheckLev,  
200       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
201         &        selectCoriMap,
202         &        selectSigmaCoord,
203       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
204         &        selectNHfreeSurf,
205         &        selectAddFluid,
206       &        momForcingOutAB, tracForcingOutAB,       &        momForcingOutAB, tracForcingOutAB,
207       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
208       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
209       &        selectKEscheme,       &        selectKEscheme, selectVortScheme,
210       &        debugLevel       &        monitorSelect, debugLevel
211        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
212        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
213        INTEGER cg2dPreCondFreq        INTEGER cg2dPreCondFreq
214          INTEGER cg2dUseMinResSol
215        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
216        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
217          INTEGER printResidualFreq
218        INTEGER nIter0        INTEGER nIter0
219        INTEGER nTimeSteps        INTEGER nTimeSteps
220        INTEGER nEndIter        INTEGER nEndIter
       INTEGER numStepsPerPickup  
221        INTEGER writeStatePrec        INTEGER writeStatePrec
222        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
223        INTEGER readBinaryPrec        INTEGER readBinaryPrec
224        INTEGER nCheckLev        INTEGER selectCoriMap
225          INTEGER selectSigmaCoord
226        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
227        INTEGER select_rStar        INTEGER select_rStar
228          INTEGER selectNHfreeSurf
229          INTEGER selectAddFluid
230        INTEGER momForcingOutAB, tracForcingOutAB        INTEGER momForcingOutAB, tracForcingOutAB
231        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
232        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
233        INTEGER selectKEscheme        INTEGER selectKEscheme
234          INTEGER selectVortScheme
235          INTEGER monitorSelect
236        INTEGER debugLevel        INTEGER debugLevel
237    
 C  
       INTEGER debLevZero  
       PARAMETER(debLevZero=0)  
       INTEGER debLevA  
       PARAMETER(debLevA=1)  
       INTEGER debLevB  
       PARAMETER(debLevB=2)  
   
238  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
239    C- Coordinate + Grid params:
240    C     fluidIsAir       :: Set to indicate that the fluid major constituent
241    C                         is air
242    C     fluidIsWater     :: Set to indicate that the fluid major constituent
243    C                         is water
244    C     usingPCoords     :: Set to indicate that we are working in a pressure
245    C                         type coordinate (p or p*).
246    C     usingZCoords     :: Set to indicate that we are working in a height
247    C                         type coordinate (z or z*)
248    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
249    C                         this requires specific code for restart & exchange
250  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
251  C                          coordinate frame.  C                           coordinate frame.
252  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
253  C                               spherical polar frame.  C                                spherical polar frame.
254    C     rotateGrid      :: rotate grid coordinates to geographical coordinates
255    C                        according to Euler angles phiEuler, thetaEuler, psiEuler
256  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
257  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
258    C     hasWetCSCorners :: domain contains CS-type corners where dynamics is solved
259    C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
260    C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
261    C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
262    C- Momentum params:
263    C     no_slip_sides  :: Impose "no-slip" at lateral boundaries.
264  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
265    C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
266    C                       on irregular grids)
267    C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
268    C     useAreaViscLength :: Set to true to use old scaling for viscous lengths,
269    C                          e.g., L2=Raz.  May be preferable for cube sphere.
270  C     momViscosity  :: Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
271  C     momAdvection  :: Flag which turns advection of momentum on and off.  C     momAdvection  :: Flag which turns advection of momentum on and off.
272  C     momForcing    :: Flag which turns external forcing of momentum on  C     momForcing    :: Flag which turns external forcing of momentum on
273  C                     and off.  C                      and off.
274  C     momPressureForcing :: Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
275  C                          on and off.  C                          on and off.
276  C     metricTerms   :: Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
277  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
278  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
279  C     tempAdvection :: Flag which turns advection of temperature on  C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
 C                     and off.  
 C     tempForcing   :: Flag which turns external forcing of temperature on  
 C                     and off.  
 C     saltAdvection :: Flag which turns advection of salinity on  
 C                     and off.  
 C     saltForcing   :: Flag which turns external forcing of salinity on  
 C                     and off.  
 C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  
 C                         as a real Fresh Water (=> changes the Sea Level)  
 C                         if F, converts P+R-E to salt flux (no SL effect)  
 C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable  
 C                       on irregular grids)  
 C     useAreaViscLength :: Set to true to use old scaling for viscous  
 C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.  
 C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms  
 C     rigidLid            :: Set to true to use rigid lid  
 C     implicitFreeSurface :: Set to true to use implicit free surface  
 C     exactConserv        :: Set to true to conserve exactly the total Volume  
 C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the  
 C                           linear relation Phi_surf = Bo_surf*eta  
 C     use3Dsolver   :: set to true to use 3-D pressure solver  
 C     implicitIntGravWave :: treat Internal Gravity Wave implicitly  
 C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V  
 C     momStepping   :: Turns momentum equation time-stepping off  
 C     tempStepping  :: Turns temperature equation time-stepping off  
 C     saltStepping  :: Turns salinity equation time-stepping off  
 C     useConstantF  :: Coriolis parameter set to f0  
 C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  
 C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  
280  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
281  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
282    C                                (default = F = use mom_fluxform package)
283    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986)
284  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  
285  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
286  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)  
287  C     useAbsVorticity :: work with f+zeta in Coriolis terms  C     useAbsVorticity :: work with f+zeta in Coriolis terms
288    C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
289    C     momStepping    :: Turns momentum equation time-stepping off
290    C     calc_wVelocity :: Turns of vertical velocity calculation off
291    C- Temp. & Salt params:
292    C     tempStepping   :: Turns temperature equation time-stepping on/off
293    C     saltStepping   :: Turns salinity equation time-stepping on/off
294    C     addFrictionHeating :: account for frictional heating
295    C     tempAdvection  :: Flag which turns advection of temperature on and off.
296    C     tempVertDiff4  :: use vertical bi-harmonic diffusion for temperature
297    C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
298    C     tempForcing    :: Flag which turns external forcing of temperature on/off
299    C     saltAdvection  :: Flag which turns advection of salinity on and off.
300    C     saltVertDiff4  :: use vertical bi-harmonic diffusion for salinity
301    C     saltIsActiveTr :: Salinity  is a dynamically active tracer
302    C     saltForcing    :: Flag which turns external forcing of salinity on/off
303    C     maskIniTemp    :: apply mask to initial Pot.Temp.
304    C     maskIniSalt    :: apply mask to initial salinity
305    C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
306    C     checkIniSalt   :: check for points with identically zero initial salinity
307    C- Pressure solver related parameters (PARM02)
308    C     useSRCGSolver  :: Set to true to use conjugate gradient
309    C                       solver with single reduction (only one call of
310    C                       s/r mpi_allreduce), default is false
311    C- Time-stepping & free-surface params:
312    C     rigidLid            :: Set to true to use rigid lid
313    C     implicitFreeSurface :: Set to true to use implicit free surface
314    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
315    C                            linear relation Phi_surf = Bo_surf*eta
316    C     uniformFreeSurfLev  :: TRUE if free-surface level-index is uniform (=1)
317    C     exactConserv        :: Set to true to conserve exactly the total Volume
318    C     linFSConserveTr     :: Set to true to correct source/sink of tracer
319    C                            at the surface due to Linear Free Surface
320    C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
321    C                         as a real Fresh Water (=> changes the Sea Level)
322    C                         if F, converts P+R-E to salt flux (no SL effect)
323    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
324    C     nonHydrostatic   :: Using non-hydrostatic algorithm
325    C     use3Dsolver      :: set to true to use 3-D pressure solver
326    C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
327    C     staggerTimeStep   :: enable a Stagger time stepping U,V (& W) then T,S
328    C     doResetHFactors   :: Do reset thickness factors @ beginning of each time-step
329  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
330  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
331  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
# Line 272  C     useMultiDimAdvec  :: True if multi Line 336  C     useMultiDimAdvec  :: True if multi
336  C     momDissip_In_AB   :: if False, put Dissipation tendency contribution  C     momDissip_In_AB   :: if False, put Dissipation tendency contribution
337  C                          out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
338  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
339  C                          apply AB on tracer tendencies (rather than on Tracer)  C                          apply AB on tracer tendencies (rather than on Tracer)
340  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C- Other forcing params -
341    C     balanceEmPmR    :: substract global mean of EmPmR at every time step
342    C     balanceQnet     :: substract global mean of Qnet at every time step
343    C     balancePrintMean:: print substracted global means to STDOUT
344  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
345  C                        climatology is required.  C                        climatology is required.
346  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
347  C                        climatology is required.  C                        climatology is required.
348  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     balanceThetaClimRelax :: substract global mean effect at every time step
349  C     usingPCoords     :: Set to indicate that we are working in a pressure  C     balanceSaltClimRelax :: substract global mean effect at every time step
 C                        type coordinate (p or p*).  
 C     usingZCoords     :: Set to indicate that we are working in a height  
 C                        type coordinate (z or z*)  
 C     fluidIsAir       :: Set to indicate that the fluid major constituent  
 C                        is air  
 C     fluidIsWater     :: Set to indicate that the fluid major constituent  
 C                        is water  
 C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)  
 C                         this requires specific code for restart & exchange  
 C     setCenterDr    :: set cell Center depth and put Interface at the middle  
 C     nonHydrostatic :: Using non-hydrostatic terms  
 C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm  
 C     globalFiles    :: Selects between "global" and "tiled" files  
 C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  
 C                       slow (f77) or does not work (f90).  When  
 C                       useSingleCpuIO is set, mdsio_writefield.F  
 C                       outputs from master mpi process only.  
350  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
351  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
352    C     periodicExternalForcing :: Set true if forcing is time-dependant
353    C- I/O parameters -
354    C     globalFiles    :: Selects between "global" and "tiled" files.
355    C                       On some platforms with MPI, option globalFiles is either
356    C                       slow or does not work. Use useSingleCpuIO instead.
357    C     useSingleCpuIO :: moved to EEPARAMS.h
358    C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
359    C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
360    C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
361    C                           before checkpoint-54a, Jul 06, 2004.
362  C     pickup_write_mdsio :: use mdsio to write pickups  C     pickup_write_mdsio :: use mdsio to write pickups
363  C     pickup_read_mdsio  :: use mdsio to read  pickups  C     pickup_read_mdsio  :: use mdsio to read  pickups
364  C     pickup_write_immed :: echo the pickup immediately (for conversion)  C     pickup_write_immed :: echo the pickup immediately (for conversion)
365    C     writePickupAtEnd   :: write pickup at the last timestep
366  C     timeave_mdsio      :: use mdsio for timeave output  C     timeave_mdsio      :: use mdsio for timeave output
367  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
368  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
369  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
370  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
371  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  
372    
373        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/
374       & usingCurvilinearGrid, usingCylindricalGrid,       & fluidIsAir, fluidIsWater,
375       & no_slip_sides,no_slip_bottom,       & usingPCoords, usingZCoords, useDynP_inEos_Zc,
376       & momViscosity, momAdvection, momForcing, useCoriolis,       & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
377       & momPressureForcing, vectorInvariantMomentum,       & usingCylindricalGrid, usingCurvilinearGrid, hasWetCSCorners,
378       & tempAdvection, tempForcing,       & deepAtmosphere, setInterFDr, setCenterDr,
379       & saltAdvection, saltForcing,       & no_slip_sides, no_slip_bottom,
380       & useRealFreshWaterFlux,       & useFullLeith, useStrainTensionVisc, useAreaViscLength,
381       & useFullLeith, useStrainTensionVisc,       & momViscosity, momAdvection, momForcing,
382       & useAreaViscLength,       & momPressureForcing, metricTerms, useNHMTerms,
383       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & useCoriolis, use3dCoriolis,
384       & use3Dsolver, implicitIntGravWave, staggerTimeStep,       & useCDscheme, vectorInvariantMomentum,
      & momStepping, tempStepping, saltStepping,  
      & metricTerms, useNHMTerms,  
      & useConstantF, useBetaPlaneF, useSphereF,  
      & useCDscheme,  
385       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
386       & SadournyCoriolis, upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
387       & useAbsVorticity, upwindShear,       & useAbsVorticity, upwindShear,
388         & momStepping, calc_wVelocity, tempStepping, saltStepping,
389         & addFrictionHeating,
390         & tempAdvection, tempVertDiff4, tempIsActiveTr, tempForcing,
391         & saltAdvection, saltVertDiff4, saltIsActiveTr, saltForcing,
392         & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
393         & useSRCGSolver,
394         & rigidLid, implicitFreeSurface,
395         & uniformLin_PhiSurf, uniformFreeSurfLev,
396         & exactConserv, linFSConserveTr, useRealFreshWaterFlux,
397         & quasiHydrostatic, nonHydrostatic, use3Dsolver,
398         & implicitIntGravWave, staggerTimeStep, doResetHFactors,
399       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
400       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
401       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
402       & momDissip_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
403       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & balanceEmPmR, balanceQnet, balancePrintMean,
404       & periodicExternalForcing,       & balanceThetaClimRelax, balanceSaltClimRelax,
405       & fluidIsAir, fluidIsWater,       & doThetaClimRelax, doSaltClimRelax,
      & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,  
      & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,  
406       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
407       & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,       & periodicExternalForcing,
408         & globalFiles,
409         & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
410       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
411         & writePickupAtEnd,
412       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
413       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast,
414       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & printDomain
      & balanceEmPmR, balanceQnet, balancePrintMean  
415    
416          LOGICAL fluidIsAir
417          LOGICAL fluidIsWater
418          LOGICAL usingPCoords
419          LOGICAL usingZCoords
420          LOGICAL useDynP_inEos_Zc
421        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
422        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid, rotateGrid
423        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
424        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid, hasWetCSCorners
425        LOGICAL useNHMTerms        LOGICAL deepAtmosphere
426          LOGICAL setInterFDr
427          LOGICAL setCenterDr
428    
429        LOGICAL no_slip_sides        LOGICAL no_slip_sides
430        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
431          LOGICAL useFullLeith
432          LOGICAL useStrainTensionVisc
433          LOGICAL useAreaViscLength
434        LOGICAL momViscosity        LOGICAL momViscosity
435        LOGICAL momAdvection        LOGICAL momAdvection
436        LOGICAL momForcing        LOGICAL momForcing
437        LOGICAL momPressureForcing        LOGICAL momPressureForcing
438          LOGICAL metricTerms
439          LOGICAL useNHMTerms
440    
441        LOGICAL useCoriolis        LOGICAL useCoriolis
442          LOGICAL use3dCoriolis
443          LOGICAL useCDscheme
444        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
445          LOGICAL useEnergyConservingCoriolis
446          LOGICAL useJamartWetPoints
447          LOGICAL useJamartMomAdv
448          LOGICAL upwindVorticity
449          LOGICAL highOrderVorticity
450          LOGICAL useAbsVorticity
451          LOGICAL upwindShear
452          LOGICAL momStepping
453          LOGICAL calc_wVelocity
454          LOGICAL tempStepping
455          LOGICAL saltStepping
456          LOGICAL addFrictionHeating
457        LOGICAL tempAdvection        LOGICAL tempAdvection
458          LOGICAL tempVertDiff4
459          LOGICAL tempIsActiveTr
460        LOGICAL tempForcing        LOGICAL tempForcing
461        LOGICAL saltAdvection        LOGICAL saltAdvection
462          LOGICAL saltVertDiff4
463          LOGICAL saltIsActiveTr
464        LOGICAL saltForcing        LOGICAL saltForcing
465        LOGICAL useRealFreshWaterFlux        LOGICAL maskIniTemp
466        LOGICAL useFullLeith        LOGICAL maskIniSalt
467        LOGICAL useStrainTensionVisc        LOGICAL checkIniTemp
468        LOGICAL useAreaViscLength        LOGICAL checkIniSalt
469          LOGICAL useSRCGSolver
470        LOGICAL rigidLid        LOGICAL rigidLid
471        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
       LOGICAL exactConserv  
472        LOGICAL uniformLin_PhiSurf        LOGICAL uniformLin_PhiSurf
473          LOGICAL uniformFreeSurfLev
474          LOGICAL exactConserv
475          LOGICAL linFSConserveTr
476          LOGICAL useRealFreshWaterFlux
477          LOGICAL quasiHydrostatic
478          LOGICAL nonHydrostatic
479        LOGICAL use3Dsolver        LOGICAL use3Dsolver
480        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
481        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
482        LOGICAL momStepping        LOGICAL doResetHFactors
       LOGICAL tempStepping  
       LOGICAL saltStepping  
       LOGICAL metricTerms  
       LOGICAL useConstantF  
       LOGICAL useBetaPlaneF  
       LOGICAL useSphereF  
       LOGICAL useCDscheme  
       LOGICAL useEnergyConservingCoriolis  
       LOGICAL useJamartWetPoints  
       LOGICAL useJamartMomAdv  
       LOGICAL SadournyCoriolis  
       LOGICAL upwindVorticity  
       LOGICAL highOrderVorticity  
       LOGICAL useAbsVorticity  
       LOGICAL upwindShear  
483        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
484        LOGICAL implicitViscosity        LOGICAL implicitViscosity
485        LOGICAL tempImplVertAdv        LOGICAL tempImplVertAdv
# Line 400  C     balancePrintMean:: print substract Line 489  C     balancePrintMean:: print substract
489        LOGICAL useMultiDimAdvec        LOGICAL useMultiDimAdvec
490        LOGICAL momDissip_In_AB        LOGICAL momDissip_In_AB
491        LOGICAL doAB_onGtGs        LOGICAL doAB_onGtGs
492          LOGICAL balanceEmPmR
493          LOGICAL balanceQnet
494          LOGICAL balancePrintMean
495        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
496        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
497        LOGICAL doTr1ClimRelax        LOGICAL balanceThetaClimRelax
498        LOGICAL periodicExternalForcing        LOGICAL balanceSaltClimRelax
       LOGICAL fluidIsAir  
       LOGICAL fluidIsWater  
       LOGICAL usingPCoords  
       LOGICAL usingZCoords  
       LOGICAL useDynP_inEos_Zc  
       LOGICAL setCenterDr  
       LOGICAL nonHydrostatic  
       LOGICAL quasiHydrostatic  
       LOGICAL globalFiles  
       LOGICAL useSingleCpuIO  
499        LOGICAL allowFreezing        LOGICAL allowFreezing
500        LOGICAL useOldFreezing        LOGICAL useOldFreezing
501        LOGICAL usePickupBeforeC35        LOGICAL periodicExternalForcing
502          LOGICAL globalFiles
503          LOGICAL pickupStrictlyMatch
504        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
505        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
       LOGICAL dumpInitAndLast  
       LOGICAL debugMode  
506        LOGICAL pickup_read_mdsio, pickup_write_mdsio        LOGICAL pickup_read_mdsio, pickup_write_mdsio
507        LOGICAL pickup_write_immed        LOGICAL pickup_write_immed, writePickupAtEnd
508        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
509        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
510        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL dumpInitAndLast
511          LOGICAL printDomain
       LOGICAL balanceEmPmR  
       LOGICAL balanceQnet  
       LOGICAL balancePrintMean  
512    
513  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
514  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 455  C           defaults to 0.51 but can be Line 534  C           defaults to 0.51 but can be
534  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
535  C     delRc     :: Vertical grid spacing between cell centers (r unit).  C     delRc     :: Vertical grid spacing between cell centers (r unit).
536  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
537  C     delY        on input flags.  C     delY         on input flags. Note: moved to header file SET_GRID.h
538    C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
539    C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
540    C                :: parameter but it makes geographical references simple.)
541    C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
542    C                :: most face (Lat-Lon grid).
543  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
544  C     recip_gravity and its inverse  C     recip_gravity and its inverse
545  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 )
546  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
547  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density (Boussinesq)
548    C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
549    C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
550  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
551    C     rho1Ref   :: reference vertical profile for density
552  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
553  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
554  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
555  C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:  C     dBdrRef   :: vertical gradient of reference buoyancy  [(m/s/r)^2]:
556  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
557  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
558  C     phiMin    :: Latitude of southern most cell face.  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
559  C     thetaMin  :: Longitude of western most cell face (this  C                :: from r-coordinate vertical velocity to vertical velocity [m/s].
560  C                 is an "inert" parameter but it is included  C                :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit
561  C                 to make geographical references simple.)  C     wUnit2rVel :: units conversion factor (Non-Hydrostatic code),
562  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).  C                :: from vertical velocity [m/s] to r-coordinate vertical velocity.
563  C     recip_RSphere  :: Reciprocal radius of sphere ( m ).  C                :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel
564  C     f0        :: Reference coriolis parameter ( 1/s )  C     mass2rUnit :: units conversion factor (surface forcing),
565  C                 ( Southern edge f for beta plane )  C                :: from mass per unit area [kg/m2] to vertical r-coordinate unit.
566  C     beta      :: df/dy ( s^-1.m^-1 )  C                :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ;
567  C     omega     :: Angular velocity ( rad/s )  C                :: p-coord: = gravity    ( [kg/m2] *  g = [Pa] ) ;
568    C     rUnit2mass :: units conversion factor (surface forcing),
569    C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
570    C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
571    C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
572    C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
573    C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
574    C     radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
575    C     f0         :: Reference coriolis parameter ( 1/s )
576    C                   ( Southern edge f for beta plane )
577    C     beta       :: df/dy ( s^-1.m^-1 )
578    C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
579    C                   of rotation (reference value = 2.Omega.Cos(Phi))
580    C     omega      :: Angular velocity ( rad/s )
581  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
582  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
583  C                 momentum laterally ( m^2/s )  C                   for vertical mixing of momentum ( units of r^2/s )
584  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical  C     viscAh     :: Eddy viscosity coeff. for mixing of
 C                 momentum laterally, no effect for hydrostatic  
 C                 model, defaults to viscAh if unset ( m^2/s )  
 C     viscAr    :: Eddy viscosity coeff. for mixing of  
 C                 momentum vertically ( units of r^2/s )  
 C     viscA4    :: Biharmonic viscosity coeff. for mixing of  
 C                 momentum laterally ( m^4/s )  
 C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical  
 C                 momentum laterally, no effect for hydrostatic  
 C                 model, defaults to viscA4 if unset ( m^2/s )  
 C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally  
 C                  (act on Divergence part) ( m^2/s )  
 C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally  
 C                  (act on Vorticity  part) ( m^2/s )  
 C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally  
 C                  (act on Divergence part) ( m^4/s )  
 C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  
 C                  (act on Vorticity  part) ( m^4/s )  
 C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))  
 C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))  
 C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor (harmonic)  
 C     viscC4smag  :: Smagorinsky non-dimensional viscosity factor (biharmonic)  
 C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  
585  C                   momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
586  C     viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
587  C                   coeff. for mixing of momentum laterally (non-dim)  C                   momentum laterally, no effect for hydrostatic
588    C                   model, defaults to viscAh if unset ( m^2/s )
589    C                   Not used if variable horiz. viscosity is used.
590    C     viscA4     :: Biharmonic viscosity coeff. for mixing of
591    C                   momentum laterally ( m^4/s )
592    C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
593    C                   momentum laterally, no effect for hydrostatic
594    C                   model, defaults to viscA4 if unset ( m^2/s )
595    C                   Not used if variable horiz. viscosity is used.
596    C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
597    C                   (act on Divergence part) ( m^2/s )
598    C     viscAhZ    :: Eddy viscosity coeff. for mixing of momentum laterally
599    C                   (act on Vorticity  part) ( m^2/s )
600    C     viscA4D    :: Biharmonic viscosity coeff. for mixing of momentum laterally
601    C                   (act on Divergence part) ( m^4/s )
602    C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
603    C                   (act on Vorticity  part) ( m^4/s )
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
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
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
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     BL79LatVary    :: polarwise of this latitude diffKrBL79 is applied with
645    C                       gradual transition to diffKrBLEQ towards Equator
646    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 544  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 555  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 581  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 596  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 616  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         & viscFacAdj, viscAh, viscAhW, viscAhMax,
751       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & 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       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & BL79LatVary,
763         & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
764         & tauCD, rCD, epsAB_CD,
765         & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
766       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
767       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_gravity, gBaro,
768       & recip_rhoConst, rhoConst,       & rhoNil, rhoConst, recip_rhoConst,
769       & rhoConstFresh, convertEmP2rUnit, tRef, sRef, phiRef, dBdrRef,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
770         & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
771         & 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 661  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 viscAhMax        _RL viscAhMax
827        _RL viscAhReMax        _RL viscAhReMax
828        _RL viscAhGrid        _RL viscAhGrid, viscAhGridMax, viscAhGridMin
       _RL viscAhGridMax  
       _RL viscAhGridMin  
829        _RL viscC2leith        _RL viscC2leith
830        _RL viscC2leithD        _RL viscC2leithD
831        _RL viscC2smag        _RL viscC2smag
       _RL viscC4smag  
       _RL viscAr  
832        _RL viscA4        _RL viscA4
833        _RL viscA4W        _RL viscA4W
834        _RL viscA4D        _RL viscA4D
# Line 707  C                      (i.e. allows conv Line 838  C                      (i.e. allows conv
838        _RL viscA4Grid, viscA4GridMax, viscA4GridMin        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
839        _RL viscC4leith        _RL viscC4leith
840        _RL viscC4leithD        _RL viscC4leithD
841          _RL viscC4smag
842        _RL diffKhT        _RL diffKhT
       _RL diffKrNrT(Nr)  
843        _RL diffK4T        _RL diffK4T
844          _RL diffKrNrT(Nr)
845          _RL diffKr4T(Nr)
846        _RL diffKhS        _RL diffKhS
       _RL diffKrNrS(Nr)  
847        _RL diffK4S        _RL diffK4S
848          _RL diffKrNrS(Nr)
849          _RL diffKr4S(Nr)
850        _RL diffKrBL79surf        _RL diffKrBL79surf
851        _RL diffKrBL79deep        _RL diffKrBL79deep
852        _RL diffKrBL79scl        _RL diffKrBL79scl
853        _RL diffKrBL79Ho        _RL diffKrBL79Ho
854        _RL delt        _RL BL79LatVary
855        _RL tauCD        _RL diffKrBLEQsurf
856        _RL rCD        _RL diffKrBLEQdeep
857          _RL diffKrBLEQscl
858          _RL diffKrBLEQHo
859          _RL tauCD, rCD, epsAB_CD
860        _RL gravity        _RL gravity
861        _RL recip_gravity        _RL recip_gravity
862        _RL gBaro        _RL gBaro
863        _RL rhonil        _RL rhoNil
864        _RL recip_rhonil        _RL rhoConst,      recip_rhoConst
865        _RL rhoConst        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
866        _RL recip_rhoConst        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
867        _RL rhoConstFresh        _RL rhoConstFresh
868        _RL convertEmP2rUnit        _RL rho1Ref(Nr)
869        _RL tRef(Nr)        _RL tRef(Nr)
870        _RL sRef(Nr)        _RL sRef(Nr)
871        _RL phiRef(2*Nr+1)        _RL phiRef(2*Nr+1)
872        _RL dBdrRef(Nr)        _RL dBdrRef(Nr)
873          _RL rVel2wUnit(Nr+1), wUnit2rVel(Nr+1)
874          _RL mass2rUnit, rUnit2mass
875        _RL baseTime        _RL baseTime
876        _RL startTime        _RL startTime
877        _RL endTime        _RL endTime
# Line 753  C                      (i.e. allows conv Line 892  C                      (i.e. allows conv
892        _RL mtFacMom        _RL mtFacMom
893        _RL cosPower        _RL cosPower
894        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
       _RL rotationPeriod  
895        _RL tauThetaClimRelax        _RL tauThetaClimRelax
896        _RL tauSaltClimRelax        _RL tauSaltClimRelax
       _RL tauTr1ClimRelax  
       _RL lambdaTr1ClimRelax  
897        _RL latBandClimRelax        _RL latBandClimRelax
898        _RL externForcingCycle        _RL externForcingCycle
899        _RL externForcingPeriod        _RL externForcingPeriod
900        _RL convertFW2Salt        _RL convertFW2Salt
901        _RL temp_EvPrRn        _RL temp_EvPrRn
902        _RL salt_EvPrRn        _RL salt_EvPrRn
903        _RL horiVertRatio        _RL temp_addMass
904        _RL recip_horiVertRatio        _RL salt_addMass
905        _RL ivdc_kappa        _RL ivdc_kappa
906          _RL hMixCriteria
907          _RL dRhoSmall
908          _RL hMixSmooth
909        _RL Ro_SeaLevel        _RL Ro_SeaLevel
910          _RL rSigmaBnd
911        _RL sideDragFactor        _RL sideDragFactor
912        _RL bottomDragLinear        _RL bottomDragLinear
913        _RL bottomDragQuadratic        _RL bottomDragQuadratic
914        _RL smoothAbsFuncRange        _RL smoothAbsFuncRange
915        _RL nh_Am2        _RL nh_Am2
916        _RL tCylIn        _RL tCylIn, tCylOut
917        _RL tCylOut        _RL phiEuler, thetaEuler, psiEuler
918    
919  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
920        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
# Line 791  C     atm_kappa :: kappa = R/Cp (R: cons Line 930  C     atm_kappa :: kappa = R/Cp (R: cons
930  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
931  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])
932  C     integr_GeoPot :: option to select the way we integrate the geopotential  C     integr_GeoPot :: option to select the way we integrate the geopotential
933  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
934  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
935  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
936        COMMON /PARM_ATM/        COMMON /PARM_ATM/
# Line 803  C             derived from the orography Line 942  C             derived from the orography
942        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
943    
944  C Logical flags for selecting packages  C Logical flags for selecting packages
945          LOGICAL useGAD
946          LOGICAL useOBCS
947          LOGICAL useSHAP_FILT
948          LOGICAL useZONAL_FILT
949        LOGICAL useOPPS        LOGICAL useOPPS
950        LOGICAL usePP81        LOGICAL usePP81
951        LOGICAL useMY82        LOGICAL useMY82
952        LOGICAL useGGL90        LOGICAL useGGL90
953        LOGICAL useKPP        LOGICAL useKPP
954        LOGICAL useGMRedi        LOGICAL useGMRedi
955        LOGICAL useOBCS        LOGICAL useDOWN_SLOPE
956        LOGICAL useAIM        LOGICAL useBBL
       LOGICAL useLand  
957        LOGICAL useCAL        LOGICAL useCAL
958        LOGICAL useEXF        LOGICAL useEXF
959          LOGICAL useBulkForce
960        LOGICAL useEBM        LOGICAL useEBM
961          LOGICAL useCheapAML
962        LOGICAL useGrdchk        LOGICAL useGrdchk
963          LOGICAL useSMOOTH
964          LOGICAL usePROFILES
965        LOGICAL useECCO        LOGICAL useECCO
966        LOGICAL useSHAP_FILT        LOGICAL useSBO
       LOGICAL useZONAL_FILT  
967        LOGICAL useFLT        LOGICAL useFLT
968        LOGICAL usePTRACERS        LOGICAL usePTRACERS
969        LOGICAL useGCHEM        LOGICAL useGCHEM
970        LOGICAL useRBCS        LOGICAL useRBCS
971        LOGICAL useOffLine        LOGICAL useOffLine
972        LOGICAL useMATRIX        LOGICAL useMATRIX
973        LOGICAL useSBO        LOGICAL useFRAZIL
974        LOGICAL useSEAICE        LOGICAL useSEAICE
975          LOGICAL useSALT_PLUME
976        LOGICAL useShelfIce        LOGICAL useShelfIce
977          LOGICAL useStreamIce
978          LOGICAL useICEFRONT
979        LOGICAL useThSIce        LOGICAL useThSIce
980        LOGICAL useBulkForce        LOGICAL useATM2d
981        LOGICAL usefizhi        LOGICAL useAIM
982        LOGICAL usegridalt        LOGICAL useLand
983          LOGICAL useFizhi
984          LOGICAL useGridAlt
985        LOGICAL useDiagnostics        LOGICAL useDiagnostics
986          LOGICAL useREGRID
987          LOGICAL useLayers
988        LOGICAL useMNC        LOGICAL useMNC
989        LOGICAL useRunClock        LOGICAL useRunClock
990        LOGICAL useEMBED_FILES        LOGICAL useEMBED_FILES
991          LOGICAL useMYPACKAGE
992        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
993         &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
994       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
995       &        useGMRedi, useOBCS, useAIM, useLand,       &        useGMRedi, useBBL, useDOWN_SLOPE,
996       &        useCAL, useEXF, useEBM, useGrdchk, useECCO,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
997       &        useSHAP_FILT, useZONAL_FILT, useFLT,       &        useGrdchk,useSMOOTH,usePROFILES,useECCO,useSBO, useFLT,
998       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
999       &        useSBO, useSEAICE, useShelfIce, useThSIce, useBulkForce,       &        useFRAZIL, useSEAICE, useSALT_PLUME, useShelfIce,
1000       &        usefizhi, usegridalt, useDiagnostics, useMNC,       &        useStreamIce, useICEFRONT, useThSIce,
1001       &        useRunClock, useEMBED_FILES       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
1002         &        useDiagnostics, useREGRID, useLayers, useMNC,
1003         &        useRunClock, useEMBED_FILES,
1004         &        useMYPACKAGE
1005    
1006  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
1007  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***

Legend:
Removed from v.1.185  
changed lines
  Added in v.1.268

  ViewVC Help
Powered by ViewVC 1.1.22