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

Legend:
Removed from v.1.7  
changed lines
  Added in v.1.251

  ViewVC Help
Powered by ViewVC 1.1.22