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

Legend:
Removed from v.1.39  
changed lines
  Added in v.1.287

  ViewVC Help
Powered by ViewVC 1.1.22