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

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

  ViewVC Help
Powered by ViewVC 1.1.22