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