/[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.21 by adcroft, Thu Jul 16 15:23:43 1998 UTC revision 1.252 by jmc, Wed Jun 8 01:23:52 2011 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2    C $Name$
3  C  C
4  C     /==========================================================\  
5  C     | PARAMS.h                                                 |  CBOP
6  C     | o Header file defining model "parameters".               |  C     !ROUTINE: PARAMS.h
7  C     |==========================================================|  C     !INTERFACE:
8  C     | The values from the model's standard input file are      |  C     #include PARAMS.h
9  C     | stored into the variables held here. Notes describing    |  
10  C     | the parameters can also be found here.                   |  C     !DESCRIPTION:
11  C     \==========================================================/  C     Header file defining model "parameters".  The values from the
12    C     model standard input file are stored into the variables held
13    C     here. Notes describing the parameters can also be found here.
14    
15    CEOP
16    
17  C     Macros for special grid options  C     Macros for special grid options
18  #include "PARAMS_MACROS.h"  #include "PARAMS_MACROS.h"
# Line 19  C     Useful physical values Line 24  C     Useful physical values
24        Real*8 deg2rad        Real*8 deg2rad
25        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
26    
 C     Symbolic values  
 C     precXXXX - Used to indicate what precision to use for  
 C                dumping model state.  
       INTEGER precFloat32  
       PARAMETER ( precFloat32 = 0 )  
       INTEGER precFloat64  
       PARAMETER ( precFloat64 = 1 )  
   
 C     Checkpoint data  
       INTEGER maxNoChkptLev  
       PARAMETER ( maxNoChkptLev = 2 )  
   
27  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
28  C     checkPtSuff - List of checkpoint file suffices  C     buoyancyRelation :: Flag used to indicate which relation to use to
29  C     bathyFile   - File containing bathymetry. If not defined bathymetry  C                         get buoyancy.
30  C                   is taken from inline function.  C     eosType         :: choose the equation of state:
31  C     hydrogThetaFile - File containing initial hydrographic data for potential  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
32  C                       temperature.  C     pickupSuff      :: force to start from pickup files (even if nIter0=0)
33  C     hydrogSaltFile  - File containing initial hydrographic data for salinity.  C                        and read pickup files with this suffix (max 10 Char.)
34  C     zonalWindFile   - File containing zonal wind data  C     mdsioLocalDir   :: read-write tiled file from/to this directory name
35  C     meridWindFile   - File containing meridional wind data  C                        (+ 4 digits Processor-Rank) instead of current dir.
36  C     thetaClimFile   - File containing theta climataology used  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*)  C                       in relaxation term -lambda(theta-theta*)
68  C     saltClimFile    - File containing salt climataology used  C     saltClimFile    :: File containing surface salt climataology used
69  C                       in relaxation term -lambda(salt-salt*)  C                       in relaxation term -lambda(salt-salt*)
70        COMMON /PARM_C/ checkPtSuff,  C     surfQfile       :: File containing surface heat flux, excluding SW
71       &                bathyFile, hydrogThetaFile, hydrogSaltFile,  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,       &                zonalWindFile, meridWindFile, thetaClimFile,
95       &                saltClimFile       &                saltClimFile,
96        CHARACTER*(5) checkPtSuff(maxNoChkptLev)       &                EmPmRfile, saltFluxFile,
97        CHARACTER*(MAX_LEN_FNAM) bathyFile       &                surfQfile, surfQnetFile, surfQswFile,
98        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile       &                lambdaThetaFile, lambdaSaltFile,
99        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile       &                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        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
125        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
126        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
127        CHARACTER*(MAX_LEN_FNAM) saltClimFile        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     writeStatePrec      - Precision used for writing model state.  C     writeBinaryPrec     :: Precision used for writing binary files
160  C     writeBinaryPrec     - Precision used for writing binary files  C     readBinaryPrec      :: Precision used for reading binary files
161  C     readBinaryPrec      - Precision used for reading binary files  C     selectCoriMap       :: select setting of Coriolis parameter map:
162  C     nCheckLev           - Holds current checkpoint level  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, nCheckLev,       &        writeStatePrec,
197       &        writeBinaryPrec, readBinaryPrec       &        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        INTEGER writeStatePrec
218        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
219        INTEGER readBinaryPrec        INTEGER readBinaryPrec
220        INTEGER nCheckLev        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     momPressureForcing - Flag which turns pressure term in momentum equation  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
255    C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
256    C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
257    C- Momentum params:
258    C     no_slip_sides  :: Impose "no-slip" at lateral boundaries.
259    C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
260    C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
261    C                       on irregular grids)
262    C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
263    C     useAreaViscLength :: Set to true to use old scaling for viscous lengths,
264    C                          e.g., L2=Raz.  May be preferable for cube sphere.
265    C     momViscosity  :: Flag which turns momentum friction terms on and off.
266    C     momAdvection  :: Flag which turns advection of momentum on and off.
267    C     momForcing    :: Flag which turns external forcing of momentum on
268    C                      and off.
269    C     momPressureForcing :: Flag which turns pressure term in momentum equation
270  C                          on and off.  C                          on and off.
271  C     metricTerms   - Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
272  C     usingSphericalPolarMTerms - If TRUE use spherical polar metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
273  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
274  C     tempDiffusion - Flag which turns diffusion of temperature on  C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
275  C                     and off.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
276  C     tempAdvection - Flag which turns advection of temperature on  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
277  C                     and off.  C                                (default = F = use mom_fluxform package)
278  C     tempForcing   - Flag which turns external forcing of temperature on  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986)
279  C                     and off.  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
280  C     saltDiffusion - Flag which turns diffusion of salinit on  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
281  C                     and off.  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
282  C     saltAdvection - Flag which turns advection of salinit on  C     useAbsVorticity :: work with f+zeta in Coriolis terms
283  C                     and off.  C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
284  C     saltForcing   - Flag which turns external forcing of salinit on  C     momStepping    :: Turns momentum equation time-stepping off
285  C                     and off.  C- Temp. & Salt params:
286  C     implicitFreeSurface - Set to true to use implcit free surface  C     tempStepping   :: Turns temperature equation time-stepping off
287  C     rigidLid            - Set to true to use rigid lid  C     saltStepping   :: Turns salinity equation time-stepping off
288  C     momStepping   - Turns momentum equation time-stepping off  C     tempAdvection  :: Flag which turns advection of temperature on and off.
289  C     tempStepping  - Turns temperature equation time-stepping off  C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
290  C     saltStepping  - Turns salinity equation time-stepping off  C     tempForcing    :: Flag which turns external forcing of temperature on
291  C     useConstantF  - Coriolis parameter set to f0  C                       and off.
292  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y  C     saltAdvection  :: Flag which turns advection of salinity on and off.
293  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)  C     saltIsActiveTr :: Salinity  is a dynamically active tracer
294  C     implicitDiffusion - Turns implicit vertical diffusion on  C     saltForcing    :: Flag which turns external forcing of salinity on
295  C     doThetaClimRelax - Set true if relaxation to temperature  C                       and off.
296    C     maskIniTemp    :: apply mask to initial Pot.Temp.
297    C     maskIniSalt    :: apply mask to initial salinity
298    C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
299    C     checkIniSalt   :: check for points with identically zero initial salinity
300    C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
301    C                         as a real Fresh Water (=> changes the Sea Level)
302    C                         if F, converts P+R-E to salt flux (no SL effect)
303    C- Pressure solver related parameters (PARM02)
304    C     useSRCGSolver  :: Set to true to use conjugate gradient
305    C                       solver with single reduction (only one call of
306    C                       s/r mpi_allreduce), default is false
307    C- Time-stepping params:
308    C     rigidLid            :: Set to true to use rigid lid
309    C     implicitFreeSurface :: Set to true to use implicit free surface
310    C     exactConserv        :: Set to true to conserve exactly the total Volume
311    C     linFSConserveTr     :: Set to true to correct source/sink of tracer
312    C                            at the surface due to Linear Free Surface
313    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
314    C                            linear relation Phi_surf = Bo_surf*eta
315    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
316    C     nonHydrostatic   :: Using non-hydrostatic algorithm
317    C     use3Dsolver      :: set to true to use 3-D pressure solver
318    C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
319    C     staggerTimeStep   :: enable a Stagger time stepping U,V (& W) then T,S
320    C     implicitDiffusion :: Turns implicit vertical diffusion on
321    C     implicitViscosity :: Turns implicit vertical viscosity on
322    C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
323    C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity
324    C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
325    C     multiDimAdvection :: Flag that enable multi-dimension advection
326    C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
327    C     momDissip_In_AB   :: if False, put Dissipation tendency contribution
328    C                          out off Adams-Bashforth time stepping.
329    C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
330    C                          apply AB on tracer tendencies (rather than on Tracer)
331    C- Other forcing params -
332    C     balanceEmPmR    :: substract global mean of EmPmR at every time step
333    C     balanceQnet     :: substract global mean of Qnet at every time step
334    C     balancePrintMean:: print substracted global means to STDOUT
335    C     doThetaClimRelax :: Set true if relaxation to temperature
336  C                        climatology is required.  C                        climatology is required.
337  C     doSaltClimRelax  - Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
338  C                        climatology is required.  C                        climatology is required.
339  C     periodicExternalForcing - Set true if forcing is time-dependant  C     allowFreezing  :: Allows surface water to freeze and form ice
340        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,  C     allowInteriorFreezing :: Allow water at depth to freeze and rise to the surface
341       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
342       & tempDiffusion, tempAdvection, tempForcing,  C     periodicExternalForcing :: Set true if forcing is time-dependant
343       & saltDiffusion, saltAdvection, saltForcing,  C- I/O parameters -
344       & implicitFreeSurface, rigidLid,  C     globalFiles    :: Selects between "global" and "tiled" files.
345    C                       On some platforms with MPI, option globalFiles is either
346    C                       slow or does not work. Use useSingleCpuIO instead.
347    C     useSingleCpuIO :: moved to EEPARAMS.h
348    C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
349    C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
350    C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
351    C                           before checkpoint-54a, Jul 06, 2004.
352    C     pickup_write_mdsio :: use mdsio to write pickups
353    C     pickup_read_mdsio  :: use mdsio to read  pickups
354    C     pickup_write_immed :: echo the pickup immediately (for conversion)
355    C     writePickupAtEnd   :: write pickup at the last timestep
356    C     timeave_mdsio      :: use mdsio for timeave output
357    C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
358    C     monitor_stdio      :: use stdio for monitor output
359    C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
360    C                        & Last iteration, in addition multiple of dumpFreq iter.
361    C     printDomain     :: controls printing of domain fields (bathy, hFac ...).
362    
363          COMMON /PARM_L/
364         & fluidIsAir, fluidIsWater,
365         & usingPCoords, usingZCoords, useDynP_inEos_Zc,
366         & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
367         & usingCurvilinearGrid, usingCylindricalGrid,
368         & deepAtmosphere, setInterFDr, setCenterDr,
369         & no_slip_sides, no_slip_bottom,
370         & useFullLeith, useStrainTensionVisc, useAreaViscLength,
371         & momViscosity, momAdvection, momForcing,
372         & momPressureForcing, metricTerms, useNHMTerms,
373         & useCoriolis, use3dCoriolis,
374         & useCDscheme, vectorInvariantMomentum,
375         & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
376         & upwindVorticity, highOrderVorticity,
377         & useAbsVorticity, upwindShear,
378       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
379       & metricTerms, usingSphericalPolarMTerms,       & tempAdvection, tempIsActiveTr, tempForcing,
380       & useConstantF, useBetaPlaneF, useSphereF,       & saltAdvection, saltIsActiveTr, saltForcing,
381       & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
382       & periodicExternalForcing       & useRealFreshWaterFlux, useSRCGSolver,
383         & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
384         & uniformLin_PhiSurf,
385         & quasiHydrostatic, nonHydrostatic,
386         & use3Dsolver, implicitIntGravWave, staggerTimeStep,
387         & implicitDiffusion, implicitViscosity,
388         & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
389         & multiDimAdvection, useMultiDimAdvec,
390         & momDissip_In_AB, doAB_onGtGs,
391         & balanceEmPmR, balanceQnet, balancePrintMean,
392         & doThetaClimRelax, doSaltClimRelax,
393         & allowFreezing, allowInteriorFreezing, useOldFreezing,
394         & periodicExternalForcing,
395         & globalFiles,
396         & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
397         & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
398         & writePickupAtEnd,
399         & timeave_mdsio, snapshot_mdsio, monitor_stdio,
400         & outputTypesInclusive, dumpInitAndLast,
401         & printDomain,
402         & inAdMode, inAdTrue, inAdFalse, inAdExact
403    
404          LOGICAL fluidIsAir
405          LOGICAL fluidIsWater
406          LOGICAL usingPCoords
407          LOGICAL usingZCoords
408          LOGICAL useDynP_inEos_Zc
409        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
410        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid, rotateGrid
411        LOGICAL usingSphericalPolarMTerms        LOGICAL usingCylindricalGrid
412          LOGICAL usingCurvilinearGrid
413          LOGICAL deepAtmosphere
414          LOGICAL setInterFDr
415          LOGICAL setCenterDr
416          LOGICAL useNHMTerms
417          LOGICAL no_slip_sides
418          LOGICAL no_slip_bottom
419          LOGICAL useFullLeith
420          LOGICAL useStrainTensionVisc
421          LOGICAL useAreaViscLength
422        LOGICAL momViscosity        LOGICAL momViscosity
423        LOGICAL momAdvection        LOGICAL momAdvection
424        LOGICAL momForcing        LOGICAL momForcing
425        LOGICAL momPressureForcing        LOGICAL momPressureForcing
426        LOGICAL useCoriolis        LOGICAL useCoriolis
427        LOGICAL tempDiffusion        LOGICAL vectorInvariantMomentum
428        LOGICAL tempAdvection        LOGICAL tempAdvection
429          LOGICAL tempIsActiveTr
430        LOGICAL tempForcing        LOGICAL tempForcing
       LOGICAL saltDiffusion  
431        LOGICAL saltAdvection        LOGICAL saltAdvection
432          LOGICAL saltIsActiveTr
433        LOGICAL saltForcing        LOGICAL saltForcing
434        LOGICAL implicitFreeSurface        LOGICAL maskIniTemp
435          LOGICAL maskIniSalt
436          LOGICAL checkIniTemp
437          LOGICAL checkIniSalt
438          LOGICAL useRealFreshWaterFlux
439          LOGICAL useSRCGSolver
440        LOGICAL rigidLid        LOGICAL rigidLid
441          LOGICAL implicitFreeSurface
442          LOGICAL exactConserv
443          LOGICAL linFSConserveTr
444          LOGICAL uniformLin_PhiSurf
445          LOGICAL quasiHydrostatic
446          LOGICAL nonHydrostatic
447          LOGICAL use3Dsolver
448          LOGICAL implicitIntGravWave
449          LOGICAL staggerTimeStep
450        LOGICAL momStepping        LOGICAL momStepping
451        LOGICAL tempStepping        LOGICAL tempStepping
452        LOGICAL saltStepping        LOGICAL saltStepping
453        LOGICAL metricTerms        LOGICAL metricTerms
454        LOGICAL useConstantF        LOGICAL use3dCoriolis
455        LOGICAL useBetaPlaneF        LOGICAL useCDscheme
456        LOGICAL useSphereF        LOGICAL useEnergyConservingCoriolis
457          LOGICAL useJamartWetPoints
458          LOGICAL useJamartMomAdv
459          LOGICAL upwindVorticity
460          LOGICAL highOrderVorticity
461          LOGICAL useAbsVorticity
462          LOGICAL upwindShear
463        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
464          LOGICAL implicitViscosity
465          LOGICAL tempImplVertAdv
466          LOGICAL saltImplVertAdv
467          LOGICAL momImplVertAdv
468          LOGICAL multiDimAdvection
469          LOGICAL useMultiDimAdvec
470          LOGICAL momDissip_In_AB
471          LOGICAL doAB_onGtGs
472          LOGICAL balanceEmPmR
473          LOGICAL balanceQnet
474          LOGICAL balancePrintMean
475        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
476        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
477          LOGICAL allowFreezing
478          LOGICAL allowInteriorFreezing
479          LOGICAL useOldFreezing
480        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
481          LOGICAL globalFiles
482          LOGICAL pickupStrictlyMatch
483          LOGICAL usePickupBeforeC54
484          LOGICAL startFromPickupAB2
485          LOGICAL pickup_read_mdsio, pickup_write_mdsio
486          LOGICAL pickup_write_immed, writePickupAtEnd
487          LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
488          LOGICAL outputTypesInclusive
489          LOGICAL dumpInitAndLast
490          LOGICAL printDomain
491          LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
492    
493  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
494  C     cg2dTargetResidual  C     cg2dTargetResidual
495  C               - Target residual for cg2d solver.  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
496  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dTargetResWunit
497    C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
498    C     cg3dTargetResidual
499    C               :: Target residual for cg3d solver.
500    C     cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
501  C     Note. 20th May 1998  C     Note. 20th May 1998
502  C           I made a weird discovery! In the model paper we argue  C           I made a weird discovery! In the model paper we argue
503  C           for the form of the preconditioner used here ( see  C           for the form of the preconditioner used here ( see
# Line 182  C           number of iterations for con Line 511  C           number of iterations for con
511  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
512  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
513  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
514  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     delR      :: Vertical grid spacing ( units of r ).
515  C                 between "w" surfaces.  C     delRc     :: Vertical grid spacing between cell centers (r unit).
516  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
517  C     delY        on input flags.  C     delY        on input flags.
518  C     gravity   - Accel. due to gravity ( m/s^2 )  C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
519  C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )  C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
520  C     ronil     - Reference density  C                :: parameter but it makes geographical references simple.)
521  C     startTime - Start time for model ( s )  C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
522  C     phiMin    - Latitude of southern most cell face.  C                :: most face (Lat-Lon grid).
523  C     thetaMin  - Longitude of western most cell face (this  C     gravity   :: Accel. due to gravity ( m/s^2 )
524  C                 is an "inert" parameter but it is included  C     recip_gravity and its inverse
525  C                 to make geographical references simple.)  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
526  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rhoNil    :: Reference density for the linear equation of state
527  C     rRSphere  - Reciprocal radius of sphere for a spherical polar grid ( m ).  C     rhoConst  :: Vertically constant reference density
528  C     f0        - Reference coriolis parameter ( 1/s )  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
529  C                 ( Southern edge f for beta plane )  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
530  C     beta      - df/dy ( s^-1.m^-1 )  C     rhoConstFresh :: Constant reference density for fresh water (rain)
531  C     omega     - Angular velocity ( rad/s )  C     rho1Ref   :: reference vertical profile for density
532  C     viscAh    - Eddy viscosity coeff. for mixing of  C     tRef      :: reference vertical profile for potential temperature
533  C                 momentum laterally ( m^2/s )  C     sRef      :: reference vertical profile for salinity/specific humidity
534  C     viscAz    - Eddy viscosity coeff. for mixing of  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
535  C                 momentum vertically ( m^2/s )  C     dBdrRef   :: vertical gradient of reference buoyancy  [(m/s/r)^2]:
536  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
537  C                 momentum laterally ( m^4/s )  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
538  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
539    C                :: from r-coordinate vertical velocity to vertical velocity [m/s].
540    C                :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit
541    C     wUnit2rVel :: units conversion factor (Non-Hydrostatic code),
542    C                :: from vertical velocity [m/s] to r-coordinate vertical velocity.
543    C                :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel
544    C     mass2rUnit :: units conversion factor (surface forcing),
545    C                :: from mass per unit area [kg/m2] to vertical r-coordinate unit.
546    C                :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ;
547    C                :: p-coord: = gravity    ( [kg/m2] *  g = [Pa] ) ;
548    C     rUnit2mass :: units conversion factor (surface forcing),
549    C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
550    C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
551    C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
552    C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
553    C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
554    C     radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
555    C     f0         :: Reference coriolis parameter ( 1/s )
556    C                   ( Southern edge f for beta plane )
557    C     beta       :: df/dy ( s^-1.m^-1 )
558    C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
559    C                   of rotation (reference value = 2.Omega.Cos(Phi))
560    C     omega      :: Angular velocity ( rad/s )
561    C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
562    C     viscArNr   :: vertical profile of Eddy viscosity coeff.
563    C                   for vertical mixing of momentum ( units of r^2/s )
564    C     viscAh     :: Eddy viscosity coeff. for mixing of
565    C                   momentum laterally ( m^2/s )
566    C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
567    C                   momentum laterally, no effect for hydrostatic
568    C                   model, defaults to viscAh if unset ( m^2/s )
569    C                   Not used if variable horiz. viscosity is used.
570    C     viscA4     :: Biharmonic viscosity coeff. for mixing of
571    C                   momentum laterally ( m^4/s )
572    C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
573    C                   momentum laterally, no effect for hydrostatic
574    C                   model, defaults to viscA4 if unset ( m^2/s )
575    C                   Not used if variable horiz. viscosity is used.
576    C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
577    C                   (act on Divergence part) ( m^2/s )
578    C     viscAhZ    :: Eddy viscosity coeff. for mixing of momentum laterally
579    C                   (act on Vorticity  part) ( m^2/s )
580    C     viscA4D    :: Biharmonic viscosity coeff. for mixing of momentum laterally
581    C                   (act on Divergence part) ( m^4/s )
582    C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
583    C                   (act on Vorticity  part) ( m^4/s )
584    C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
585    C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
586    C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
587    C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
588    C     viscC2smag   :: Smagorinsky non-dimensional viscosity factor (harmonic)
589    C     viscC4smag   :: Smagorinsky non-dimensional viscosity factor (biharmonic)
590    C     viscAhMax    :: Maximum eddy viscosity coeff. for mixing of
591    C                    momentum laterally ( m^2/s )
592    C     viscAhReMax  :: Maximum gridscale Reynolds number for eddy viscosity
593    C                     coeff. for mixing of momentum laterally (non-dim)
594    C     viscAhGrid   :: non-dimensional grid-size dependent viscosity
595    C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
596    C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
597    C     viscA4Max    :: Maximum biharmonic viscosity coeff. for mixing of
598    C                     momentum laterally ( m^4/s )
599    C     viscA4ReMax  :: Maximum Gridscale Reynolds number for
600    C                     biharmonic viscosity coeff. momentum laterally (non-dim)
601    C     viscA4Grid   :: non-dimensional grid-size dependent bi-harmonic viscosity
602    C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
603    C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
604    C     diffKhT   :: Laplacian diffusion coeff. for mixing of
605  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
606  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
607  C                 heat vertically ( m^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
608  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
609  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
610  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
611  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
612  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
613  C                 salt vertically ( m^2/s )  C                 for mixing of salt vertically ( units of r^2/s ),
614  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
615  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
616  C     deltaT    - Default timestep ( s )  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
617  C     deltaTClock  - Timestep used as model "clock". This determines the  C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
618    C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
619    C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
620    C     BL79LatVary    :: polarwise of this latitude diffKrBL79 is applied with
621    C                       gradual transition to diffKrBLEQ towards Equator
622    C     diffKrBLEQsurf :: same as diffKrBL79surf but at Equator
623    C     diffKrBLEQdeep :: same as diffKrBL79deep but at Equator
624    C     diffKrBLEQscl  :: same as diffKrBL79scl but at Equator
625    C     diffKrBLEQHo   :: same as diffKrBL79Ho but at Equator
626    C     deltaT    :: Default timestep ( s )
627    C     deltaTClock  :: Timestep used as model "clock". This determines the
628  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
629  C                    be totally different to the dynamical time. Typically  C                    be totally different to the dynamical time. Typically
630  C                    it will be the deep-water timestep for accelerated runs.  C                    it will be the deep-water timestep for accelerated runs.
631  C                    Frequency of checkpointing and dumping of the model state  C                    Frequency of checkpointing and dumping of the model state
632  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
633  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
634  C     deltaTtracer - Timestep for tracer equations ( s )  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
635  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
636    C     freesurfFac  :: Parameter to turn implicit free surface term on or off
637  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
638  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
639  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     abEps        :: Adams-Bashforth-2 stabilizing weight
640  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C     alph_AB      :: Adams-Bashforth-3 primary factor
641  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C     beta_AB      :: Adams-Bashforth-3 secondary factor
642  C     GMlength  - Length to use in Visbeck et al. formula for K (m)  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
643  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
644  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
645  C     GMkbackground - background value of GM/Redi coefficient  C                     Implicit part of barotropic flow Divergence ( 0-1 )
646  C     GMmaxval  - max. value of KapGM allowed in GM/Redi scheme  C     implicitNHPress :: parameter of the Crank-Nickelson time stepping :
647  C     startTime - Starting time for this integration ( s ).  C                     Implicit part of Non-Hydrostatic Pressure Gradient ( 0-1 )
648  C     endTime   - Ending time for this integration ( s ).  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
649  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     hFacMinDz    :: Minimum dimensional size of a cell (affects hFacC etc..., m)
650  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     hFacMinDp    :: Minimum dimensional size of a cell (affects hFacC etc..., Pa)
651  C     dumpFreq  - Frequency with which model state is written to  C     hFacMinDr    :: Minimum dimensional size of a cell (-> hFacC etc..., r units)
652  C                 post-processing files ( s ).  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
653  C     taveFreq  - Frequency with which time-averaged model state is written to  C     hFacSup          that control vanishing and creating levels
654  C                 post-processing files ( s ).  C     tauCD         :: CD scheme coupling timescale ( s )
655  C     afFacMom  - Advection of momentum term scaling parameter  C     rCD           :: CD scheme normalised coupling parameter (= 1 - deltaT/tauCD)
656  C     vfFacMom  - Momentum viscosity scaling parameter  C     epsAB_CD      :: Adams-Bashforth-2 stabilizing weight used in CD scheme
657  C     pfFacMom  - Momentum pressure forcing parameter  C     baseTime      :: model base time (time origin) = time @ iteration zero
658  C     cfFacMom  - Coriolis term scaling parameter  C     startTime     :: Starting time for this integration ( s ).
659  C     foFacMom  - Momentum forcing scaling parameter  C     endTime       :: Ending time for this integration ( s ).
660  C     mtFacMom  - Metric terms scaling parameter  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
661  C     cAdjFreq  - Frequency of convective adjustment  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
662  C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).  C     dumpFreq      :: Frequency with which model state is written to
663  C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).  C                     post-processing files ( s ).
664  C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).  C     diagFreq      :: Frequency with which model writes diagnostic output
665  C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).  C                     of intermediate quantities.
666  C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)  C     afFacMom      :: Advection of momentum term tracer parameter
667  C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)  C     vfFacMom      :: Momentum viscosity tracer parameter
668    C     pfFacMom      :: Momentum pressure forcing tracer parameter
669    C     cfFacMom      :: Coriolis term tracer parameter
670    C     foFacMom      :: Momentum forcing tracer parameter
671    C     mtFacMom      :: Metric terms tracer parameter
672    C     cosPower      :: Power of cosine of latitude to multiply viscosity
673    C     cAdjFreq      :: Frequency of convective adjustment
674    C
675    C     taveFreq      :: Frequency with which time-averaged model state
676    C                      is written to post-processing files ( s ).
677    C     tave_lastIter :: (for state variable only) fraction of the last time
678    C                      step (of each taveFreq period) put in the time average.
679    C                      (fraction for 1rst iter = 1 - tave_lastIter)
680    C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
681    C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
682    C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
683    C                         i.e. where |yC| <= latBandClimRelax
684    C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
685    C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
686  C                          (note: externForcingCycle must be an integer  C                          (note: externForcingCycle must be an integer
687  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
688        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
689       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,  C                       (use model surface (local) value if set to -1)
690       & thetaMin, rSphere, rRSphere, f0, fCori, beta, viscAh, viscAz, viscA4,  C     temp_EvPrRn :: temperature of Rain & Evap.
691       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,  C     salt_EvPrRn :: salinity of Rain & Evap.
692       & tauCD, rCD, freeSurfFac,  C     temp_addMass :: temperature of addMass array
693       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,  C     salt_addMass :: salinity of addMass array
694       & gravity, gBaro, rhonil, tRef, sRef,  C        (notes: a) tracer content of Rain/Evap only used if both
695       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,  C                     NonLin_FrSurf & useRealFreshWater are set.
696    C                b) use model surface (local) value if set to UNSET_RL)
697    C     hMixCriteria:: criteria for mixed-layer diagnostic
698    C     dRhoSmall   :: parameter for mixed-layer diagnostic
699    C     hMixSmooth  :: Smoothing parameter for mixed-layer diag (default=0=no smoothing)
700    C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
701    C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
702    C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
703    C     rSigmaBnd   :: vertical position (in r-unit) of r/sigma transition (Hybrid-Sigma)
704    C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
705    C                           (default=2: full drag ; =1: gives half-slip BC)
706    C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
707    C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
708    C               (if using zcoordinate, units becomes linear: m/s, quadratic: [-])
709    C     smoothAbsFuncRange :: 1/2 of interval around zero, for which FORTRAN ABS
710    C                           is to be replace by a smoother function
711    C                           (affects myabs, mymin, mymax)
712    C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
713    C                      (i.e. allows convection at different Rayleigh numbers)
714    C     phiEuler      :: Euler angle, rotation about original z-axis
715    C     thetaEuler    :: Euler angle, rotation about new x-axis
716    C     psiEuler      :: Euler angle, rotation about new z-axis
717          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
718         & cg2dpcOffDFac, cg3dTargetResidual,
719         & delR, delRc, delX, delY, xgOrigin, ygOrigin,
720         & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
721         & abEps, alph_AB, beta_AB,
722         & rSphere, recip_rSphere, radius_fromHorizGrid,
723         & f0, beta, fPrime, omega, rotationPeriod,
724         & viscFacAdj, viscAh, viscAhW, viscAhMax,
725         & viscAhGrid, viscAhGridMax, viscAhGridMin,
726         & viscC2leith, viscC2leithD,
727         & viscC2smag, viscC4smag,
728         & viscAhD, viscAhZ, viscA4D, viscA4Z,
729         & viscA4, viscA4W, viscA4Max,
730         & viscA4Grid, viscA4GridMax, viscA4GridMin,
731         & viscAhReMax, viscA4ReMax,
732         & viscC4leith, viscC4leithD, viscArNr,
733         & diffKhT, diffK4T, diffKrNrT,
734         & diffKhS, diffK4S, diffKrNrS,
735         & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
736         & BL79LatVary,
737         & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
738         & tauCD, rCD, epsAB_CD,
739         & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
740         & hFacMin, hFacMinDz, hFacInf, hFacSup,
741         & gravity, recip_gravity, gBaro,
742         & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
743         & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
744         & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
745         & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
746         & baseTime, startTime, endTime,
747         & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
748         & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
749       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
750       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,       & cosPower, cAdjFreq,
751       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
752       & externForcingCycle, externForcingPeriod       & externForcingCycle, externForcingPeriod,
753         & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
754         & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
755         & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth,
756         & Ro_SeaLevel, rSigmaBnd,
757         & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
758         & smoothAbsFuncRange,
759         & tCylIn, tCylOut,
760         & phiEuler, thetaEuler, psiEuler
761    
762        _RL cg2dTargetResidual        _RL cg2dTargetResidual
763          _RL cg2dTargetResWunit
764          _RL cg3dTargetResidual
765        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
766        _RL delZ(Nz)        _RL delR(Nr)
767          _RL delRc(Nr+1)
768        _RL delX(Nx)        _RL delX(Nx)
769        _RL delY(Ny)        _RL delY(Ny)
770          _RL xgOrigin
771          _RL ygOrigin
772        _RL deltaT        _RL deltaT
773        _RL deltaTClock        _RL deltaTClock
774        _RL deltaTmom        _RL deltaTmom
775        _RL deltaTtracer        _RL dTtracerLev(Nr)
776        _RL abeps        _RL deltaTfreesurf
777        _RL phiMin        _RL abEps, alph_AB, beta_AB
       _RL thetaMin  
778        _RL rSphere        _RL rSphere
779        _RL rRSphere        _RL recip_rSphere
780          _RL radius_fromHorizGrid
781        _RL f0        _RL f0
       _RL freeSurfFac  
782        _RL beta        _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        _RL viscAh
799        _RL viscAz        _RL viscAhW
800        _RL viscA4        _RL viscAhD
801        _RL diffKhT        _RL viscAhZ
802        _RL diffKzT        _RL viscAhMax
803        _RL diffK4T        _RL viscAhReMax
804        _RL diffKhS        _RL viscAhGrid, viscAhGridMax, viscAhGridMin
805        _RL diffKzS        _RL viscC2leith
806        _RL diffK4S        _RL viscC2leithD
807        _RL delt        _RL viscC2smag
808        _RL tauCD        _RL viscA4
809        _RL rCD        _RL viscA4W
810        _RL GMmaxslope        _RL viscA4D
811        _RL GMlength        _RL viscA4Z
812        _RL GMalpha        _RL viscA4Max
813        _RL GMdepth        _RL viscA4ReMax
814        _RL GMkbackground        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
815        _RL GMmaxval        _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        _RL gravity
835          _RL recip_gravity
836        _RL gBaro        _RL gBaro
837        _RL rhonil        _RL rhonil,        recip_rhonil
838        _RL tRef(Nz)        _RL rhoConst,      recip_rhoConst
839        _RL sRef(Nz)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
840        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _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        _RL startTime
851        _RL endTime        _RL endTime
852        _RL chkPtFreq        _RL chkPtFreq
853        _RL pChkPtFreq        _RL pChkPtFreq
854        _RL dumpFreq        _RL dumpFreq
855          _RL adjDumpFreq
856          _RL diagFreq
857        _RL taveFreq        _RL taveFreq
858          _RL tave_lastIter
859          _RL monitorFreq
860          _RL adjMonitorFreq
861        _RL afFacMom        _RL afFacMom
862        _RL vfFacMom        _RL vfFacMom
863        _RL pfFacMom        _RL pfFacMom
864        _RL cfFacMom        _RL cfFacMom
865        _RL foFacMom        _RL foFacMom
866        _RL mTFacMom        _RL mtFacMom
867          _RL cosPower
868        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
869        _RL tauThetaClimRelax        _RL tauThetaClimRelax
       _RL lambdaThetaClimRelax  
870        _RL tauSaltClimRelax        _RL tauSaltClimRelax
871        _RL lambdaSaltClimRelax        _RL latBandClimRelax
872        _RL externForcingCycle        _RL externForcingCycle
873        _RL externForcingPeriod        _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        COMMON /PARM_A/ HeatCapacity_Cp,  C--   COMMON /PARM_A/ Thermodynamics constants ?
895       &                Lamba_theta        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
896        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
897        _RL Lamba_theta        _RL recip_Cp
   
 C Equation of State (polynomial coeffients)  
       COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS  
       _RL eosC(9,Nz+1),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)  
 C Linear equation of state  
 C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  
 C     sBeta     - Linear EOS haline contraction coefficient.  
       COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType  
       _RL tAlpha  
       _RL sBeta  
       character*(6) eosType  
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 useCAL
932          LOGICAL useEXF
933          LOGICAL useBulkForce
934          LOGICAL useEBM
935          LOGICAL useCheapAML
936          LOGICAL useGrdchk
937          LOGICAL useSMOOTH
938          LOGICAL useECCO
939          LOGICAL useSBO
940          LOGICAL useFLT
941          LOGICAL usePTRACERS
942          LOGICAL useGCHEM
943          LOGICAL useRBCS
944          LOGICAL useOffLine
945          LOGICAL useMATRIX
946          LOGICAL useSEAICE
947          LOGICAL useSALT_PLUME
948          LOGICAL useShelfIce
949          LOGICAL useICEFRONT
950          LOGICAL useThSIce
951          LOGICAL useATM2d
952          LOGICAL useAIM
953          LOGICAL useLand
954          LOGICAL useFizhi
955          LOGICAL useGridAlt
956          LOGICAL useDiagnostics
957          LOGICAL useREGRID
958          LOGICAL useLayers
959          LOGICAL useMNC
960          LOGICAL useRunClock
961          LOGICAL useEMBED_FILES
962          LOGICAL useMYPACKAGE
963          COMMON /PARM_PACKAGES/
964         &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
965         &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
966         &        useGMRedi, useDOWN_SLOPE,
967         &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
968         &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,
969         &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
970         &        useSEAICE, useSALT_PLUME, useShelfIce,
971         &        useICEFRONT, useThSIce,
972         &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
973         &        useDiagnostics, useREGRID, useLayers, useMNC,
974         &        useRunClock, useEMBED_FILES,
975         &        useMYPACKAGE
976    
977    C     Logical flags for turning off parts of the code in adjoint mode
978          LOGICAL useKPPinAdMode, useKPPinFwdMode
979          LOGICAL useGMrediInAdMode, useGMrediInFwdMode
980          LOGICAL useSEAICEinAdMode, useSEAICEinFwdMode
981          COMMON /PARM_PACKAGES_ADJ/
982         &       useKPPinAdMode, useKPPinFwdMode,
983         &       useGMrediInAdMode, useGMrediInFwdMode,
984         &       useSEAICEinAdMode, useSEAICEinFwdMode
985    
986    CEH3 ;;; Local Variables: ***
987    CEH3 ;;; mode:fortran ***
988    CEH3 ;;; End: ***
Legend:
Removed from v.1.21  
changed lines
  Added in v.1.252
  ViewVC Help
Powered by ViewVC 1.1.22