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