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

Legend:
Removed from v.1.48  
changed lines
  Added in v.1.284

  ViewVC Help
Powered by ViewVC 1.1.22