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

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.267

  ViewVC Help
Powered by ViewVC 1.1.22