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