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