/[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.5 by adcroft, Thu Apr 30 13:25:01 1998 UTC revision 1.277 by gforget, Sun Nov 2 21:21:43 2014 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--   Contants  C--   Contants
 C     nOBands - No. of offline data time bands  
       INTEGER nOBands  
       PARAMETER ( nOBands = 12 )  
18  C     Useful physical values  C     Useful physical values
19        Real*8 PI        Real*8 PI
20        PARAMETER ( PI    = 3.14159265358979323844D0   )        PARAMETER ( PI    = 3.14159265358979323844D0   )
# Line 20  C     Useful physical values Line 22  C     Useful physical values
22        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
23    
24  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
25  C     oBandId  - Offline dataset identifiers for different periods.  C     buoyancyRelation :: Flag used to indicate which relation to use to
26        COMMON /PARM_C/ oBandId  C                         get buoyancy.
27        CHARACTER*3 oBandId(nOBands)  C     eosType         :: choose the equation of state:
28    C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
29    C     pickupSuff      :: force to start from pickup files (even if nIter0=0)
30    C                        and read pickup files with this suffix (max 10 Char.)
31    C     mdsioLocalDir   :: read-write tiled file from/to this directory name
32    C                        (+ 4 digits Processor-Rank) instead of current dir.
33    C     adTapeDir       :: read-write checkpointing tape files from/to this
34    C                        directory name instead of current dir. Conflicts
35    C                        mdsioLocalDir, so only one of the two can be set.
36    C                        In contrast to mdsioLocalDir, if specified adTapeDir
37    C                        must exist before the model starts.
38    C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
39    C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
40    C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
41    C     delRFile      :: File containing vertical grid spacing delR  (1.D array)
42    C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)
43    C     hybSigmFile   :: File containing hybrid-sigma vertical coord. coeff. (2x 1.D)
44    C     delXFile      :: File containing X-spacing grid definition (1.D array)
45    C     delYFile      :: File containing Y-spacing grid definition (1.D array)
46    C     horizGridFile :: File containing horizontal-grid definition
47    C                        (only when using curvilinear_grid)
48    C     bathyFile       :: File containing bathymetry. If not defined bathymetry
49    C                        is taken from inline function.
50    C     topoFile        :: File containing the topography of the surface (unit=m)
51    C                        (mainly used for the atmosphere = ground height).
52    C     addWwallFile    :: File containing 2-D additional Western  cell-edge wall
53    C     addSwallFile    :: File containing 2-D additional Southern cell-edge wall
54    C                        (e.g., to add "thin-wall" where it is =1)
55    C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
56    C                        for potential temperature.
57    C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
58    C                        for salinity.
59    C     diffKrFile      :: File containing 3D specification of vertical diffusivity
60    C     viscAhDfile     :: File containing 3D specification of horizontal viscosity
61    C     viscAhZfile     :: File containing 3D specification of horizontal viscosity
62    C     viscA4Dfile     :: File containing 3D specification of horizontal viscosity
63    C     viscA4Zfile     :: File containing 3D specification of horizontal viscosity
64    C     zonalWindFile   :: File containing zonal wind data
65    C     meridWindFile   :: File containing meridional wind data
66    C     thetaClimFile   :: File containing surface theta climataology used
67    C                        in relaxation term -lambda(theta-theta*)
68    C     saltClimFile    :: File containing surface salt climataology used
69    C                        in relaxation term -lambda(salt-salt*)
70    C     surfQfile       :: File containing surface heat flux, excluding SW
71    C                        (old version, kept for backward compatibility)
72    C     surfQnetFile    :: File containing surface net heat flux
73    C     surfQswFile     :: File containing surface shortwave radiation
74    C     EmPmRfile       :: File containing surface fresh water flux
75    C           NOTE: for backward compatibility EmPmRfile is specified in
76    C                 m/s when using external_fields_load.F.  It is converted
77    C                 to kg/m2/s by multiplying by rhoConstFresh.
78    C     saltFluxFile    :: File containing surface salt flux
79    C     pLoadFile       :: File containing pressure loading
80    C     addMassFile     :: File containing source/sink of fluid in the interior
81    C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data
82    C     eddyPsiYFile    :: File containing meridional Eddy streamfunction data
83    C     the_run_name    :: string identifying the name of the model "run"
84          COMMON /PARM_C/
85         &                buoyancyRelation, eosType,
86         &                pickupSuff, mdsioLocalDir, adTapeDir,
87         &                tRefFile, sRefFile, rhoRefFile,
88         &                delRFile, delRcFile, hybSigmFile,
89         &                delXFile, delYFile, horizGridFile,
90         &                bathyFile, topoFile, addWwallFile, addSwallFile,
91         &                viscAhDfile, viscAhZfile,
92         &                viscA4Dfile, viscA4Zfile,
93         &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
94         &                zonalWindFile, meridWindFile, thetaClimFile,
95         &                saltClimFile,
96         &                EmPmRfile, saltFluxFile,
97         &                surfQfile, surfQnetFile, surfQswFile,
98         &                lambdaThetaFile, lambdaSaltFile,
99         &                uVelInitFile, vVelInitFile, pSurfInitFile,
100         &                pLoadFile, addMassFile,
101         &                eddyPsiXFile, eddyPsiYFile, geothermalFile,
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) addWwallFile, addSwallFile
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) pLoadFile
138          CHARACTER*(MAX_LEN_FNAM) addMassFile
139          CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile
140          CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile
141          CHARACTER*(MAX_LEN_FNAM) geothermalFile
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     useSmag3D      :: Use isotropic 3-D Smagorinsky
268    C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
269    C                       on irregular grids)
270    C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
271    C     useAreaViscLength :: Set to true to use old scaling for viscous lengths,
272    C                          e.g., L2=Raz.  May be preferable for cube sphere.
273    C     momViscosity  :: Flag which turns momentum friction terms on and off.
274    C     momAdvection  :: Flag which turns advection of momentum on and off.
275    C     momForcing    :: Flag which turns external forcing of momentum on
276    C                      and off.
277    C     momPressureForcing :: Flag which turns pressure term in momentum equation
278    C                          on and off.
279    C     metricTerms   :: Flag which turns metric terms on or off.
280    C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
281    C     useCoriolis   :: Flag which turns the coriolis terms on and off.
282    C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
283    C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
284    C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
285    C                                (default = F = use mom_fluxform package)
286    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986)
287    C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
288    C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
289    C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
290    C     useAbsVorticity :: work with f+zeta in Coriolis terms
291    C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
292    C     momStepping    :: Turns momentum equation time-stepping off
293    C     calc_wVelocity :: Turns of vertical velocity calculation off
294    C- Temp. & Salt params:
295    C     tempStepping   :: Turns temperature equation time-stepping on/off
296    C     saltStepping   :: Turns salinity equation time-stepping on/off
297    C     addFrictionHeating :: account for frictional heating
298    C     tempAdvection  :: Flag which turns advection of temperature on and off.
299    C     tempVertDiff4  :: use vertical bi-harmonic diffusion for temperature
300    C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
301    C     tempForcing    :: Flag which turns external forcing of temperature on/off
302    C     saltAdvection  :: Flag which turns advection of salinity on and off.
303    C     saltVertDiff4  :: use vertical bi-harmonic diffusion for salinity
304    C     saltIsActiveTr :: Salinity  is a dynamically active tracer
305    C     saltForcing    :: Flag which turns external forcing of salinity on/off
306    C     maskIniTemp    :: apply mask to initial Pot.Temp.
307    C     maskIniSalt    :: apply mask to initial salinity
308    C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
309    C     checkIniSalt   :: check for points with identically zero initial salinity
310    C- Pressure solver related parameters (PARM02)
311    C     useSRCGSolver  :: Set to true to use conjugate gradient
312    C                       solver with single reduction (only one call of
313    C                       s/r mpi_allreduce), default is false
314    C- Time-stepping & free-surface params:
315    C     rigidLid            :: Set to true to use rigid lid
316    C     implicitFreeSurface :: Set to true to use implicit free surface
317    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
318    C                            linear relation Phi_surf = Bo_surf*eta
319    C     uniformFreeSurfLev  :: TRUE if free-surface level-index is uniform (=1)
320    C     exactConserv        :: Set to true to conserve exactly the total Volume
321    C     linFSConserveTr     :: Set to true to correct source/sink of tracer
322    C                            at the surface due to Linear Free Surface
323    C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
324    C                         as a real Fresh Water (=> changes the Sea Level)
325    C                         if F, converts P+R-E to salt flux (no SL effect)
326    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
327    C     nonHydrostatic   :: Using non-hydrostatic algorithm
328    C     use3Dsolver      :: set to true to use 3-D pressure solver
329    C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
330    C     staggerTimeStep   :: enable a Stagger time stepping U,V (& W) then T,S
331    C     doResetHFactors   :: Do reset thickness factors @ beginning of each time-step
332    C     implicitDiffusion :: Turns implicit vertical diffusion on
333    C     implicitViscosity :: Turns implicit vertical viscosity on
334    C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
335    C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity
336    C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
337    C     multiDimAdvection :: Flag that enable multi-dimension advection
338    C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
339    C     momDissip_In_AB   :: if False, put Dissipation tendency contribution
340    C                          out off Adams-Bashforth time stepping.
341    C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
342    C                          apply AB on tracer tendencies (rather than on Tracer)
343    C- Other forcing params -
344    C     balanceEmPmR    :: substract global mean of EmPmR at every time step
345    C     balanceQnet     :: substract global mean of Qnet at every time step
346    C     balancePrintMean:: print substracted global means to STDOUT
347    C     doThetaClimRelax :: Set true if relaxation to temperature
348    C                        climatology is required.
349    C     doSaltClimRelax  :: Set true if relaxation to salinity
350    C                        climatology is required.
351    C     balanceThetaClimRelax :: substract global mean effect at every time step
352    C     balanceSaltClimRelax :: substract global mean effect at every time step
353    C     allowFreezing  :: Allows surface water to freeze and form ice
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, useSmag3D,
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,
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 useSmag3D
434          LOGICAL useFullLeith
435          LOGICAL useStrainTensionVisc
436          LOGICAL useAreaViscLength
437        LOGICAL momViscosity        LOGICAL momViscosity
438        LOGICAL momAdvection        LOGICAL momAdvection
439        LOGICAL momForcing        LOGICAL momForcing
440          LOGICAL momPressureForcing
441          LOGICAL metricTerms
442          LOGICAL useNHMTerms
443    
444        LOGICAL useCoriolis        LOGICAL useCoriolis
445        LOGICAL tempDiffusion        LOGICAL use3dCoriolis
446          LOGICAL useCDscheme
447          LOGICAL vectorInvariantMomentum
448          LOGICAL useEnergyConservingCoriolis
449          LOGICAL useJamartWetPoints
450          LOGICAL useJamartMomAdv
451          LOGICAL upwindVorticity
452          LOGICAL highOrderVorticity
453          LOGICAL useAbsVorticity
454          LOGICAL upwindShear
455          LOGICAL momStepping
456          LOGICAL calc_wVelocity
457          LOGICAL tempStepping
458          LOGICAL saltStepping
459          LOGICAL addFrictionHeating
460        LOGICAL tempAdvection        LOGICAL tempAdvection
461          LOGICAL tempVertDiff4
462          LOGICAL tempIsActiveTr
463        LOGICAL tempForcing        LOGICAL tempForcing
       LOGICAL saltDiffusion  
464        LOGICAL saltAdvection        LOGICAL saltAdvection
465          LOGICAL saltVertDiff4
466          LOGICAL saltIsActiveTr
467        LOGICAL saltForcing        LOGICAL saltForcing
468          LOGICAL maskIniTemp
469          LOGICAL maskIniSalt
470          LOGICAL checkIniTemp
471          LOGICAL checkIniSalt
472          LOGICAL useSRCGSolver
473          LOGICAL rigidLid
474          LOGICAL implicitFreeSurface
475          LOGICAL uniformLin_PhiSurf
476          LOGICAL uniformFreeSurfLev
477          LOGICAL exactConserv
478          LOGICAL linFSConserveTr
479          LOGICAL useRealFreshWaterFlux
480          LOGICAL quasiHydrostatic
481          LOGICAL nonHydrostatic
482          LOGICAL use3Dsolver
483          LOGICAL implicitIntGravWave
484          LOGICAL staggerTimeStep
485          LOGICAL doResetHFactors
486          LOGICAL implicitDiffusion
487          LOGICAL implicitViscosity
488          LOGICAL tempImplVertAdv
489          LOGICAL saltImplVertAdv
490          LOGICAL momImplVertAdv
491          LOGICAL multiDimAdvection
492          LOGICAL useMultiDimAdvec
493          LOGICAL momDissip_In_AB
494          LOGICAL doAB_onGtGs
495          LOGICAL balanceEmPmR
496          LOGICAL balanceQnet
497          LOGICAL balancePrintMean
498          LOGICAL doThetaClimRelax
499          LOGICAL doSaltClimRelax
500          LOGICAL balanceThetaClimRelax
501          LOGICAL balanceSaltClimRelax
502          LOGICAL allowFreezing
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     thetaConst :: Constant reference for potential temperature
551    C     rhoFacC    :: normalized (by rhoConst) reference density at cell-Center
552    C     rhoFacF    :: normalized (by rhoConst) reference density at cell-interFace
553    C     rhoConstFresh :: Constant reference density for fresh water (rain)
554    C     rho1Ref    :: reference vertical profile for density
555    C     tRef       :: reference vertical profile for potential temperature
556    C     sRef       :: reference vertical profile for salinity/specific humidity
557    C     phiRef     :: reference potential (pressure/rho, geopotential) profile
558    C     dBdrRef    :: vertical gradient of reference buoyancy  [(m/s/r)^2]:
559    C                :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
560    C                :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
561    C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
562    C                :: from r-coordinate vertical velocity to vertical velocity [m/s].
563    C                :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit
564    C     wUnit2rVel :: units conversion factor (Non-Hydrostatic code),
565    C                :: from vertical velocity [m/s] to r-coordinate vertical velocity.
566    C                :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel
567    C     mass2rUnit :: units conversion factor (surface forcing),
568    C                :: from mass per unit area [kg/m2] to vertical r-coordinate unit.
569    C                :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ;
570    C                :: p-coord: = gravity    ( [kg/m2] *  g = [Pa] ) ;
571    C     rUnit2mass :: units conversion factor (surface forcing),
572    C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
573    C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
574    C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
575    C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
576    C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
577    C     radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
578    C     f0         :: Reference coriolis parameter ( 1/s )
579    C                   ( Southern edge f for beta plane )
580    C     beta       :: df/dy ( s^-1.m^-1 )
581    C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
582    C                   of rotation (reference value = 2.Omega.Cos(Phi))
583    C     omega      :: Angular velocity ( rad/s )
584    C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
585    C     viscArNr   :: vertical profile of Eddy viscosity coeff.
586    C                   for vertical mixing of momentum ( units of r^2/s )
587    C     viscAh     :: Eddy viscosity coeff. for mixing of
588    C                   momentum laterally ( m^2/s )
589    C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
590    C                   momentum laterally, no effect for hydrostatic
591    C                   model, defaults to viscAhD if unset ( m^2/s )
592    C                   Not used if variable horiz. viscosity is used.
593    C     viscA4     :: Biharmonic viscosity coeff. for mixing of
594    C                   momentum laterally ( m^4/s )
595    C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
596    C                   momentum laterally, no effect for hydrostatic
597    C                   model, defaults to viscA4D if unset ( m^2/s )
598    C                   Not used if variable horiz. viscosity is used.
599    C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
600    C                   (act on Divergence part) ( m^2/s )
601    C     viscAhZ    :: Eddy viscosity coeff. for mixing of momentum laterally
602    C                   (act on Vorticity  part) ( m^2/s )
603    C     viscA4D    :: Biharmonic viscosity coeff. for mixing of momentum laterally
604    C                   (act on Divergence part) ( m^4/s )
605    C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
606    C                   (act on Vorticity  part) ( m^4/s )
607    C     smag3D_coeff :: Isotropic 3-D Smagorinsky coefficient (-)
608    C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
609    C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
610    C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
611    C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
612    C     viscC2smag   :: Smagorinsky non-dimensional viscosity factor (harmonic)
613    C     viscC4smag   :: Smagorinsky non-dimensional viscosity factor (biharmonic)
614    C     viscAhMax    :: Maximum eddy viscosity coeff. for mixing of
615    C                    momentum laterally ( m^2/s )
616    C     viscAhReMax  :: Maximum gridscale Reynolds number for eddy viscosity
617    C                     coeff. for mixing of momentum laterally (non-dim)
618    C     viscAhGrid   :: non-dimensional grid-size dependent viscosity
619    C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
620    C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
621    C     viscA4Max    :: Maximum biharmonic viscosity coeff. for mixing of
622    C                     momentum laterally ( m^4/s )
623    C     viscA4ReMax  :: Maximum Gridscale Reynolds number for
624    C                     biharmonic viscosity coeff. momentum laterally (non-dim)
625    C     viscA4Grid   :: non-dimensional grid-size dependent bi-harmonic viscosity
626    C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
627    C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
628    C     diffKhT   :: Laplacian diffusion coeff. for mixing of
629  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
630  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  
631  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
632  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
633    C                 for mixing of heat vertically ( units of r^2/s )
634    C     diffKr4T  :: vertical profile of Biharmonic diffusion coeff.
635    C                 for mixing of heat vertically ( units of r^4/s )
636    C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
637  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
638  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  
639  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
640  C     deltaT    - Default timestep ( s )  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
641  C     deltaTMom    - Timestep for momemtum equations ( s )  C                 for mixing of salt vertically ( units of r^2/s ),
642  C     deltaTtracer - Timestep for tracer equations ( s )  C     diffKr4S  :: vertical profile of Biharmonic diffusion coeff.
643  C     tauCD     - CD scheme coupling timescale ( 1/s )  C                 for mixing of salt vertically ( units of r^4/s )
644  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
645  C     startTime - Starting time for this integration ( s ).  C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
646  C     endTime   - Ending time for this integration ( s ).  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
647  C     chkPtFreq - Frequency of check pointing ( s ).  C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
648  C     dumpFreq  - Frequency with which model state is written to  C     BL79LatVary    :: polarwise of this latitude diffKrBL79 is applied with
649  C                 post-processing files ( s ).  C                       gradual transition to diffKrBLEQ towards Equator
650        COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY, deltaT,  C     diffKrBLEQsurf :: same as diffKrBL79surf but at Equator
651       & deltaTmom, deltaTtracer, abeps, startTime, phiMin, thetaMin,  C     diffKrBLEQdeep :: same as diffKrBL79deep but at Equator
652       & rSphere, f0, fCori, beta, viscAh, viscAz, viscA4, diffKhT, diffKzT,  C     diffKrBLEQscl  :: same as diffKrBL79scl but at Equator
653       & diffK4T, diffKhS, diffKzS, diffK4S, delT, tauCD, rCD,  C     diffKrBLEQHo   :: same as diffKrBL79Ho but at Equator
654       & gravity, rhonil, tRef, sRef,  C     deltaT    :: Default timestep ( s )
655       & endTime, chkPtFreq, dumpFreq  C     deltaTClock  :: Timestep used as model "clock". This determines the
656        REAL cg2dTargetResidual  C                    IO frequencies and is used in tagging output. It can
657        REAL delZ(Nz)  C                    be totally different to the dynamical time. Typically
658        REAL delX(Nx)  C                    it will be the deep-water timestep for accelerated runs.
659        REAL delY(Ny)  C                    Frequency of checkpointing and dumping of the model state
660        REAL deltaT  C                    are referenced to this clock. ( s )
661        REAL deltaTmom  C     deltaTMom    :: Timestep for momemtum equations ( s )
662        REAL deltaTtracer  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
663        REAL abeps  C     deltaTFreeSurf :: Timestep for free-surface equation ( s )
664        REAL phiMin  C     freeSurfFac  :: Parameter to turn implicit free surface term on or off
665        REAL thetaMin  C                     freeSurFac = 1. uses implicit free surface
666        REAL rSphere  C                     freeSurFac = 0. uses rigid lid
667        REAL f0  C     abEps        :: Adams-Bashforth-2 stabilizing weight
668        _RL  beta  C     alph_AB      :: Adams-Bashforth-3 primary factor
669        REAL viscAh  C     beta_AB      :: Adams-Bashforth-3 secondary factor
670        REAL viscAz  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
671        REAL viscA4  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
672        REAL diffKhT  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
673        REAL diffKzT  C                     Implicit part of barotropic flow Divergence ( 0-1 )
674        REAL diffK4T  C     implicitNHPress :: parameter of the Crank-Nickelson time stepping :
675        REAL diffKhS  C                     Implicit part of Non-Hydrostatic Pressure Gradient ( 0-1 )
676        REAL diffKzS  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
677        REAL diffK4S  C     hFacMinDz    :: Minimum dimensional size of a cell (affects hFacC etc..., m)
678        REAL delt  C     hFacMinDp    :: Minimum dimensional size of a cell (affects hFacC etc..., Pa)
679        REAL tauCD  C     hFacMinDr    :: Minimum dimensional size of a cell (-> hFacC etc..., r units)
680        REAL rCD  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
681        REAL gravity  C     hFacSup          that control vanishing and creating levels
682        REAL rhonil  C     tauCD         :: CD scheme coupling timescale ( s )
683        REAL tRef(Nz)  C     rCD           :: CD scheme normalised coupling parameter (= 1 - deltaT/tauCD)
684        REAL sRef(Nz)  C     epsAB_CD      :: Adams-Bashforth-2 stabilizing weight used in CD scheme
685        real Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  C     baseTime      :: model base time (time origin) = time @ iteration zero
686        REAL startTime  C     startTime     :: Starting time for this integration ( s ).
687        REAL endTime  C     endTime       :: Ending time for this integration ( s ).
688        REAL chkPtFreq  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
689        REAL dumpFreq  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
690        COMMON /PARM_A/ HeatCapacity_Cp,  C     dumpFreq      :: Frequency with which model state is written to
691       &                Lamba_theta  C                      post-processing files ( s ).
692        REAL HeatCapacity_Cp  C     diagFreq      :: Frequency with which model writes diagnostic output
693        REAL Lamba_theta  C                      of intermediate quantities.
694    C     afFacMom      :: Advection of momentum term tracer parameter
695  C Equation of State (polynomial coeffients)  C     vfFacMom      :: Momentum viscosity tracer parameter
696        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS  C     pfFacMom      :: Momentum pressure forcing tracer parameter
697        REAL eosC(Nz+1,9),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)  C     cfFacMom      :: Coriolis term tracer parameter
698  C Linear equation of state  C     foFacMom      :: Momentum forcing tracer parameter
699  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     mtFacMom      :: Metric terms tracer parameter
700  C     sBeta     - Linear EOS haline contraction coefficient.  C     cosPower      :: Power of cosine of latitude to multiply viscosity
701        COMMON /PARM_EOS_LIN/ tAlpha,sBeta  C     cAdjFreq      :: Frequency of convective adjustment
702        REAL tAlpha  C
703        REAL sBeta  C     taveFreq      :: Frequency with which time-averaged model state
704    C                      is written to post-processing files ( s ).
705    C     tave_lastIter :: (for state variable only) fraction of the last time
706    C                      step (of each taveFreq period) put in the time average.
707    C                      (fraction for 1rst iter = 1 - tave_lastIter)
708    C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
709    C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
710    C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
711    C                         i.e. where |yC| <= latBandClimRelax
712    C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
713    C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
714    C                          (note: externForcingCycle must be an integer
715    C                           number times externForcingPeriod)
716    C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
717    C                       (use model surface (local) value if set to -1)
718    C     temp_EvPrRn :: temperature of Rain & Evap.
719    C     salt_EvPrRn :: salinity of Rain & Evap.
720    C     temp_addMass :: temperature of addMass array
721    C     salt_addMass :: salinity of addMass array
722    C        (notes: a) tracer content of Rain/Evap only used if both
723    C                     NonLin_FrSurf & useRealFreshWater are set.
724    C                b) use model surface (local) value if set to UNSET_RL)
725    C     hMixCriteria:: criteria for mixed-layer diagnostic
726    C     dRhoSmall   :: parameter for mixed-layer diagnostic
727    C     hMixSmooth  :: Smoothing parameter for mixed-layer diag (default=0=no smoothing)
728    C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
729    C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
730    C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
731    C     rSigmaBnd   :: vertical position (in r-unit) of r/sigma transition (Hybrid-Sigma)
732    C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
733    C                           (default=2: full drag ; =1: gives half-slip BC)
734    C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
735    C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
736    C               (if using zcoordinate, units becomes linear: m/s, quadratic: [-])
737    C     smoothAbsFuncRange :: 1/2 of interval around zero, for which FORTRAN ABS
738    C                           is to be replace by a smoother function
739    C                           (affects myabs, mymin, mymax)
740    C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
741    C                      (i.e. allows convection at different Rayleigh numbers)
742    C     tCylIn        :: Temperature of the cylinder inner boundary
743    C     tCylOut       :: Temperature of the cylinder outer boundary
744    C     phiEuler      :: Euler angle, rotation about original z-axis
745    C     thetaEuler    :: Euler angle, rotation about new x-axis
746    C     psiEuler      :: Euler angle, rotation about new z-axis
747          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
748         & cg2dpcOffDFac, cg3dTargetResidual,
749         & delR, delRc, xgOrigin, ygOrigin,
750         & deltaT, deltaTMom, dTtracerLev, deltaTFreeSurf, deltaTClock,
751         & abEps, alph_AB, beta_AB,
752         & rSphere, recip_rSphere, radius_fromHorizGrid,
753         & f0, beta, fPrime, omega, rotationPeriod,
754         & viscFacAdj, viscAh, viscAhW, smag3D_coeff,
755         & viscAhMax, viscAhGrid, viscAhGridMax, viscAhGridMin,
756         & viscC2leith, viscC2leithD,
757         & viscC2smag, viscC4smag,
758         & viscAhD, viscAhZ, viscA4D, viscA4Z,
759         & viscA4, viscA4W, viscA4Max,
760         & viscA4Grid, viscA4GridMax, viscA4GridMin,
761         & viscAhReMax, viscA4ReMax,
762         & viscC4leith, viscC4leithD, viscArNr,
763         & diffKhT, diffK4T, diffKrNrT, diffKr4T,
764         & diffKhS, diffK4S, diffKrNrS, diffKr4S,
765         & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
766         & BL79LatVary,
767         & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
768         & tauCD, rCD, epsAB_CD,
769         & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
770         & hFacMin, hFacMinDz, hFacInf, hFacSup,
771         & gravity, recip_gravity, gBaro,
772         & rhoNil, rhoConst, recip_rhoConst, thetaConst,
773         & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
774         & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
775         & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
776         & baseTime, startTime, endTime,
777         & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
778         & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
779         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
780         & cosPower, cAdjFreq,
781         & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
782         & externForcingCycle, externForcingPeriod,
783         & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
784         & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
785         & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth,
786         & Ro_SeaLevel, rSigmaBnd,
787         & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
788         & smoothAbsFuncRange,
789         & tCylIn, tCylOut,
790         & phiEuler, thetaEuler, psiEuler
791    
792          _RL cg2dTargetResidual
793          _RL cg2dTargetResWunit
794          _RL cg3dTargetResidual
795          _RL cg2dpcOffDFac
796          _RL delR(Nr)
797          _RL delRc(Nr+1)
798          _RL xgOrigin
799          _RL ygOrigin
800          _RL deltaT
801          _RL deltaTClock
802          _RL deltaTMom
803          _RL dTtracerLev(Nr)
804          _RL deltaTFreeSurf
805          _RL abEps, alph_AB, beta_AB
806          _RL rSphere
807          _RL recip_rSphere
808          _RL radius_fromHorizGrid
809          _RL f0
810          _RL beta
811          _RL fPrime
812          _RL omega
813          _RL rotationPeriod
814          _RL freeSurfFac
815          _RL implicSurfPress
816          _RL implicDiv2Dflow
817          _RL implicitNHPress
818          _RL hFacMin
819          _RL hFacMinDz
820          _RL hFacMinDp
821          _RL hFacMinDr
822          _RL hFacInf
823          _RL hFacSup
824          _RL viscArNr(Nr)
825          _RL viscFacAdj
826          _RL viscAh
827          _RL viscAhW
828          _RL viscAhD
829          _RL viscAhZ
830          _RL smag3D_coeff
831          _RL viscAhMax
832          _RL viscAhReMax
833          _RL viscAhGrid, viscAhGridMax, viscAhGridMin
834          _RL viscC2leith
835          _RL viscC2leithD
836          _RL viscC2smag
837          _RL viscA4
838          _RL viscA4W
839          _RL viscA4D
840          _RL viscA4Z
841          _RL viscA4Max
842          _RL viscA4ReMax
843          _RL viscA4Grid, viscA4GridMax, viscA4GridMin
844          _RL viscC4leith
845          _RL viscC4leithD
846          _RL viscC4smag
847          _RL diffKhT
848          _RL diffK4T
849          _RL diffKrNrT(Nr)
850          _RL diffKr4T(Nr)
851          _RL diffKhS
852          _RL diffK4S
853          _RL diffKrNrS(Nr)
854          _RL diffKr4S(Nr)
855          _RL diffKrBL79surf
856          _RL diffKrBL79deep
857          _RL diffKrBL79scl
858          _RL diffKrBL79Ho
859          _RL BL79LatVary
860          _RL diffKrBLEQsurf
861          _RL diffKrBLEQdeep
862          _RL diffKrBLEQscl
863          _RL diffKrBLEQHo
864          _RL tauCD, rCD, epsAB_CD
865          _RL gravity
866          _RL recip_gravity
867          _RL gBaro
868          _RL rhoNil
869          _RL rhoConst,      recip_rhoConst
870          _RL thetaConst
871          _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
872          _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
873          _RL rhoConstFresh
874          _RL rho1Ref(Nr)
875          _RL tRef(Nr)
876          _RL sRef(Nr)
877          _RL phiRef(2*Nr+1)
878          _RL dBdrRef(Nr)
879          _RL rVel2wUnit(Nr+1), wUnit2rVel(Nr+1)
880          _RL mass2rUnit, rUnit2mass
881          _RL baseTime
882          _RL startTime
883          _RL endTime
884          _RL chkPtFreq
885          _RL pChkPtFreq
886          _RL dumpFreq
887          _RL adjDumpFreq
888          _RL diagFreq
889          _RL taveFreq
890          _RL tave_lastIter
891          _RL monitorFreq
892          _RL adjMonitorFreq
893          _RL afFacMom
894          _RL vfFacMom
895          _RL pfFacMom
896          _RL cfFacMom
897          _RL foFacMom
898          _RL mtFacMom
899          _RL cosPower
900          _RL cAdjFreq
901          _RL tauThetaClimRelax
902          _RL tauSaltClimRelax
903          _RL latBandClimRelax
904          _RL externForcingCycle
905          _RL externForcingPeriod
906          _RL convertFW2Salt
907          _RL temp_EvPrRn
908          _RL salt_EvPrRn
909          _RL temp_addMass
910          _RL salt_addMass
911          _RL ivdc_kappa
912          _RL hMixCriteria
913          _RL dRhoSmall
914          _RL hMixSmooth
915          _RL Ro_SeaLevel
916          _RL rSigmaBnd
917          _RL sideDragFactor
918          _RL bottomDragLinear
919          _RL bottomDragQuadratic
920          _RL smoothAbsFuncRange
921          _RL nh_Am2
922          _RL tCylIn, tCylOut
923          _RL phiEuler, thetaEuler, psiEuler
924    
925    C--   COMMON /PARM_A/ Thermodynamics constants ?
926          COMMON /PARM_A/ HeatCapacity_Cp
927          _RL HeatCapacity_Cp
928    
929    C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
930    C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
931    C     atm_Po    :: standard reference pressure
932    C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
933    C     atm_Rd    :: gas constant for dry air
934    C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
935    C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
936    C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
937    C     integr_GeoPot :: option to select the way we integrate the geopotential
938    C                     (still a subject of discussions ...)
939    C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
940    C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
941          COMMON /PARM_ATM/
942         &            celsius2K,
943         &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
944         &            integr_GeoPot, selectFindRoSurf
945          _RL celsius2K
946          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
947          INTEGER integr_GeoPot, selectFindRoSurf
948    
949    C Logical flags for selecting packages
950          LOGICAL useGAD
951          LOGICAL useOBCS
952          LOGICAL useSHAP_FILT
953          LOGICAL useZONAL_FILT
954          LOGICAL useOPPS
955          LOGICAL usePP81
956          LOGICAL useKL10
957          LOGICAL useMY82
958          LOGICAL useGGL90
959          LOGICAL useKPP
960          LOGICAL useGMRedi
961          LOGICAL useDOWN_SLOPE
962          LOGICAL useBBL
963          LOGICAL useCAL
964          LOGICAL useEXF
965          LOGICAL useBulkForce
966          LOGICAL useEBM
967          LOGICAL useCheapAML
968          LOGICAL useGrdchk
969          LOGICAL useSMOOTH
970          LOGICAL usePROFILES
971          LOGICAL useECCO
972          LOGICAL useCTRL
973          LOGICAL useSBO
974          LOGICAL useFLT
975          LOGICAL usePTRACERS
976          LOGICAL useGCHEM
977          LOGICAL useRBCS
978          LOGICAL useOffLine
979          LOGICAL useMATRIX
980          LOGICAL useFRAZIL
981          LOGICAL useSEAICE
982          LOGICAL useSALT_PLUME
983          LOGICAL useShelfIce
984          LOGICAL useStreamIce
985          LOGICAL useICEFRONT
986          LOGICAL useThSIce
987          LOGICAL useLand
988          LOGICAL useATM2d
989          LOGICAL useAIM
990          LOGICAL useAtm_Phys
991          LOGICAL useFizhi
992          LOGICAL useGridAlt
993          LOGICAL useDiagnostics
994          LOGICAL useREGRID
995          LOGICAL useLayers
996          LOGICAL useMNC
997          LOGICAL useRunClock
998          LOGICAL useEMBED_FILES
999          LOGICAL useMYPACKAGE
1000          COMMON /PARM_PACKAGES/
1001         &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
1002         &        useOPPS, usePP81, useKL10, useMY82, useGGL90, useKPP,
1003         &        useGMRedi, useBBL, useDOWN_SLOPE, useCTRL,
1004         &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
1005         &        useGrdchk,useSMOOTH,usePROFILES,useECCO,useSBO, useFLT,
1006         &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
1007         &        useFRAZIL, useSEAICE, useSALT_PLUME, useShelfIce,
1008         &        useStreamIce, useICEFRONT, useThSIce, useLand,
1009         &        useATM2D, useAIM, useAtm_Phys, useFizhi, useGridAlt,
1010         &        useDiagnostics, useREGRID, useLayers, useMNC,
1011         &        useRunClock, useEMBED_FILES,
1012         &        useMYPACKAGE
1013    
1014    CEH3 ;;; Local Variables: ***
1015    CEH3 ;;; mode:fortran ***
1016    CEH3 ;;; End: ***

Legend:
Removed from v.1.5  
changed lines
  Added in v.1.277

  ViewVC Help
Powered by ViewVC 1.1.22