/[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.145 by heimbach, Mon Feb 28 17:35:38 2005 UTC revision 1.205 by jmc, Fri Oct 19 14:34:13 2007 UTC
# Line 36  C     UNSET_xxx :: Used to indicate vari Line 36  C     UNSET_xxx :: Used to indicate vari
36        PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )        PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
37        Real*4 UNSET_FLOAT4        Real*4 UNSET_FLOAT4
38        PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )        PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
39        _RL    UNSET_RL            _RL    UNSET_RL
40        PARAMETER ( UNSET_RL     = 1.234567D5 )        PARAMETER ( UNSET_RL     = 1.234567D5 )
41        _RS    UNSET_RS            _RS    UNSET_RS
42        PARAMETER ( UNSET_RS     = 1.234567E5 )        PARAMETER ( UNSET_RS     = 1.234567E5 )
43        INTEGER UNSET_I        INTEGER UNSET_I
44        PARAMETER ( UNSET_I      = 123456789  )        PARAMETER ( UNSET_I      = 123456789  )
45    
 C     Checkpoint data  
       INTEGER maxNoChkptLev  
       PARAMETER ( maxNoChkptLev = 2 )  
   
46  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
47  C     checkPtSuff :: List of checkpoint file suffices  C     buoyancyRelation :: Flag used to indicate which relation to use to
48  C     bathyFile   :: File containing bathymetry. If not defined bathymetry  C                         get buoyancy.
49  C                   is taken from inline function.  C     eosType         :: choose the equation of state:
50  C     topoFile    :: File containing the topography of the surface (unit=m)  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
51  C                   (mainly used for the atmosphere = ground height).  C     pickupSuff      :: force to start from pickup files (even if nIter0=0)
52  C     hydrogThetaFile :: File containing initial hydrographic data for potential  C                        and read pickup files with this suffix (max 10 Char.)
53  C                       temperature.  C     mdsioLocalDir   :: read-write tiled file from/to this directory name
54  C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.  C                        (+ 4 digits Processor-Rank) instead of current dir.
55    C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
56    C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
57    C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
58    C     delRFile      :: File containing vertical grid spacing delR  (1.D array)
59    C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)
60    C     delXFile      :: File containing X-spacing grid definition (1.D array)
61    C     delYFile      :: File containing Y-spacing grid definition (1.D array)
62    C     horizGridFile :: File containing horizontal-grid definition
63    C                        (only when using curvilinear_grid)
64    C     bathyFile       :: File containing bathymetry. If not defined bathymetry
65    C                        is taken from inline function.
66    C     topoFile        :: File containing the topography of the surface (unit=m)
67    C                        (mainly used for the atmosphere = ground height).
68    C     shelfIceFile    :: File containing the topography of the shelfice draught
69    C                        (unit=m)
70    C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
71    C                        for potential temperature.
72    C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
73    C                        for salinity.
74    C     diffKrFile      :: File containing 3D specification of vertical diffusivity
75  C     zonalWindFile   :: File containing zonal wind data  C     zonalWindFile   :: File containing zonal wind data
76  C     meridWindFile   :: File containing meridional wind data  C     meridWindFile   :: File containing meridional wind data
77  C     thetaClimFile   :: File containing theta climataology used  C     thetaClimFile   :: File containing surface theta climataology used
78  C                       in relaxation term -lambda(theta-theta*)  C                       in relaxation term -lambda(theta-theta*)
79  C     saltClimFile    :: File containing salt climataology used  C     saltClimFile    :: File containing surface salt climataology used
80  C                       in relaxation term -lambda(salt-salt*)  C                       in relaxation term -lambda(salt-salt*)
81  C     surfQfile       :: File containing surface heat flux, excluding SW  C     surfQfile       :: File containing surface heat flux, excluding SW
82  C                        (old version, kept for backward compatibility)  C                        (old version, kept for backward compatibility)
# Line 72  C     saltFluxFile    :: File containing Line 88  C     saltFluxFile    :: File containing
88  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
89  C     eddyTauxFile    :: File containing zonal Eddy stress data  C     eddyTauxFile    :: File containing zonal Eddy stress data
90  C     eddyTauyFile    :: File containing meridional Eddy stress data  C     eddyTauyFile    :: File containing meridional Eddy stress data
 C     buoyancyRelation :: Flag used to indicate which relation to use to  
 C                        get buoyancy.  
 C     eosType         :: choose the equation of state:  
 C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS  
91  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
92        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/
93       &                bathyFile, topoFile,       &                buoyancyRelation, eosType,
94       &                hydrogThetaFile, hydrogSaltFile,       &                pickupSuff, mdsioLocalDir,
95         &                tRefFile, sRefFile, rhoRefFile,
96         &                delRFile, delRcFile,
97         &                delXFile, delYFile, horizGridFile,
98         &                bathyFile, topoFile, shelfIceFile,
99         &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
100       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
101       &                saltClimFile, buoyancyRelation,       &                saltClimFile,
102       &                EmPmRfile, saltFluxFile,       &                EmPmRfile, saltFluxFile,
103       &                surfQfile, surfQnetFile, surfQswFile,       &                surfQfile, surfQnetFile, surfQswFile,
104         &                lambdaThetaFile, lambdaSaltFile,
105       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
106       &                dQdTfile, ploadFile,       &                dQdTfile, ploadFile,
107       &                eddyTauxFile, eddyTauyFile,       &                eddyTauxFile, eddyTauyFile,
      &                eosType, pickupSuff,  
      &                mdsioLocalDir,  
108       &                the_run_name       &                the_run_name
109        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
110        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(6)  eosType
111        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(10) pickupSuff
112        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
113          CHARACTER*(MAX_LEN_FNAM) tRefFile
114          CHARACTER*(MAX_LEN_FNAM) sRefFile
115          CHARACTER*(MAX_LEN_FNAM) rhoRefFile
116          CHARACTER*(MAX_LEN_FNAM) delRFile
117          CHARACTER*(MAX_LEN_FNAM) delRcFile
118          CHARACTER*(MAX_LEN_FNAM) delXFile
119          CHARACTER*(MAX_LEN_FNAM) delYFile
120          CHARACTER*(MAX_LEN_FNAM) horizGridFile
121          CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile
122          CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
123          CHARACTER*(MAX_LEN_FNAM) diffKrFile
124        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
125        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
126        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
# Line 103  C     the_run_name    :: string identify Line 130  C     the_run_name    :: string identify
130        CHARACTER*(MAX_LEN_FNAM) surfQswFile        CHARACTER*(MAX_LEN_FNAM) surfQswFile
131        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
132        CHARACTER*(MAX_LEN_FNAM) saltFluxFile        CHARACTER*(MAX_LEN_FNAM) saltFluxFile
       CHARACTER*(MAX_LEN_FNAM) buoyancyRelation  
133        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
134        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
135        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
# Line 111  C     the_run_name    :: string identify Line 137  C     the_run_name    :: string identify
137        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) ploadFile
138        CHARACTER*(MAX_LEN_FNAM) eddyTauxFile        CHARACTER*(MAX_LEN_FNAM) eddyTauxFile
139        CHARACTER*(MAX_LEN_FNAM) eddyTauyFile        CHARACTER*(MAX_LEN_FNAM) eddyTauyFile
140        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
141        CHARACTER*(MAX_LEN_FNAM) the_run_name        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
142        CHARACTER*(6) eosType        CHARACTER*(MAX_LEN_PREC/2) the_run_name
       CHARACTER*(10) pickupSuff  
143    
144  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
145  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
# Line 129  C     cg3dChkResFreq      :: Frequency w Line 154  C     cg3dChkResFreq      :: Frequency w
154  C                           in con. grad solver.  C                           in con. grad solver.
155  C     nIter0              :: Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
156  C     nTimeSteps          :: Number of timesteps to execute  C     nTimeSteps          :: Number of timesteps to execute
 C     numStepsPerPickup   :: For offline setup. Frequency of pickup  
 C                           of flow fields.  
157  C     writeStatePrec      :: Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
158  C     writeBinaryPrec     :: Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
159  C     readBinaryPrec      :: Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
 C     nCheckLev           :: Holds current checkpoint level  
160  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
161  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
162  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
163  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
164    C     momForcingOutAB     :: =1: take momentum forcing contribution
165    C                           out of (=0: in) Adams-Bashforth time stepping.
166    C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
167    C                           out of (=0: in) Adams-Bashforth time stepping.
168  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
169  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
170  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
171  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
172    C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)
173  C     debugLevel          :: debug level selector: higher -> more writing  C     debugLevel          :: debug level selector: higher -> more writing
174    
175        COMMON /PARM_I/        COMMON /PARM_I/
# Line 151  C     debugLevel          :: debug level Line 178  C     debugLevel          :: debug level
178       &        cg3dMaxIters,       &        cg3dMaxIters,
179       &        cg3dChkResFreq,       &        cg3dChkResFreq,
180       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
181       &        numStepsPerPickup,       &        writeStatePrec,
      &        writeStatePrec, nCheckLev,  
182       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
183       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
184         &        momForcingOutAB, tracForcingOutAB,
185       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
186       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
187         &        selectKEscheme,
188       &        debugLevel       &        debugLevel
189        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
190        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
# Line 166  C     debugLevel          :: debug level Line 194  C     debugLevel          :: debug level
194        INTEGER nIter0        INTEGER nIter0
195        INTEGER nTimeSteps        INTEGER nTimeSteps
196        INTEGER nEndIter        INTEGER nEndIter
       INTEGER numStepsPerPickup  
197        INTEGER writeStatePrec        INTEGER writeStatePrec
198        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
199        INTEGER readBinaryPrec        INTEGER readBinaryPrec
       INTEGER nCheckLev  
200        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
201        INTEGER select_rStar        INTEGER select_rStar
202          INTEGER momForcingOutAB, tracForcingOutAB
203        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
204        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
205          INTEGER selectKEscheme
206        INTEGER debugLevel        INTEGER debugLevel
207    
208  C  C
# Line 191  C                          coordinate fr Line 219  C                          coordinate fr
219  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
220  C                               spherical polar frame.  C                               spherical polar frame.
221  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
222    C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
223    C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
224  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
225  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
 C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V  
226  C     momViscosity  :: Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
227  C     momAdvection  :: Flag which turns advection of momentum on and off.  C     momAdvection  :: Flag which turns advection of momentum on and off.
228  C     momForcing    :: Flag which turns external forcing of momentum on  C     momForcing    :: Flag which turns external forcing of momentum on
# Line 201  C                     and off. Line 230  C                     and off.
230  C     momPressureForcing :: Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
231  C                          on and off.  C                          on and off.
232  C     metricTerms   :: Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
233  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
 C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.  
234  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
235  C     tempAdvection :: Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
236  C                     and off.  C                     and off.
# Line 215  C                     and off. Line 243  C                     and off.
243  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
244  C                         as a real Fresh Water (=> changes the Sea Level)  C                         as a real Fresh Water (=> changes the Sea Level)
245  C                         if F, converts P+R-E to salt flux (no SL effect)  C                         if F, converts P+R-E to salt flux (no SL effect)
246    C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
247    C                       on irregular grids)
248    C     useAreaViscLength :: Set to true to use old scaling for viscous
249    C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.
250    C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
251  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
252  C     implicitFreeSurface :: Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
253  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
254    C     linFSConserveTr     :: Set to true to correct source/sink of tracer
255    C                            at the surface due to Linear Free Surface
256  C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the  C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
257  C                           linear relation Phi_surf = Bo_surf*eta  C                           linear relation Phi_surf = Bo_surf*eta
258    C     use3Dsolver   :: set to true to use 3-D pressure solver
259    C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
260    C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
261  C     momStepping   :: Turns momentum equation time-stepping off  C     momStepping   :: Turns momentum equation time-stepping off
262  C     tempStepping  :: Turns temperature equation time-stepping off  C     tempStepping  :: Turns temperature equation time-stepping off
263  C     saltStepping  :: Turns salinity equation time-stepping off  C     saltStepping  :: Turns salinity equation time-stepping off
264  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
265  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
266  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
267    C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
268  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
269  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
270  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
271  C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny  C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
272  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
273  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
274    C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
275  C     useAbsVorticity :: work with f+zeta in Coriolis terms  C     useAbsVorticity :: work with f+zeta in Coriolis terms
276  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
277  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
# Line 240  C     saltImplVertAdv :: Turns on implic Line 280  C     saltImplVertAdv :: Turns on implic
280  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
281  C     multiDimAdvection :: Flag that enable multi-dimension advection  C     multiDimAdvection :: Flag that enable multi-dimension advection
282  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
283  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution  C     momDissip_In_AB   :: if False, put Dissipation tendency contribution
284  C                      out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
285    C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
286    C                          apply AB on tracer tendencies (rather than on Tracer)
287    C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
288    C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
289    C                           before checkpoint-54a, Jul 06, 2004.
290  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
291  C                        climatology is required.  C                        climatology is required.
292  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
# Line 257  C     fluidIsWater     :: Set to indicat Line 302  C     fluidIsWater     :: Set to indicat
302  C                        is water  C                        is water
303  C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)  C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
304  C                         this requires specific code for restart & exchange  C                         this requires specific code for restart & exchange
305  C     setCenterDr    :: set cell Center depth and put Interface at the middle  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
306    C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
307  C     nonHydrostatic :: Using non-hydrostatic terms  C     nonHydrostatic :: Using non-hydrostatic terms
308  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
309  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
# Line 267  C                       useSingleCpuIO i Line 313  C                       useSingleCpuIO i
313  C                       outputs from master mpi process only.  C                       outputs from master mpi process only.
314  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
315  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
 C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  
316  C     pickup_write_mdsio :: use mdsio to write pickups  C     pickup_write_mdsio :: use mdsio to write pickups
317  C     pickup_read_mdsio  :: use mdsio to read  pickups  C     pickup_read_mdsio  :: use mdsio to read  pickups
318  C     pickup_write_immed :: echo the pickup immediately (for conversion)  C     pickup_write_immed :: echo the pickup immediately (for conversion)
319  C     timeave_mdsio      :: use mdsio for timeave output  C     timeave_mdsio      :: use mdsio for timeave output
320  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
321  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
322  C     calendarDumps :: When set, approximate months (30-31 days) and years (360-372 days)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
323  C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,  C                        & Last iteration, in addition multiple of dumpFreq iter.
324  C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact  C     balanceEmPmR    :: substract global mean of EmPmR at every time step
325  C                      calendar months and years.  Requires pkg/cal.  C     balanceQnet     :: substract global mean of Qnet at every time step
326    C     balancePrintMean:: print substracted global means to STDOUT
327    
328        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
329       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
330         & deepAtmosphere, setInterFDr, setCenterDr,
331       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
332       & staggerTimeStep,       & momViscosity, momAdvection, momForcing, useCoriolis,
      & momViscosity, momAdvection, momForcing, useCoriolis,  
333       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
334       & tempAdvection, tempForcing,       & tempAdvection, tempForcing,
335       & saltAdvection, saltForcing,       & saltAdvection, saltForcing,
336       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
337       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & useFullLeith, useStrainTensionVisc,
338         & useAreaViscLength,
339         & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
340         & uniformLin_PhiSurf,
341         & use3Dsolver, implicitIntGravWave, staggerTimeStep,
342       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
343       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, useNHMTerms,
344       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF, use3dCoriolis,
345       & useCDscheme,       & useCDscheme,
346       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
347       & SadournyCoriolis, upwindVorticity, highOrderVorticity,       & SadournyCoriolis, upwindVorticity, highOrderVorticity,
348       & useAbsVorticity,       & useAbsVorticity, upwindShear,
349       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
350       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
351       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,       & multiDimAdvection, useMultiDimAdvec,
352       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & momDissip_In_AB, doAB_onGtGs,
353       & periodicExternalForcing,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
354         & periodicExternalForcing,
355       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
356       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc,
357       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
358       & allowFreezing, useOldFreezing, groundAtK1,       & allowFreezing, useOldFreezing,
359       & usePickupBeforeC35, usePickupBeforeC54, debugMode,       & usePickupBeforeC54, startFromPickupAB2,
      & readPickupWithTracer, writePickupWithTracer,  
360       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
361       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
362       & outputTypesInclusive,       & outputTypesInclusive, dumpInitAndLast, debugMode,
363       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & inAdMode, inAdTrue, inAdFalse, inAdExact,
364       & calendarDumps       & balanceEmPmR, balanceQnet, balancePrintMean
365    
366        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
367        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
368        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
369        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
370        LOGICAL usingSphericalPolarMTerms        LOGICAL deepAtmosphere
371          LOGICAL setInterFDr
372          LOGICAL setCenterDr
373        LOGICAL useNHMTerms        LOGICAL useNHMTerms
374        LOGICAL no_slip_sides        LOGICAL no_slip_sides
375        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
       LOGICAL staggerTimeStep  
376        LOGICAL momViscosity        LOGICAL momViscosity
377        LOGICAL momAdvection        LOGICAL momAdvection
378        LOGICAL momForcing        LOGICAL momForcing
# Line 332  C                      calendar months a Line 384  C                      calendar months a
384        LOGICAL saltAdvection        LOGICAL saltAdvection
385        LOGICAL saltForcing        LOGICAL saltForcing
386        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
387          LOGICAL useFullLeith
388          LOGICAL useStrainTensionVisc
389          LOGICAL useAreaViscLength
390        LOGICAL rigidLid        LOGICAL rigidLid
391        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
392        LOGICAL exactConserv        LOGICAL exactConserv
393          LOGICAL linFSConserveTr
394        LOGICAL uniformLin_PhiSurf        LOGICAL uniformLin_PhiSurf
395          LOGICAL use3Dsolver
396          LOGICAL implicitIntGravWave
397          LOGICAL staggerTimeStep
398        LOGICAL momStepping        LOGICAL momStepping
399        LOGICAL tempStepping        LOGICAL tempStepping
400        LOGICAL saltStepping        LOGICAL saltStepping
# Line 343  C                      calendar months a Line 402  C                      calendar months a
402        LOGICAL useConstantF        LOGICAL useConstantF
403        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
404        LOGICAL useSphereF        LOGICAL useSphereF
405          LOGICAL use3dCoriolis
406        LOGICAL useCDscheme        LOGICAL useCDscheme
407        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
408        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
# Line 351  C                      calendar months a Line 411  C                      calendar months a
411        LOGICAL upwindVorticity        LOGICAL upwindVorticity
412        LOGICAL highOrderVorticity        LOGICAL highOrderVorticity
413        LOGICAL useAbsVorticity        LOGICAL useAbsVorticity
414          LOGICAL upwindShear
415        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
416        LOGICAL implicitViscosity        LOGICAL implicitViscosity
417        LOGICAL tempImplVertAdv        LOGICAL tempImplVertAdv
418        LOGICAL saltImplVertAdv        LOGICAL saltImplVertAdv
419        LOGICAL momImplVertAdv        LOGICAL momImplVertAdv
420        LOGICAL multiDimAdvection        LOGICAL multiDimAdvection
421        LOGICAL useMultiDimAdvec        LOGICAL useMultiDimAdvec
422        LOGICAL forcing_In_AB        LOGICAL momDissip_In_AB
423          LOGICAL doAB_onGtGs
424        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
425        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
426        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
# Line 368  C                      calendar months a Line 430  C                      calendar months a
430        LOGICAL usingPCoords        LOGICAL usingPCoords
431        LOGICAL usingZCoords        LOGICAL usingZCoords
432        LOGICAL useDynP_inEos_Zc        LOGICAL useDynP_inEos_Zc
       LOGICAL setCenterDr  
433        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
434        LOGICAL quasiHydrostatic        LOGICAL quasiHydrostatic
435        LOGICAL globalFiles        LOGICAL globalFiles
436        LOGICAL useSingleCpuIO        LOGICAL useSingleCpuIO
437        LOGICAL allowFreezing        LOGICAL allowFreezing
438        LOGICAL useOldFreezing        LOGICAL useOldFreezing
       LOGICAL groundAtK1  
       LOGICAL usePickupBeforeC35  
439        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
440          LOGICAL startFromPickupAB2
441          LOGICAL dumpInitAndLast
442        LOGICAL debugMode        LOGICAL debugMode
       LOGICAL readPickupWithTracer  
       LOGICAL writePickupWithTracer  
443        LOGICAL pickup_read_mdsio, pickup_write_mdsio        LOGICAL pickup_read_mdsio, pickup_write_mdsio
444        LOGICAL pickup_write_immed        LOGICAL pickup_write_immed
445        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
446        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
447        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
448        LOGICAL calendarDumps  
449          LOGICAL balanceEmPmR
450          LOGICAL balanceQnet
451          LOGICAL balancePrintMean
452    
453  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
454  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 417  C     gravity   :: Accel. due to gravity Line 479  C     gravity   :: Accel. due to gravity
479  C     recip_gravity and its inverse  C     recip_gravity and its inverse
480  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 )
481  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
482  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
483    C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
484    C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
485  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
486  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
487  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
488  C     startTime :: Start time for model ( s )  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
489    C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:
490    C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
491    C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
492    C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
493    C                :: from r-coordinate vertical velocity to vertical velocity [m/s].
494    C                :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit
495    C     wUnit2rVel :: units conversion factor (Non-Hydrostatic code),
496    C                :: from vertical velocity [m/s] to r-coordinate vertical velocity.
497    C                :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel
498    C     mass2rUnit :: units conversion factor (surface forcing),
499    C                :: from mass per unit area [kg/m2] to vertical r-coordinate unit.
500    C                :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ;
501    C                :: p-coord: = gravity    ( [kg/m2] *  g = [Pa] ) ;
502    C     rUnit2mass :: units conversion factor (surface forcing),
503    C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
504    C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
505    C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
506  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
507  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
508  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
509  C                 to make geographical references simple.)  C                 to make geographical references simple.)
510  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).
511  C     recip_RSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
512  C     f0        :: Reference coriolis parameter ( 1/s )  C     f0        :: Reference coriolis parameter ( 1/s )
513  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
514  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
# Line 438  C                 momentum laterally ( m Line 519  C                 momentum laterally ( m
519  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
520  C                 momentum laterally, no effect for hydrostatic  C                 momentum laterally, no effect for hydrostatic
521  C                 model, defaults to viscAh if unset ( m^2/s )  C                 model, defaults to viscAh if unset ( m^2/s )
522    C                 Not used if variable horiz. viscosity is used.
523  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
524  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
525  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
# Line 445  C                 momentum laterally ( m Line 527  C                 momentum laterally ( m
527  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical
528  C                 momentum laterally, no effect for hydrostatic  C                 momentum laterally, no effect for hydrostatic
529  C                 model, defaults to viscA4 if unset ( m^2/s )  C                 model, defaults to viscA4 if unset ( m^2/s )
530    C                 Not used if variable horiz. viscosity is used.
531  C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally
532  C                  (act on Divergence part) ( m^2/s )  C                  (act on Divergence part) ( m^2/s )
533  C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally
# Line 453  C     viscA4D   :: Biharmonic viscosity Line 536  C     viscA4D   :: Biharmonic viscosity
536  C                  (act on Divergence part) ( m^4/s )  C                  (act on Divergence part) ( m^4/s )
537  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
538  C                  (act on Vorticity  part) ( m^4/s )  C                  (act on Vorticity  part) ( m^4/s )
539  C     viscC2leith :: Leith non-dimensional viscosity factor  C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))
540    C     viscC2leithD :: Modified Leith non-dimensional visc. 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  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
544  C                 momentum laterally ( m^2/s )  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     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
548    C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
549  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
550  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
551    C     viscA4ReMax :: Maximum Gridscale Reynolds number for
552    C                  biharmonic viscosity coeff. momentum laterally (non-dim)
553  C     viscAhGrid:: non-dimensional grid-size dependent viscosity  C     viscAhGrid:: non-dimensional grid-size dependent viscosity
554  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
555  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
556  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
557  C     viscC4leith :: Leith non-dimensional viscosity factor  C     viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))
558    C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
559  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
560  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
561  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
# Line 479  C     diffKrBL79surf :: T/S surface diff Line 572  C     diffKrBL79surf :: T/S surface diff
572  C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979  C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
573  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
574  C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979  C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
575    C     BL79LatVary    :: polarwise of this latitude diffKrBL79 is applied with
576    C                       gradual transition to diffKrBLEQ towards Equator
577    C     diffKrBLEQsurf :: same as diffKrBL79surf but at Equator
578    C     diffKrBLEQdeep :: same as diffKrBL79deep but at Equator
579    C     diffKrBLEQscl  :: same as diffKrBL79scl but at Equator
580    C     diffKrBLEQHo   :: same as diffKrBL79Ho but at Equator
581  C     deltaT    :: Default timestep ( s )  C     deltaT    :: Default timestep ( s )
582  C     deltaTClock  :: Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
583  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
# Line 492  C     deltaTfreesurf :: Timestep for fre Line 591  C     deltaTfreesurf :: Timestep for fre
591  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
592  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
593  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
594    C     abEps        :: Adams-Bashforth-2 stabilizing weight
595    C     alph_AB      :: Adams-Bashforth-3 primary factor
596    C     beta_AB      :: Adams-Bashforth-3 secondary factor
597  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
598  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
599  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
# Line 504  C     hFacInf      :: Threshold (inf and Line 606  C     hFacInf      :: Threshold (inf and
606  C     hFacSup        that control vanishing and creating levels  C     hFacSup        that control vanishing and creating levels
607  C     tauCD        :: CD scheme coupling timescale ( 1/s )  C     tauCD        :: CD scheme coupling timescale ( 1/s )
608  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
609    C     baseTime      :: model base time (time origin) = time @ iteration zero
610  C     startTime     :: Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
611  C     endTime       :: Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
612  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
# Line 527  C     tave_lastIter :: (for state variab Line 630  C     tave_lastIter :: (for state variab
630  C                      step (of each taveFreq period) put in the time average.  C                      step (of each taveFreq period) put in the time average.
631  C                      (fraction for 1rst iter = 1 - tave_lastIter)  C                      (fraction for 1rst iter = 1 - tave_lastIter)
632  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
 C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).  
633  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
 C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).  
634  C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,  C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
635  C                         i.e. where |yC| <= latBandClimRelax  C                         i.e. where |yC| <= latBandClimRelax
636  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
# Line 543  C     salt_EvPrRn :: salinity of Rain & Line 644  C     salt_EvPrRn :: salinity of Rain &
644  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
645  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
646  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
647  C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.  C     hMixCrit    :: criteria for mixed-layer diagnostic
648  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
649  C                          ( g*rho if horiz in m and vertical in Pa ).  C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
650  C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
651  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
652  C     bottomDragLinear   :: Drag coefficient built in to core dynamics  C                           (default=2: full drag ; =1: gives half-slip BC)
653  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
654        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,  C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
655    C               (if using zcoordinate, units becomes linear: m/s, quadratic: [-])
656    C     smoothAbsFuncRange :: 1/2 of interval around zero, for which FORTRAN ABS
657    C                           is to be replace by a smoother function
658    C                           (affects myabs, mymin, mymax)
659    C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
660    C                      (i.e. allows convection at different Rayleigh numbers)
661          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
662       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
663       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
664       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
665       & abeps, startTime,       & abEps, alph_AB, beta_AB,
666       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
667       & fCori, fCoriG, fCoriCos,       & viscAh, viscAhW, viscAhMax,
668       & viscAh, viscAhW, viscAhMax, viscAhGrid, viscC2leith,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
669         & viscC2leith, viscC2leithD,
670         & viscC2smag, viscC4smag,
671       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
672       & viscA4, viscA4W,       & viscA4, viscA4W,
673       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
674       & viscC4leith, viscAr, viscAstrain, viscAtension,       & viscAhRemax, viscA4Remax,
675         & viscC4leith, viscC4leithD, viscAr,
676       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
677       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
678       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
679         & BL79LatVary,
680         & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
681       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
682       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
683       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_gravity, gBaro,
684       & recip_rhoConst, rhoConst,       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
685       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
686       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,       & rhoConstFresh, tRef, sRef, phiRef, dBdrRef,
687         & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
688         & baseTime, startTime, endTime,
689         & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
690       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
691       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
692       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
693       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, tauSaltClimRelax,
      & tauSaltClimRelax, lambdaSaltClimRelax,  
694       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
695       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
696       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
697       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
698       & horiVertRatio, recip_horiVertRatio,       & ivdc_kappa, hMixCriteria, Ro_SeaLevel,
699       & ivdc_kappa, Ro_SeaLevel,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
700       & bottomDragLinear,bottomDragQuadratic,       & smoothAbsFuncRange,
701       & tCylIn, tCylOut       & tCylIn, tCylOut
702    
703        _RL cg2dTargetResidual        _RL cg2dTargetResidual
# Line 598  C      --"-"--  Quadratic  ( linear: 1/s Line 713  C      --"-"--  Quadratic  ( linear: 1/s
713        _RL deltaTmom        _RL deltaTmom
714        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
715        _RL deltaTfreesurf        _RL deltaTfreesurf
716        _RL abeps        _RL abEps, alph_AB, beta_AB
717        _RL phiMin        _RL phiMin
718        _RL thetaMin        _RL thetaMin
719        _RL rSphere        _RL rSphere
720        _RL recip_RSphere        _RL recip_rSphere
721        _RL f0        _RL f0
722        _RL freeSurfFac        _RL freeSurfFac
723        _RL implicSurfPress        _RL implicSurfPress
# Line 619  C      --"-"--  Quadratic  ( linear: 1/s Line 734  C      --"-"--  Quadratic  ( linear: 1/s
734        _RL viscAhD        _RL viscAhD
735        _RL viscAhZ        _RL viscAhZ
736        _RL viscAhMax        _RL viscAhMax
737          _RL viscAhReMax
738        _RL viscAhGrid        _RL viscAhGrid
739          _RL viscAhGridMax
740          _RL viscAhGridMin
741        _RL viscC2leith        _RL viscC2leith
742        _RL viscAstrain        _RL viscC2leithD
743        _RL viscAtension        _RL viscC2smag
744          _RL viscC4smag
745        _RL viscAr        _RL viscAr
746        _RL viscA4        _RL viscA4
747        _RL viscA4W        _RL viscA4W
748        _RL viscA4D        _RL viscA4D
749        _RL viscA4Z        _RL viscA4Z
750        _RL viscA4Max        _RL viscA4Max
751          _RL viscA4ReMax
752        _RL viscA4Grid, viscA4GridMax, viscA4GridMin        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
753        _RL viscC4leith        _RL viscC4leith
754        _RL diffKhT        _RL viscC4leithD
755          _RL diffKhT
756        _RL diffKrNrT(Nr)        _RL diffKrNrT(Nr)
757        _RL diffK4T        _RL diffK4T
758        _RL diffKhS        _RL diffKhS
759        _RL diffKrNrS(Nr)        _RL diffKrNrS(Nr)
760        _RL diffK4S        _RL diffK4S
761        _RL diffKrBL79surf        _RL diffKrBL79surf
762        _RL diffKrBL79deep        _RL diffKrBL79deep
763        _RL diffKrBL79scl        _RL diffKrBL79scl
764        _RL diffKrBL79Ho        _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
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 rhoConstFresh        _RL rhoConstFresh
       _RL convertEmP2rUnit  
781        _RL tRef(Nr)        _RL tRef(Nr)
782        _RL sRef(Nr)        _RL sRef(Nr)
783        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL phiRef(2*Nr+1)
784        _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL dBdrRef(Nr)
785        _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL rVel2wUnit(Nr+1), wUnit2rVel(Nr+1)
786          _RL mass2rUnit, rUnit2mass
787          _RL baseTime
788        _RL startTime        _RL startTime
789        _RL endTime        _RL endTime
790        _RL chkPtFreq        _RL chkPtFreq
# Line 674  C      --"-"--  Quadratic  ( linear: 1/s Line 801  C      --"-"--  Quadratic  ( linear: 1/s
801        _RL pfFacMom        _RL pfFacMom
802        _RL cfFacMom        _RL cfFacMom
803        _RL foFacMom        _RL foFacMom
804        _RL mTFacMom        _RL mtFacMom
805        _RL cosPower        _RL cosPower
806        _RL cAdjFreq        _RL cAdjFreq
807        _RL omega        _RL omega
808        _RL rotationPeriod        _RL rotationPeriod
809        _RL tauThetaClimRelax        _RL tauThetaClimRelax
       _RL lambdaThetaClimRelax  
810        _RL tauSaltClimRelax        _RL tauSaltClimRelax
       _RL lambdaSaltClimRelax  
811        _RL tauTr1ClimRelax        _RL tauTr1ClimRelax
812        _RL lambdaTr1ClimRelax        _RL lambdaTr1ClimRelax
813        _RL latBandClimRelax        _RL latBandClimRelax
# Line 691  C      --"-"--  Quadratic  ( linear: 1/s Line 816  C      --"-"--  Quadratic  ( linear: 1/s
816        _RL convertFW2Salt        _RL convertFW2Salt
817        _RL temp_EvPrRn        _RL temp_EvPrRn
818        _RL salt_EvPrRn        _RL salt_EvPrRn
       _RL horiVertRatio  
       _RL recip_horiVertRatio  
819        _RL ivdc_kappa        _RL ivdc_kappa
820          _RL hMixCriteria
821        _RL Ro_SeaLevel        _RL Ro_SeaLevel
822          _RL sideDragFactor
823        _RL bottomDragLinear        _RL bottomDragLinear
824        _RL bottomDragQuadratic        _RL bottomDragQuadratic
825          _RL smoothAbsFuncRange
826          _RL nh_Am2
827        _RL tCylIn        _RL tCylIn
828        _RL tCylOut        _RL tCylOut
829    
# Line 717  C     integr_GeoPot :: option to select Line 844  C     integr_GeoPot :: option to select
844  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
845  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
846  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
847        COMMON /PARM_ATM/        COMMON /PARM_ATM/
848       &            celsius2K,       &            celsius2K,
849       &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,       &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
850       &            integr_GeoPot, selectFindRoSurf       &            integr_GeoPot, selectFindRoSurf
# Line 731  C Logical flags for selecting packages Line 858  C Logical flags for selecting packages
858        LOGICAL useMY82        LOGICAL useMY82
859        LOGICAL useGGL90        LOGICAL useGGL90
860        LOGICAL useKPP        LOGICAL useKPP
861          LOGICAL useGAD
862        LOGICAL useGMRedi        LOGICAL useGMRedi
863        LOGICAL useOBCS        LOGICAL useOBCS
864        LOGICAL useAIM        LOGICAL useAIM
865        LOGICAL useLand        LOGICAL useLand
866          LOGICAL useCAL
867          LOGICAL useEXF
868          LOGICAL useEBM
869        LOGICAL useGrdchk        LOGICAL useGrdchk
870        LOGICAL useECCO        LOGICAL useECCO
871        LOGICAL useSHAP_FILT        LOGICAL useSHAP_FILT
# Line 742  C Logical flags for selecting packages Line 873  C Logical flags for selecting packages
873        LOGICAL useFLT        LOGICAL useFLT
874        LOGICAL usePTRACERS        LOGICAL usePTRACERS
875        LOGICAL useGCHEM        LOGICAL useGCHEM
876          LOGICAL useRBCS
877          LOGICAL useOffLine
878          LOGICAL useMATRIX
879        LOGICAL useSBO        LOGICAL useSBO
880        LOGICAL useSEAICE        LOGICAL useSEAICE
881        LOGICAL useBulkForce        LOGICAL useShelfIce
882        LOGICAL useThSIce        LOGICAL useThSIce
883          LOGICAL useATM2d
884          LOGICAL useBulkForce
885        LOGICAL usefizhi        LOGICAL usefizhi
886        LOGICAL usegridalt        LOGICAL usegridalt
887        LOGICAL usediagnostics        LOGICAL useDiagnostics
       LOGICAL useEBM  
888        LOGICAL useMNC        LOGICAL useMNC
889          LOGICAL useREGRID
890          LOGICAL useRunClock
891          LOGICAL useEMBED_FILES
892          LOGICAL useMYPACKAGE
893        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
894       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
895       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useGAD, useGMRedi, useOBCS, useAIM, useLand,
896       &        usePTRACERS, useGCHEM,       &        useCAL, useEXF, useEBM, useGrdchk, useECCO,
897       &        useSBO, useSEAICE, useThSIce, useBulkForce,       &        useSHAP_FILT, useZONAL_FILT, useFLT,
898       &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
899       &        usePP81, useMY82, useOPPS, useGGL90       &        useSBO, useSEAICE, useShelfIce,
900         &        useThSIce, useATM2D, useBulkForce,
901         &        usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID,
902         &        useRunClock, useEMBED_FILES, useMYPACKAGE
903    
904  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
905  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
Legend:
Removed from v.1.145  
changed lines
  Added in v.1.205
  ViewVC Help
Powered by ViewVC 1.1.22