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

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.259

  ViewVC Help
Powered by ViewVC 1.1.22