/[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.166 by baylor, Tue Sep 20 21:01:30 2005 UTC revision 1.214 by jmc, Sun Mar 30 21:44:09 2008 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                         get buoyancy.
49    C     eosType         :: choose the equation of state:
50    C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
51    C     pickupSuff      :: force to start from pickup files (even if nIter0=0)
52    C                        and read pickup files with this suffix (max 10 Char.)
53    C     mdsioLocalDir   :: read-write tiled file from/to this directory name
54    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)  C     delXFile      :: File containing X-spacing grid definition (1.D array)
61  C     delYFile      :: File containing Y-spacing grid definition (1.D array)  C     delYFile      :: File containing Y-spacing grid definition (1.D array)
62  C     horizGridFile :: File containing horizontal-grid definition  C     horizGridFile :: File containing horizontal-grid definition
63  C                        (only when using curvilinear_grid)  C                        (only when using curvilinear_grid)
64  C     bathyFile   :: File containing bathymetry. If not defined bathymetry  C     bathyFile       :: File containing bathymetry. If not defined bathymetry
65  C                   is taken from inline function.  C                        is taken from inline function.
66  C     topoFile    :: File containing the topography of the surface (unit=m)  C     topoFile        :: File containing the topography of the surface (unit=m)
67  C                   (mainly used for the atmosphere = ground height).  C                        (mainly used for the atmosphere = ground height).
68  C     hydrogThetaFile :: File containing initial hydrographic data for potential  C     shelfIceFile    :: File containing the topography of the shelfice draught
69  C                       temperature.  C                        (unit=m)
70  C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.  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     surfQnetFile    :: File containing Line 84  C     surfQnetFile    :: File containing
84  C     surfQswFile     :: File containing surface shortwave radiation  C     surfQswFile     :: File containing surface shortwave radiation
85  C     dQdTfile        :: File containing thermal relaxation coefficient  C     dQdTfile        :: File containing thermal relaxation coefficient
86  C     EmPmRfile       :: File containing surface fresh water flux  C     EmPmRfile       :: File containing surface fresh water flux
87    C           NOTE: for backward compatibility EmPmRfile is specified in
88    C                 m/s when using external_fields_load.F.  It is converted
89    C                 to kg/m2/s by multiplying by rhoConstFresh.
90  C     saltFluxFile    :: File containing surface salt flux  C     saltFluxFile    :: File containing surface salt flux
91  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
92  C     eddyTauxFile    :: File containing zonal Eddy stress data  C     eddyTauxFile    :: File containing zonal Eddy stress data
93  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  
94  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
95        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/
96         &                buoyancyRelation, eosType,
97         &                pickupSuff, mdsioLocalDir,
98         &                tRefFile, sRefFile, rhoRefFile,
99         &                delRFile, delRcFile,
100       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
101       &                bathyFile, topoFile,       &                bathyFile, topoFile, shelfIceFile,
102       &                hydrogThetaFile, hydrogSaltFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
103       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
104       &                saltClimFile, buoyancyRelation,       &                saltClimFile,
105       &                EmPmRfile, saltFluxFile,       &                EmPmRfile, saltFluxFile,
106       &                surfQfile, surfQnetFile, surfQswFile,       &                surfQfile, surfQnetFile, surfQswFile,
107       &                lambdaThetaFile, lambdaSaltFile,       &                lambdaThetaFile, lambdaSaltFile,
108       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
109       &                dQdTfile, ploadFile,       &                dQdTfile, ploadFile,
110       &                eddyTauxFile, eddyTauyFile,       &                eddyTauxFile, eddyTauyFile,
      &                eosType, pickupSuff,  
      &                mdsioLocalDir,  
111       &                the_run_name       &                the_run_name
112        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
113          CHARACTER*(6)  eosType
114          CHARACTER*(10) pickupSuff
115          CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
116          CHARACTER*(MAX_LEN_FNAM) tRefFile
117          CHARACTER*(MAX_LEN_FNAM) sRefFile
118          CHARACTER*(MAX_LEN_FNAM) rhoRefFile
119          CHARACTER*(MAX_LEN_FNAM) delRFile
120          CHARACTER*(MAX_LEN_FNAM) delRcFile
121        CHARACTER*(MAX_LEN_FNAM) delXFile        CHARACTER*(MAX_LEN_FNAM) delXFile
122        CHARACTER*(MAX_LEN_FNAM) delYFile        CHARACTER*(MAX_LEN_FNAM) delYFile
123        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
124        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile
125        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
126        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) diffKrFile
127        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
128        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
129        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
# Line 112  C     the_run_name    :: string identify Line 133  C     the_run_name    :: string identify
133        CHARACTER*(MAX_LEN_FNAM) surfQswFile        CHARACTER*(MAX_LEN_FNAM) surfQswFile
134        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
135        CHARACTER*(MAX_LEN_FNAM) saltFluxFile        CHARACTER*(MAX_LEN_FNAM) saltFluxFile
       CHARACTER*(MAX_LEN_FNAM) buoyancyRelation  
136        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
137        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
138        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
# Line 122  C     the_run_name    :: string identify Line 142  C     the_run_name    :: string identify
142        CHARACTER*(MAX_LEN_FNAM) eddyTauyFile        CHARACTER*(MAX_LEN_FNAM) eddyTauyFile
143        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
144        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
145        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_PREC/2) the_run_name
       CHARACTER*(MAX_LEN_FNAM) the_run_name  
       CHARACTER*(6) eosType  
       CHARACTER*(10) pickupSuff  
146    
147  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
148  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
# Line 140  C     cg3dChkResFreq      :: Frequency w Line 157  C     cg3dChkResFreq      :: Frequency w
157  C                           in con. grad solver.  C                           in con. grad solver.
158  C     nIter0              :: Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
159  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.  
160  C     writeStatePrec      :: Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
161  C     writeBinaryPrec     :: Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
162  C     readBinaryPrec      :: Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
 C     nCheckLev           :: Holds current checkpoint level  
163  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
164  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
165  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
166  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
167    C     momForcingOutAB     :: =1: take momentum forcing contribution
168    C                           out of (=0: in) Adams-Bashforth time stepping.
169    C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
170    C                           out of (=0: in) Adams-Bashforth time stepping.
171  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
172  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
173  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
174  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
175    C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)
176    C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)
177    C     monitorSelect       :: select group of variables to monitor
178    C                            =1 : dynvars ; =2 : + vort ; =3 : + surface
179  C     debugLevel          :: debug level selector: higher -> more writing  C     debugLevel          :: debug level selector: higher -> more writing
180    
181        COMMON /PARM_I/        COMMON /PARM_I/
# Line 162  C     debugLevel          :: debug level Line 184  C     debugLevel          :: debug level
184       &        cg3dMaxIters,       &        cg3dMaxIters,
185       &        cg3dChkResFreq,       &        cg3dChkResFreq,
186       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
187       &        numStepsPerPickup,       &        writeStatePrec,
      &        writeStatePrec, nCheckLev,  
188       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
189       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
190         &        momForcingOutAB, tracForcingOutAB,
191       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
192       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
193       &        debugLevel       &        selectKEscheme, selectVortScheme,
194         &        monitorSelect, debugLevel
195        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
196        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
197        INTEGER cg2dPreCondFreq        INTEGER cg2dPreCondFreq
# Line 177  C     debugLevel          :: debug level Line 200  C     debugLevel          :: debug level
200        INTEGER nIter0        INTEGER nIter0
201        INTEGER nTimeSteps        INTEGER nTimeSteps
202        INTEGER nEndIter        INTEGER nEndIter
       INTEGER numStepsPerPickup  
203        INTEGER writeStatePrec        INTEGER writeStatePrec
204        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
205        INTEGER readBinaryPrec        INTEGER readBinaryPrec
       INTEGER nCheckLev  
206        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
207        INTEGER select_rStar        INTEGER select_rStar
208          INTEGER momForcingOutAB, tracForcingOutAB
209        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
210        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
211          INTEGER selectKEscheme
212          INTEGER selectVortScheme
213          INTEGER monitorSelect
214        INTEGER debugLevel        INTEGER debugLevel
215    
216  C  C
# Line 199  C Line 224  C
224  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
225  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
226  C                          coordinate frame.  C                          coordinate frame.
227  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
228  C                               spherical polar frame.  C                               spherical polar frame.
229  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
230    C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
231    C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
232  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
233  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  
234  C     momViscosity  :: Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
235  C     momAdvection  :: Flag which turns advection of momentum on and off.  C     momAdvection  :: Flag which turns advection of momentum on and off.
236  C     momForcing    :: Flag which turns external forcing of momentum on  C     momForcing    :: Flag which turns external forcing of momentum on
# Line 212  C                     and off. Line 238  C                     and off.
238  C     momPressureForcing :: Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
239  C                          on and off.  C                          on and off.
240  C     metricTerms   :: Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
241  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.  
242  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
243  C     tempAdvection :: Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
244  C                     and off.  C                     and off.
245  C     tempForcing   :: Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
246  C                     and off.  C                     and off.
247  C     saltAdvection :: Flag which turns advection of salinity on  C     saltAdvection :: Flag which turns advection of salinity on
248  C                     and off.  C                     and off.
249  C     saltForcing   :: Flag which turns external forcing of salinity on  C     saltForcing   :: Flag which turns external forcing of salinity on
250  C                     and off.  C                     and off.
251  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
252  C                         as a real Fresh Water (=> changes the Sea Level)  C                         as a real Fresh Water (=> changes the Sea Level)
253  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)
254  C     useFullLeith   :: Set to true to use full Leith viscosity (may be unstable  C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
255  C                       on irregular grids)  C                       on irregular grids)
256  C     useAnisotropicViscAGridMax :: Set to true to use Alistair's latest  C     useAreaViscLength :: Set to true to use old scaling for viscous
257  C              anisotropic length scale.  It is used only for maximum viscosity  C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.
 C              calculations.  Alistair recommends a value of viscA*GridMax=.25  
258  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
259  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
260  C     implicitFreeSurface :: Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
261  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
262    C     linFSConserveTr     :: Set to true to correct source/sink of tracer
263    C                            at the surface due to Linear Free Surface
264  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
265  C                           linear relation Phi_surf = Bo_surf*eta  C                           linear relation Phi_surf = Bo_surf*eta
266    C     use3Dsolver   :: set to true to use 3-D pressure solver
267    C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
268    C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
269  C     momStepping   :: Turns momentum equation time-stepping off  C     momStepping   :: Turns momentum equation time-stepping off
270  C     tempStepping  :: Turns temperature equation time-stepping off  C     tempStepping  :: Turns temperature equation time-stepping off
271  C     saltStepping  :: Turns salinity equation time-stepping off  C     saltStepping  :: Turns salinity equation time-stepping off
272  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
273  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
274  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
275    C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
276  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
277  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
278  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
 C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny  
279  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
280  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
281  C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)  C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
# Line 258  C     saltImplVertAdv :: Turns on implic Line 287  C     saltImplVertAdv :: Turns on implic
287  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
288  C     multiDimAdvection :: Flag that enable multi-dimension advection  C     multiDimAdvection :: Flag that enable multi-dimension advection
289  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
290  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution  C     momDissip_In_AB   :: if False, put Dissipation tendency contribution
291  C                      out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
292  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
293    C                          apply AB on tracer tendencies (rather than on Tracer)
294    C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
295    C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
296    C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
297    C                           before checkpoint-54a, Jul 06, 2004.
298  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
299  C                        climatology is required.  C                        climatology is required.
300  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
# Line 276  C     fluidIsWater     :: Set to indicat Line 310  C     fluidIsWater     :: Set to indicat
310  C                        is water  C                        is water
311  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.)
312  C                         this requires specific code for restart & exchange  C                         this requires specific code for restart & exchange
313  C     setCenterDr    :: set cell Center depth and put Interface at the middle  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
314    C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
315  C     nonHydrostatic :: Using non-hydrostatic terms  C     nonHydrostatic :: Using non-hydrostatic terms
316  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
317  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
# Line 289  C     useOldFreezing :: use the old vers Line 324  C     useOldFreezing :: use the old vers
324  C     pickup_write_mdsio :: use mdsio to write pickups  C     pickup_write_mdsio :: use mdsio to write pickups
325  C     pickup_read_mdsio  :: use mdsio to read  pickups  C     pickup_read_mdsio  :: use mdsio to read  pickups
326  C     pickup_write_immed :: echo the pickup immediately (for conversion)  C     pickup_write_immed :: echo the pickup immediately (for conversion)
327    C     writePickupAtEnd   :: write pickup at the last timestep
328  C     timeave_mdsio      :: use mdsio for timeave output  C     timeave_mdsio      :: use mdsio for timeave output
329  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
330  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
331  C     calendarDumps :: When set, approximate months (30-31 days) and years (360-372 days)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
 C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,  
 C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact  
 C                      calendar months and years.  Requires pkg/cal.  
 C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  
332  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
333    C     balanceEmPmR    :: substract global mean of EmPmR at every time step
334    C     balanceQnet     :: substract global mean of Qnet at every time step
335    C     balancePrintMean:: print substracted global means to STDOUT
336    C     rotateGrid      :: rotate grid coordinates to geographical coordinates
337    C                        according to Euler angles phiEuler, thetaEuler, psiEuler
338    
339        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
340       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
341         & deepAtmosphere, setInterFDr, setCenterDr,
342       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
343       & staggerTimeStep,       & momViscosity, momAdvection, momForcing, useCoriolis,
      & momViscosity, momAdvection, momForcing, useCoriolis,  
344       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
345       & tempAdvection, tempForcing,       & tempAdvection, tempForcing,
346       & saltAdvection, saltForcing,       & saltAdvection, saltForcing,
347       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
348       & useFullLeith, useAnisotropicViscAGridMax, useStrainTensionVisc,       & useFullLeith, useStrainTensionVisc,
349       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & useAreaViscLength,
350         & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
351         & uniformLin_PhiSurf,
352         & use3Dsolver, implicitIntGravWave, staggerTimeStep,
353       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
354       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, useNHMTerms,
355       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF, use3dCoriolis,
356       & useCDscheme,       & useCDscheme,
357       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
358       & SadournyCoriolis, upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
359       & useAbsVorticity, upwindShear,       & useAbsVorticity, upwindShear,
360       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
361       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
362       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,       & multiDimAdvection, useMultiDimAdvec,
363       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & momDissip_In_AB, doAB_onGtGs,
364       & periodicExternalForcing,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
365         & periodicExternalForcing,
366       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
367       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc,
368       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
369       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
370       & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
371       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
372         & writePickupAtEnd,
373       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
374       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast, debugMode,
375       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & inAdMode, inAdTrue, inAdFalse, inAdExact,
376       & calendarDumps       & balanceEmPmR, balanceQnet, balancePrintMean,
377         & rotateGrid
378    
379        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
380        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
381        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
382        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
383        LOGICAL usingSphericalPolarMTerms        LOGICAL deepAtmosphere
384          LOGICAL setInterFDr
385          LOGICAL setCenterDr
386        LOGICAL useNHMTerms        LOGICAL useNHMTerms
387        LOGICAL no_slip_sides        LOGICAL no_slip_sides
388        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
       LOGICAL staggerTimeStep  
389        LOGICAL momViscosity        LOGICAL momViscosity
390        LOGICAL momAdvection        LOGICAL momAdvection
391        LOGICAL momForcing        LOGICAL momForcing
# Line 353  C                        & Last iteratio Line 398  C                        & Last iteratio
398        LOGICAL saltForcing        LOGICAL saltForcing
399        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
400        LOGICAL useFullLeith        LOGICAL useFullLeith
       LOGICAL useAnisotropicViscAGridMax  
401        LOGICAL useStrainTensionVisc        LOGICAL useStrainTensionVisc
402          LOGICAL useAreaViscLength
403        LOGICAL rigidLid        LOGICAL rigidLid
404        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
405        LOGICAL exactConserv        LOGICAL exactConserv
406          LOGICAL linFSConserveTr
407        LOGICAL uniformLin_PhiSurf        LOGICAL uniformLin_PhiSurf
408          LOGICAL use3Dsolver
409          LOGICAL implicitIntGravWave
410          LOGICAL staggerTimeStep
411        LOGICAL momStepping        LOGICAL momStepping
412        LOGICAL tempStepping        LOGICAL tempStepping
413        LOGICAL saltStepping        LOGICAL saltStepping
# Line 366  C                        & Last iteratio Line 415  C                        & Last iteratio
415        LOGICAL useConstantF        LOGICAL useConstantF
416        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
417        LOGICAL useSphereF        LOGICAL useSphereF
418          LOGICAL use3dCoriolis
419        LOGICAL useCDscheme        LOGICAL useCDscheme
420        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
421        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
422        LOGICAL useJamartMomAdv        LOGICAL useJamartMomAdv
       LOGICAL SadournyCoriolis  
423        LOGICAL upwindVorticity        LOGICAL upwindVorticity
424        LOGICAL highOrderVorticity        LOGICAL highOrderVorticity
425        LOGICAL useAbsVorticity        LOGICAL useAbsVorticity
426        LOGICAL upwindShear        LOGICAL upwindShear
427        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
428        LOGICAL implicitViscosity        LOGICAL implicitViscosity
429        LOGICAL tempImplVertAdv        LOGICAL tempImplVertAdv
430        LOGICAL saltImplVertAdv        LOGICAL saltImplVertAdv
431        LOGICAL momImplVertAdv        LOGICAL momImplVertAdv
432        LOGICAL multiDimAdvection        LOGICAL multiDimAdvection
433        LOGICAL useMultiDimAdvec        LOGICAL useMultiDimAdvec
434        LOGICAL forcing_In_AB        LOGICAL momDissip_In_AB
435          LOGICAL doAB_onGtGs
436        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
437        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
438        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
# Line 392  C                        & Last iteratio Line 442  C                        & Last iteratio
442        LOGICAL usingPCoords        LOGICAL usingPCoords
443        LOGICAL usingZCoords        LOGICAL usingZCoords
444        LOGICAL useDynP_inEos_Zc        LOGICAL useDynP_inEos_Zc
       LOGICAL setCenterDr  
445        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
446        LOGICAL quasiHydrostatic        LOGICAL quasiHydrostatic
447        LOGICAL globalFiles        LOGICAL globalFiles
448        LOGICAL useSingleCpuIO        LOGICAL useSingleCpuIO
449        LOGICAL allowFreezing        LOGICAL allowFreezing
450        LOGICAL useOldFreezing        LOGICAL useOldFreezing
451        LOGICAL usePickupBeforeC35        LOGICAL pickupStrictlyMatch
452        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
453        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
454        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
455        LOGICAL debugMode        LOGICAL debugMode
456        LOGICAL pickup_read_mdsio, pickup_write_mdsio        LOGICAL pickup_read_mdsio, pickup_write_mdsio
457        LOGICAL pickup_write_immed        LOGICAL pickup_write_immed, writePickupAtEnd
458        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
459        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
460        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
461        LOGICAL calendarDumps  
462          LOGICAL balanceEmPmR
463          LOGICAL balanceQnet
464          LOGICAL balancePrintMean
465    
466          LOGICAL rotateGrid
467    
468  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
469  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 440  C     gravity   :: Accel. due to gravity Line 494  C     gravity   :: Accel. due to gravity
494  C     recip_gravity and its inverse  C     recip_gravity and its inverse
495  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 )
496  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
497  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
498    C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
499    C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
500  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
501  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
502  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
503    C     phiRef    :: reference potential (pressure/rho, geopotential) profile
504    C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:
505    C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
506    C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
507    C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
508    C                :: from r-coordinate vertical velocity to vertical velocity [m/s].
509    C                :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit
510    C     wUnit2rVel :: units conversion factor (Non-Hydrostatic code),
511    C                :: from vertical velocity [m/s] to r-coordinate vertical velocity.
512    C                :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel
513    C     mass2rUnit :: units conversion factor (surface forcing),
514    C                :: from mass per unit area [kg/m2] to vertical r-coordinate unit.
515    C                :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ;
516    C                :: p-coord: = gravity    ( [kg/m2] *  g = [Pa] ) ;
517    C     rUnit2mass :: units conversion factor (surface forcing),
518    C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
519    C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
520    C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
521  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
522  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
523  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
524  C                 to make geographical references simple.)  C                 to make geographical references simple.)
525  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).
526  C     recip_RSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
527  C     f0        :: Reference coriolis parameter ( 1/s )  C     f0        :: Reference coriolis parameter ( 1/s )
528  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
529  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
530  C     omega     :: Angular velocity ( rad/s )  C     omega     :: Angular velocity ( rad/s )
531  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
532    C     viscAr    :: Eddy viscosity coeff. for mixing of
533    C                 momentum vertically ( units of r^2/s )
534  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
535  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
536  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
537  C                 momentum laterally, no effect for hydrostatic  C                 momentum laterally, no effect for hydrostatic
538  C                 model, defaults to viscAh if unset ( m^2/s )  C                 model, defaults to viscAh if unset ( m^2/s )
539  C     viscAr    :: Eddy viscosity coeff. for mixing of  C                 Not used if variable horiz. viscosity is used.
 C                 momentum vertically ( units of r^2/s )  
540  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
541  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
542  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical
543  C                 momentum laterally, no effect for hydrostatic  C                 momentum laterally, no effect for hydrostatic
544  C                 model, defaults to viscA4 if unset ( m^2/s )  C                 model, defaults to viscA4 if unset ( m^2/s )
545    C                 Not used if variable horiz. viscosity is used.
546  C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally
547  C                  (act on Divergence part) ( m^2/s )  C                  (act on Divergence part) ( m^2/s )
548  C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally
# Line 475  C     viscA4D   :: Biharmonic viscosity Line 551  C     viscA4D   :: Biharmonic viscosity
551  C                  (act on Divergence part) ( m^4/s )  C                  (act on Divergence part) ( m^4/s )
552  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
553  C                  (act on Vorticity  part) ( m^4/s )  C                  (act on Vorticity  part) ( m^4/s )
554  C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
555  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
556  C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor (harmonic)  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
557  C     viscC4smag  :: Smagorinsky non-dimensional viscosity factor (biharmonic)  C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
558  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  C     viscC2smag   :: Smagorinsky non-dimensional viscosity factor (harmonic)
559  C                   momentum laterally ( m^2/s )  C     viscC4smag   :: Smagorinsky non-dimensional viscosity factor (biharmonic)
560  C     viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity  C     viscAhMax    :: Maximum eddy viscosity coeff. for mixing of
561  C                   coeff. for mixing of momentum laterally (non-dim)  C                    momentum laterally ( m^2/s )
562    C     viscAhReMax  :: Maximum gridscale Reynolds number for eddy viscosity
563    C                     coeff. for mixing of momentum laterally (non-dim)
564    C     viscAhGrid   :: non-dimensional grid-size dependent viscosity
565  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
566  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
567  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max    :: Maximum biharmonic viscosity coeff. for mixing of
568  C                 momentum laterally ( m^4/s )  C                     momentum laterally ( m^4/s )
569  C     viscA4ReMax :: Maximum Gridscale Reynolds number for  C     viscA4ReMax  :: Maximum Gridscale Reynolds number for
570  C                  biharmonic viscosity coeff. momentum laterally (non-dim)  C                     biharmonic viscosity coeff. momentum laterally (non-dim)
571  C     viscAhGrid:: non-dimensional grid-size dependent viscosity  C     viscA4Grid   :: non-dimensional grid-size dependent bi-harmonic viscosity
 C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity  
572  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
573  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
 C     viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))  
 C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))  
574  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
575  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
576  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
577  C                 for mixing of heat vertically ( units of r^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
578  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
579  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
580  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
581  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
582  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
583  C                 for mixing of salt vertically ( units of r^2/s ),  C                 for mixing of salt vertically ( units of r^2/s ),
584  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
585  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
586  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
587  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
588  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
589  C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979  C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
590    C     BL79LatVary    :: polarwise of this latitude diffKrBL79 is applied with
591    C                       gradual transition to diffKrBLEQ towards Equator
592    C     diffKrBLEQsurf :: same as diffKrBL79surf but at Equator
593    C     diffKrBLEQdeep :: same as diffKrBL79deep but at Equator
594    C     diffKrBLEQscl  :: same as diffKrBL79scl but at Equator
595    C     diffKrBLEQHo   :: same as diffKrBL79Ho but at Equator
596  C     deltaT    :: Default timestep ( s )  C     deltaT    :: Default timestep ( s )
597  C     deltaTClock  :: Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
598  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
# Line 557  C     mtFacMom      :: Metric terms trac Line 639  C     mtFacMom      :: Metric terms trac
639  C     cosPower      :: Power of cosine of latitude to multiply viscosity  C     cosPower      :: Power of cosine of latitude to multiply viscosity
640  C     cAdjFreq      :: Frequency of convective adjustment  C     cAdjFreq      :: Frequency of convective adjustment
641  C  C
642  C     taveFreq      :: Frequency with which time-averaged model state  C     taveFreq      :: Frequency with which time-averaged model state
643  C                      is written to post-processing files ( s ).  C                      is written to post-processing files ( s ).
644  C     tave_lastIter :: (for state variable only) fraction of the last time  C     tave_lastIter :: (for state variable only) fraction of the last time
645  C                      step (of each taveFreq period) put in the time average.  C                      step (of each taveFreq period) put in the time average.
646  C                      (fraction for 1rst iter = 1 - tave_lastIter)  C                      (fraction for 1rst iter = 1 - tave_lastIter)
647  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
648  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
# Line 572  C                          (note: extern Line 654  C                          (note: extern
654  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
655  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
656  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
657  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
658  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
659  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
660  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
661  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
662  C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.  C     hMixCrit    :: criteria for mixed-layer diagnostic
663  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
664  C                          ( g*rho if horiz in m and vertical in Pa ).  C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
665  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)
666  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
667  C     bottomDragLinear   :: Drag coefficient built in to core dynamics  C                           (default=2: full drag ; =1: gives half-slip BC)
668  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
669        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,  C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
670    C               (if using zcoordinate, units becomes linear: m/s, quadratic: [-])
671    C     smoothAbsFuncRange :: 1/2 of interval around zero, for which FORTRAN ABS
672    C                           is to be replace by a smoother function
673    C                           (affects myabs, mymin, mymax)
674    C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
675    C                      (i.e. allows convection at different Rayleigh numbers)
676    C     phiEuler      :: Euler angle, rotation about original z-axis
677    C     thetaEuler    :: Euler angle, rotation about new x-axis
678    C     psiEuler      :: Euler angle, rotation about new z-axis
679          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
680       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
681       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
682       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
# Line 595  C      --"-"--  Quadratic  ( linear: 1/s Line 687  C      --"-"--  Quadratic  ( linear: 1/s
687       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
688       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
689       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
690       & viscA4, viscA4W,       & viscA4, viscA4W, viscA4Max,
691       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Grid, viscA4GridMax, viscA4GridMin,
692       & viscAhRemax, viscA4Remax,       & viscAhReMax, viscA4ReMax,
693       & viscC4leith, viscC4leithD, viscAr,       & viscC4leith, viscC4leithD, viscAr,
694       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
695       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
696       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
697         & BL79LatVary,
698         & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
699       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
700       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
701       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_gravity, gBaro,
702       & recip_rhoConst, rhoConst,       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
703       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
704       & baseTime, startTime, endTime,       & rhoConstFresh, tRef, sRef, phiRef, dBdrRef,
705       & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
706         & baseTime, startTime, endTime,
707         & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
708       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
709       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
710       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
711       & tauThetaClimRelax,       & tauThetaClimRelax, tauSaltClimRelax,
      & tauSaltClimRelax,  
712       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
713       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
714       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
715       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
716       & horiVertRatio, recip_horiVertRatio,       & ivdc_kappa, hMixCriteria, Ro_SeaLevel,
717       & ivdc_kappa, Ro_SeaLevel,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
718       & bottomDragLinear,bottomDragQuadratic,nh_Am2,       & smoothAbsFuncRange,
719       & tCylIn, tCylOut       & tCylIn, tCylOut,
720         & phiEuler, thetaEuler, psiEuler
721    
       _RL nh_Am2  
722        _RL cg2dTargetResidual        _RL cg2dTargetResidual
723        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
724        _RL cg3dTargetResidual        _RL cg3dTargetResidual
# Line 641  C      --"-"--  Quadratic  ( linear: 1/s Line 736  C      --"-"--  Quadratic  ( linear: 1/s
736        _RL phiMin        _RL phiMin
737        _RL thetaMin        _RL thetaMin
738        _RL rSphere        _RL rSphere
739        _RL recip_RSphere        _RL recip_rSphere
740        _RL f0        _RL f0
741        _RL freeSurfFac        _RL freeSurfFac
742        _RL implicSurfPress        _RL implicSurfPress
# Line 653  C      --"-"--  Quadratic  ( linear: 1/s Line 748  C      --"-"--  Quadratic  ( linear: 1/s
748        _RL hFacInf        _RL hFacInf
749        _RL hFacSup        _RL hFacSup
750        _RL beta        _RL beta
751          _RL viscAr
752        _RL viscAh        _RL viscAh
753        _RL viscAhW        _RL viscAhW
754        _RL viscAhD        _RL viscAhD
755        _RL viscAhZ        _RL viscAhZ
756        _RL viscAhMax        _RL viscAhMax
757        _RL viscAhReMax        _RL viscAhReMax
758        _RL viscAhGrid        _RL viscAhGrid, viscAhGridMax, viscAhGridMin
       _RL viscAhGridMax  
       _RL viscAhGridMin  
759        _RL viscC2leith        _RL viscC2leith
760        _RL viscC2leithD        _RL viscC2leithD
761        _RL viscC2smag        _RL viscC2smag
762        _RL viscC4smag        _RL viscA4
       _RL viscAr  
       _RL viscA4  
763        _RL viscA4W        _RL viscA4W
764        _RL viscA4D        _RL viscA4D
765        _RL viscA4Z        _RL viscA4Z
# Line 676  C      --"-"--  Quadratic  ( linear: 1/s Line 768  C      --"-"--  Quadratic  ( linear: 1/s
768        _RL viscA4Grid, viscA4GridMax, viscA4GridMin        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
769        _RL viscC4leith        _RL viscC4leith
770        _RL viscC4leithD        _RL viscC4leithD
771        _RL diffKhT        _RL viscC4smag
772          _RL diffKhT
773        _RL diffKrNrT(Nr)        _RL diffKrNrT(Nr)
774        _RL diffK4T        _RL diffK4T
775        _RL diffKhS        _RL diffKhS
776        _RL diffKrNrS(Nr)        _RL diffKrNrS(Nr)
777        _RL diffK4S        _RL diffK4S
778        _RL diffKrBL79surf        _RL diffKrBL79surf
779        _RL diffKrBL79deep        _RL diffKrBL79deep
780        _RL diffKrBL79scl        _RL diffKrBL79scl
781        _RL diffKrBL79Ho        _RL diffKrBL79Ho
782          _RL BL79LatVary
783          _RL diffKrBLEQsurf
784          _RL diffKrBLEQdeep
785          _RL diffKrBLEQscl
786          _RL diffKrBLEQHo
787        _RL delt        _RL delt
788        _RL tauCD        _RL tauCD
789        _RL rCD        _RL rCD
790        _RL gravity        _RL gravity
791        _RL recip_gravity        _RL recip_gravity
792        _RL gBaro        _RL gBaro
793        _RL rhonil        _RL rhonil,        recip_rhonil
794        _RL recip_rhonil        _RL rhoConst,      recip_rhoConst
795        _RL rhoConst        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
796        _RL recip_rhoConst        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
797        _RL rhoConstFresh        _RL rhoConstFresh
       _RL convertEmP2rUnit  
798        _RL tRef(Nr)        _RL tRef(Nr)
799        _RL sRef(Nr)        _RL sRef(Nr)
800          _RL phiRef(2*Nr+1)
801          _RL dBdrRef(Nr)
802          _RL rVel2wUnit(Nr+1), wUnit2rVel(Nr+1)
803          _RL mass2rUnit, rUnit2mass
804        _RL baseTime        _RL baseTime
805        _RL startTime        _RL startTime
806        _RL endTime        _RL endTime
# Line 717  C      --"-"--  Quadratic  ( linear: 1/s Line 818  C      --"-"--  Quadratic  ( linear: 1/s
818        _RL pfFacMom        _RL pfFacMom
819        _RL cfFacMom        _RL cfFacMom
820        _RL foFacMom        _RL foFacMom
821        _RL mTFacMom        _RL mtFacMom
822        _RL cosPower        _RL cosPower
823        _RL cAdjFreq        _RL cAdjFreq
824        _RL omega        _RL omega
# Line 732  C      --"-"--  Quadratic  ( linear: 1/s Line 833  C      --"-"--  Quadratic  ( linear: 1/s
833        _RL convertFW2Salt        _RL convertFW2Salt
834        _RL temp_EvPrRn        _RL temp_EvPrRn
835        _RL salt_EvPrRn        _RL salt_EvPrRn
       _RL horiVertRatio  
       _RL recip_horiVertRatio  
836        _RL ivdc_kappa        _RL ivdc_kappa
837          _RL hMixCriteria
838        _RL Ro_SeaLevel        _RL Ro_SeaLevel
839          _RL sideDragFactor
840        _RL bottomDragLinear        _RL bottomDragLinear
841        _RL bottomDragQuadratic        _RL bottomDragQuadratic
842          _RL smoothAbsFuncRange
843          _RL nh_Am2
844        _RL tCylIn        _RL tCylIn
845        _RL tCylOut        _RL tCylOut
846          _RL phiEuler, thetaEuler, psiEuler
847    
848  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
849        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
# Line 755  C     atm_kappa :: kappa = R/Cp (R: cons Line 859  C     atm_kappa :: kappa = R/Cp (R: cons
859  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
860  C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])  C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
861  C     integr_GeoPot :: option to select the way we integrate the geopotential  C     integr_GeoPot :: option to select the way we integrate the geopotential
862  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
863  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
864  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
865        COMMON /PARM_ATM/        COMMON /PARM_ATM/
866       &            celsius2K,       &            celsius2K,
867       &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,       &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
868       &            integr_GeoPot, selectFindRoSurf       &            integr_GeoPot, selectFindRoSurf
# Line 772  C Logical flags for selecting packages Line 876  C Logical flags for selecting packages
876        LOGICAL useMY82        LOGICAL useMY82
877        LOGICAL useGGL90        LOGICAL useGGL90
878        LOGICAL useKPP        LOGICAL useKPP
879          LOGICAL useGAD
880        LOGICAL useGMRedi        LOGICAL useGMRedi
881        LOGICAL useOBCS        LOGICAL useOBCS
882        LOGICAL useAIM        LOGICAL useAIM
883        LOGICAL useLand        LOGICAL useLand
884          LOGICAL useCAL
885          LOGICAL useEXF
886          LOGICAL useEBM
887        LOGICAL useGrdchk        LOGICAL useGrdchk
888        LOGICAL useECCO        LOGICAL useECCO
889        LOGICAL useSHAP_FILT        LOGICAL useSHAP_FILT
# Line 783  C Logical flags for selecting packages Line 891  C Logical flags for selecting packages
891        LOGICAL useFLT        LOGICAL useFLT
892        LOGICAL usePTRACERS        LOGICAL usePTRACERS
893        LOGICAL useGCHEM        LOGICAL useGCHEM
894          LOGICAL useRBCS
895          LOGICAL useOffLine
896          LOGICAL useMATRIX
897        LOGICAL useSBO        LOGICAL useSBO
898        LOGICAL useSEAICE        LOGICAL useSEAICE
899        LOGICAL useBulkForce        LOGICAL useShelfIce
900        LOGICAL useThSIce        LOGICAL useThSIce
901          LOGICAL useATM2d
902          LOGICAL useBulkForce
903        LOGICAL usefizhi        LOGICAL usefizhi
904        LOGICAL usegridalt        LOGICAL usegridalt
905        LOGICAL usediagnostics        LOGICAL useDiagnostics
       LOGICAL useEBM  
906        LOGICAL useMNC        LOGICAL useMNC
907        LOGICAL useMATRIX        LOGICAL useREGRID
908        LOGICAL useRunClock        LOGICAL useRunClock
909          LOGICAL useEMBED_FILES
910          LOGICAL useMYPACKAGE
911          LOGICAL useSALT_PLUME
912        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
913       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
914       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useGAD, useGMRedi, useOBCS, useAIM, useLand,
915       &        usePTRACERS, useGCHEM,       &        useCAL, useEXF, useEBM, useGrdchk, useECCO,
916       &        useSBO, useSEAICE, useThSIce, useBulkForce,       &        useSHAP_FILT, useZONAL_FILT, useFLT,
917       &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
918       &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,       &        useSBO, useSEAICE, useShelfIce,
919       &        useRunClock       &        useThSIce, useATM2D, useBulkForce,
920         &        usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID,
921         &        useRunClock, useEMBED_FILES, useMYPACKAGE, useSALT_PLUME
922    
923  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
924  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***

Legend:
Removed from v.1.166  
changed lines
  Added in v.1.214

  ViewVC Help
Powered by ViewVC 1.1.22