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

Legend:
Removed from v.1.17  
changed lines
  Added in v.1.214

  ViewVC Help
Powered by ViewVC 1.1.22