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

Legend:
Removed from v.1.21  
changed lines
  Added in v.1.202

  ViewVC Help
Powered by ViewVC 1.1.22