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

Legend:
Removed from v.1.57  
changed lines
  Added in v.1.273

  ViewVC Help
Powered by ViewVC 1.1.22