/[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.193 by jmc, Thu Dec 28 01:46:30 2006 UTC revision 1.216 by jmc, Sat Apr 5 18:09:30 2008 UTC
# Line 43  C     UNSET_xxx :: Used to indicate vari Line 43  C     UNSET_xxx :: Used to indicate vari
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)  C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
56  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
57  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
# Line 58  C     delXFile      :: File containing X Line 61  C     delXFile      :: File containing X
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     shelfIceFile:: File containing the topography of the shelfice draught  C     shelfIceFile    :: File containing the topography of the shelfice draught
69  C                    (unit=m)  C                        (unit=m)
70  C     hydrogThetaFile :: File containing initial hydrographic data for potential  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
71  C                       temperature.  C                        for potential temperature.
72  C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.  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 79  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,       &                tRefFile, sRefFile, rhoRefFile,
99       &                delRFile, delRcFile,       &                delRFile, delRcFile,
100       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
101       &                bathyFile, topoFile, shelfIceFile,       &                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        CHARACTER*(MAX_LEN_FNAM) tRefFile
117        CHARACTER*(MAX_LEN_FNAM) sRefFile        CHARACTER*(MAX_LEN_FNAM) sRefFile
118        CHARACTER*(MAX_LEN_FNAM) rhoRefFile        CHARACTER*(MAX_LEN_FNAM) rhoRefFile
# Line 115  C     the_run_name    :: string identify Line 122  C     the_run_name    :: string identify
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, shelfIceFile        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 126  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 136  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
       CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir  
145        CHARACTER*(MAX_LEN_PREC/2) the_run_name        CHARACTER*(MAX_LEN_PREC/2) 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 154  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
# Line 173  C     tempVertAdvScheme   :: Temp. Vert. Line 173  C     tempVertAdvScheme   :: Temp. Vert.
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.)  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 181  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,       &        momForcingOutAB, tracForcingOutAB,
191       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
192       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
193       &        selectKEscheme,       &        selectKEscheme, selectVortScheme,
194       &        debugLevel       &        monitorSelect, debugLevel
195        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
196        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
197        INTEGER cg2dPreCondFreq        INTEGER cg2dPreCondFreq
# Line 198  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        INTEGER momForcingOutAB, tracForcingOutAB
209        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
210        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
211        INTEGER selectKEscheme        INTEGER selectKEscheme
212          INTEGER selectVortScheme
213          INTEGER monitorSelect
214        INTEGER debugLevel        INTEGER debugLevel
215    
216  C  C
# Line 220  C Line 222  C
222        PARAMETER(debLevB=2)        PARAMETER(debLevB=2)
223    
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- Coordinate + Grid params:
226    C     fluidIsAir       :: Set to indicate that the fluid major constituent
227    C                        is air
228    C     fluidIsWater     :: Set to indicate that the fluid major constituent
229    C                        is water
230    C     usingPCoords     :: Set to indicate that we are working in a pressure
231    C                        type coordinate (p or p*).
232    C     usingZCoords     :: Set to indicate that we are working in a height
233    C                        type coordinate (z or z*)
234    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
235    C                         this requires specific code for restart & exchange
236  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
237  C                          coordinate frame.  C                          coordinate frame.
238  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
239  C                               spherical polar frame.  C                               spherical polar frame.
240  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     rotateGrid      :: rotate grid coordinates to geographical coordinates
241    C                        according to Euler angles phiEuler, thetaEuler, psiEuler
242  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
243    C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
244  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
245  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
246    C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
247    C- Momentum params:
248    C     no_slip_sides  :: Impose "no-slip" at lateral boundaries.
249  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
250    C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
251    C                       on irregular grids)
252    C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
253    C     useAreaViscLength :: Set to true to use old scaling for viscous lengths,
254    C                          e.g., L2=Raz.  May be preferable for cube sphere.
255  C     momViscosity  :: Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
256  C     momAdvection  :: Flag which turns advection of momentum on and off.  C     momAdvection  :: Flag which turns advection of momentum on and off.
257  C     momForcing    :: Flag which turns external forcing of momentum on  C     momForcing    :: Flag which turns external forcing of momentum on
258  C                     and off.  C                      and off.
259  C     momPressureForcing :: Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
260  C                          on and off.  C                          on and off.
261  C     metricTerms   :: Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
262  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
263  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
264  C     tempAdvection :: Flag which turns advection of temperature on  C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
 C                     and off.  
 C     tempForcing   :: Flag which turns external forcing of temperature on  
 C                     and off.  
 C     saltAdvection :: Flag which turns advection of salinity on  
 C                     and off.  
 C     saltForcing   :: Flag which turns external forcing of salinity on  
 C                     and off.  
 C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  
 C                         as a real Fresh Water (=> changes the Sea Level)  
 C                         if F, converts P+R-E to salt flux (no SL effect)  
 C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable  
 C                       on irregular grids)  
 C     useAreaViscLength :: Set to true to use old scaling for viscous  
 C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.  
 C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms  
 C     rigidLid            :: Set to true to use rigid lid  
 C     implicitFreeSurface :: Set to true to use implicit free surface  
 C     exactConserv        :: Set to true to conserve exactly the total Volume  
 C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the  
 C                           linear relation Phi_surf = Bo_surf*eta  
 C     use3Dsolver   :: set to true to use 3-D pressure solver  
 C     implicitIntGravWave :: treat Internal Gravity Wave implicitly  
 C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V  
 C     momStepping   :: Turns momentum equation time-stepping off  
 C     tempStepping  :: Turns temperature equation time-stepping off  
 C     saltStepping  :: Turns salinity equation time-stepping off  
265  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
266  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
267  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
 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     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
270    C                                (default = F = use mom_fluxform package)
271    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986)
272  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  
273  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
274  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
 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     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
277    C     momStepping    :: Turns momentum equation time-stepping off
278    C- Temp. & Salt params:
279    C     tempStepping   :: Turns temperature equation time-stepping off
280    C     saltStepping   :: Turns salinity equation time-stepping off
281    C     tempAdvection  :: Flag which turns advection of temperature on and off.
282    C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
283    C     tempForcing    :: Flag which turns external forcing of temperature on
284    C                       and off.
285    C     saltAdvection  :: Flag which turns advection of salinity on and off.
286    C     saltIsActiveTr :: Salinity  is a dynamically active tracer
287    C     saltForcing    :: Flag which turns external forcing of salinity on
288    C                       and off.
289    C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
290    C                         as a real Fresh Water (=> changes the Sea Level)
291    C                         if F, converts P+R-E to salt flux (no SL effect)
292    C- Time-stepping params:
293    C     rigidLid            :: Set to true to use rigid lid
294    C     implicitFreeSurface :: Set to true to use implicit free surface
295    C     exactConserv        :: Set to true to conserve exactly the total Volume
296    C     linFSConserveTr     :: Set to true to correct source/sink of tracer
297    C                            at the surface due to Linear Free Surface
298    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
299    C                            linear relation Phi_surf = Bo_surf*eta
300    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
301    C     nonHydrostatic   :: Using non-hydrostatic algorithm
302    C     use3Dsolver      :: set to true to use 3-D pressure solver
303    C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
304    C     staggerTimeStep   :: enable a Stagger time stepping U,V (& W) then T,S
305  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
306  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
307  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
# Line 287  C     useMultiDimAdvec  :: True if multi Line 312  C     useMultiDimAdvec  :: True if multi
312  C     momDissip_In_AB   :: if False, put Dissipation tendency contribution  C     momDissip_In_AB   :: if False, put Dissipation tendency contribution
313  C                          out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
314  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
315  C                          apply AB on tracer tendencies (rather than on Tracer)  C                          apply AB on tracer tendencies (rather than on Tracer)
316  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C- Other forcing params -
317    C     balanceEmPmR    :: substract global mean of EmPmR at every time step
318    C     balanceQnet     :: substract global mean of Qnet at every time step
319    C     balancePrintMean:: print substracted global means to STDOUT
320  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
321  C                        climatology is required.  C                        climatology is required.
322  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
323  C                        climatology is required.  C                        climatology is required.
324    C     allowFreezing  :: Allows surface water to freeze and form ice
325    C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
326  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
327  C     usingPCoords     :: Set to indicate that we are working in a pressure  C- I/O parameters -
 C                        type coordinate (p or p*).  
 C     usingZCoords     :: Set to indicate that we are working in a height  
 C                        type coordinate (z or z*)  
 C     fluidIsAir       :: Set to indicate that the fluid major constituent  
 C                        is air  
 C     fluidIsWater     :: Set to indicate that the fluid major constituent  
 C                        is water  
 C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)  
 C                         this requires specific code for restart & exchange  
 C     setInterFDr    :: set Interface depth (put cell-Center at the middle)  
 C     setCenterDr    :: set cell-Center depth (put Interface at the middle)  
 C     nonHydrostatic :: Using non-hydrostatic terms  
 C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm  
328  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
329  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
330  C                       slow (f77) or does not work (f90).  When  C                       slow (f77) or does not work (f90).  When
331  C                       useSingleCpuIO is set, mdsio_writefield.F  C                       useSingleCpuIO is set, mdsio_writefield.F
332  C                       outputs from master mpi process only.  C                       outputs from master mpi process only.
333  C     allowFreezing  :: Allows surface water to freeze and form ice  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
334  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
335    C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
336    C                           before checkpoint-54a, Jul 06, 2004.
337  C     pickup_write_mdsio :: use mdsio to write pickups  C     pickup_write_mdsio :: use mdsio to write pickups
338  C     pickup_read_mdsio  :: use mdsio to read  pickups  C     pickup_read_mdsio  :: use mdsio to read  pickups
339  C     pickup_write_immed :: echo the pickup immediately (for conversion)  C     pickup_write_immed :: echo the pickup immediately (for conversion)
340    C     writePickupAtEnd   :: write pickup at the last timestep
341  C     timeave_mdsio      :: use mdsio for timeave output  C     timeave_mdsio      :: use mdsio for timeave output
342  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
343  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
344  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
345  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
 C     balanceEmPmR    :: substract global mean of EmPmR at every time step  
 C     balanceQnet     :: substract global mean of Qnet at every time step  
 C     balancePrintMean:: print substracted global means to STDOUT  
346    
347        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/
348         & fluidIsAir, fluidIsWater,
349         & usingPCoords, usingZCoords, useDynP_inEos_Zc,
350         & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
351       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
352       & deepAtmosphere, setInterFDr, setCenterDr,       & deepAtmosphere, setInterFDr, setCenterDr,
353       & no_slip_sides,no_slip_bottom,       & no_slip_sides, no_slip_bottom,
354       & momViscosity, momAdvection, momForcing, useCoriolis,       & useFullLeith, useStrainTensionVisc, useAreaViscLength,
355       & momPressureForcing, vectorInvariantMomentum,       & momViscosity, momAdvection, momForcing,
356       & tempAdvection, tempForcing,       & momPressureForcing, metricTerms, useNHMTerms,
357       & saltAdvection, saltForcing,       & useCoriolis, use3dCoriolis,
358       & useRealFreshWaterFlux,       & useConstantF, useBetaPlaneF, useSphereF,
359       & useFullLeith, useStrainTensionVisc,       & useCDscheme, vectorInvariantMomentum,
      & useAreaViscLength,  
      & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,  
      & use3Dsolver, implicitIntGravWave, staggerTimeStep,  
      & momStepping, tempStepping, saltStepping,  
      & metricTerms, useNHMTerms,  
      & useConstantF, useBetaPlaneF, useSphereF, use3dCoriolis,  
      & useCDscheme,  
360       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
361       & SadournyCoriolis, upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
362       & useAbsVorticity, upwindShear,       & useAbsVorticity, upwindShear,
363         & momStepping, tempStepping, saltStepping,
364         & tempAdvection, tempIsActiveTr, tempForcing,
365         & saltAdvection, saltIsActiveTr, saltForcing,
366         & useRealFreshWaterFlux,
367         & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
368         & uniformLin_PhiSurf,
369         & quasiHydrostatic, nonHydrostatic,
370         & use3Dsolver, implicitIntGravWave, staggerTimeStep,
371       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
372       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
373       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
374       & momDissip_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
375       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & balanceEmPmR, balanceQnet, balancePrintMean,
376       & periodicExternalForcing,       & doThetaClimRelax, doSaltClimRelax,
      & fluidIsAir, fluidIsWater,  
      & usingPCoords, usingZCoords, useDynP_inEos_Zc,  
      & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,  
377       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
378       & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,       & periodicExternalForcing,
379         & globalFiles, useSingleCpuIO,
380         & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
381       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
382         & writePickupAtEnd,
383       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
384       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast, debugMode,
385       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & inAdMode, inAdTrue, inAdFalse, inAdExact
      & balanceEmPmR, balanceQnet, balancePrintMean  
386    
387          LOGICAL fluidIsAir
388          LOGICAL fluidIsWater
389          LOGICAL usingPCoords
390          LOGICAL usingZCoords
391          LOGICAL useDynP_inEos_Zc
392        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
393        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid, rotateGrid
394        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
395        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
396        LOGICAL deepAtmosphere        LOGICAL deepAtmosphere
# Line 381  C     balancePrintMean:: print substract Line 406  C     balancePrintMean:: print substract
406        LOGICAL useCoriolis        LOGICAL useCoriolis
407        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
408        LOGICAL tempAdvection        LOGICAL tempAdvection
409          LOGICAL tempIsActiveTr
410        LOGICAL tempForcing        LOGICAL tempForcing
411        LOGICAL saltAdvection        LOGICAL saltAdvection
412          LOGICAL saltIsActiveTr
413        LOGICAL saltForcing        LOGICAL saltForcing
414        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
415        LOGICAL useFullLeith        LOGICAL useFullLeith
# Line 391  C     balancePrintMean:: print substract Line 418  C     balancePrintMean:: print substract
418        LOGICAL rigidLid        LOGICAL rigidLid
419        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
420        LOGICAL exactConserv        LOGICAL exactConserv
421          LOGICAL linFSConserveTr
422        LOGICAL uniformLin_PhiSurf        LOGICAL uniformLin_PhiSurf
423          LOGICAL quasiHydrostatic
424          LOGICAL nonHydrostatic
425        LOGICAL use3Dsolver        LOGICAL use3Dsolver
426        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
427        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
# Line 407  C     balancePrintMean:: print substract Line 437  C     balancePrintMean:: print substract
437        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
438        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
439        LOGICAL useJamartMomAdv        LOGICAL useJamartMomAdv
       LOGICAL SadournyCoriolis  
440        LOGICAL upwindVorticity        LOGICAL upwindVorticity
441        LOGICAL highOrderVorticity        LOGICAL highOrderVorticity
442        LOGICAL useAbsVorticity        LOGICAL useAbsVorticity
# Line 421  C     balancePrintMean:: print substract Line 450  C     balancePrintMean:: print substract
450        LOGICAL useMultiDimAdvec        LOGICAL useMultiDimAdvec
451        LOGICAL momDissip_In_AB        LOGICAL momDissip_In_AB
452        LOGICAL doAB_onGtGs        LOGICAL doAB_onGtGs
453          LOGICAL balanceEmPmR
454          LOGICAL balanceQnet
455          LOGICAL balancePrintMean
456        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
457        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
458        LOGICAL doTr1ClimRelax        LOGICAL allowFreezing
459          LOGICAL useOldFreezing
460        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
       LOGICAL fluidIsAir  
       LOGICAL fluidIsWater  
       LOGICAL usingPCoords  
       LOGICAL usingZCoords  
       LOGICAL useDynP_inEos_Zc  
       LOGICAL nonHydrostatic  
       LOGICAL quasiHydrostatic  
461        LOGICAL globalFiles        LOGICAL globalFiles
462        LOGICAL useSingleCpuIO        LOGICAL useSingleCpuIO
463        LOGICAL allowFreezing        LOGICAL pickupStrictlyMatch
       LOGICAL useOldFreezing  
       LOGICAL usePickupBeforeC35  
464        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
465        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
       LOGICAL dumpInitAndLast  
       LOGICAL debugMode  
466        LOGICAL pickup_read_mdsio, pickup_write_mdsio        LOGICAL pickup_read_mdsio, pickup_write_mdsio
467        LOGICAL pickup_write_immed        LOGICAL pickup_write_immed, writePickupAtEnd
468        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
469        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
470          LOGICAL dumpInitAndLast
471          LOGICAL debugMode
472        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
473    
       LOGICAL balanceEmPmR  
       LOGICAL balanceQnet  
       LOGICAL balancePrintMean  
   
474  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
475  C     cg2dTargetResidual  C     cg2dTargetResidual
476  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
# Line 490  C     phiRef    :: reference potential ( Line 510  C     phiRef    :: reference potential (
510  C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:  C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:
511  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
512  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
513    C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
514    C                :: from r-coordinate vertical velocity to vertical velocity [m/s].
515    C                :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit
516    C     wUnit2rVel :: units conversion factor (Non-Hydrostatic code),
517    C                :: from vertical velocity [m/s] to r-coordinate vertical velocity.
518    C                :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel
519    C     mass2rUnit :: units conversion factor (surface forcing),
520    C                :: from mass per unit area [kg/m2] to vertical r-coordinate unit.
521    C                :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ;
522    C                :: p-coord: = gravity    ( [kg/m2] *  g = [Pa] ) ;
523    C     rUnit2mass :: units conversion factor (surface forcing),
524    C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
525    C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
526    C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
527  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
528  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
529  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
# Line 501  C                 ( Southern edge f for Line 535  C                 ( Southern edge f for
535  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
536  C     omega     :: Angular velocity ( rad/s )  C     omega     :: Angular velocity ( rad/s )
537  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
538    C     viscAr    :: Eddy viscosity coeff. for mixing of
539    C                 momentum vertically ( units of r^2/s )
540  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
541  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
542  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical  C     viscAhW   :: Eddy 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 viscAh if unset ( m^2/s )  C                 model, defaults to viscAh if unset ( m^2/s )
545  C                 Not used if variable horiz. viscosity is used.  C                 Not used if variable horiz. viscosity is used.
 C     viscAr    :: Eddy viscosity coeff. for mixing of  
 C                 momentum vertically ( units of r^2/s )  
546  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
547  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
548  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical
# Line 523  C     viscA4D   :: Biharmonic viscosity Line 557  C     viscA4D   :: Biharmonic viscosity
557  C                  (act on Divergence part) ( m^4/s )  C                  (act on Divergence part) ( m^4/s )
558  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
559  C                  (act on Vorticity  part) ( m^4/s )  C                  (act on Vorticity  part) ( m^4/s )
560  C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
561  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
562  C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor (harmonic)  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
563  C     viscC4smag  :: Smagorinsky non-dimensional viscosity factor (biharmonic)  C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
564  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  C     viscC2smag   :: Smagorinsky non-dimensional viscosity factor (harmonic)
565  C                   momentum laterally ( m^2/s )  C     viscC4smag   :: Smagorinsky non-dimensional viscosity factor (biharmonic)
566  C     viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity  C     viscAhMax    :: Maximum eddy viscosity coeff. for mixing of
567  C                   coeff. for mixing of momentum laterally (non-dim)  C                    momentum laterally ( m^2/s )
568    C     viscAhReMax  :: Maximum gridscale Reynolds number for eddy viscosity
569    C                     coeff. for mixing of momentum laterally (non-dim)
570    C     viscAhGrid   :: non-dimensional grid-size dependent viscosity
571  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
572  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
573  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max    :: Maximum biharmonic viscosity coeff. for mixing of
574  C                 momentum laterally ( m^4/s )  C                     momentum laterally ( m^4/s )
575  C     viscA4ReMax :: Maximum Gridscale Reynolds number for  C     viscA4ReMax  :: Maximum Gridscale Reynolds number for
576  C                  biharmonic viscosity coeff. momentum laterally (non-dim)  C                     biharmonic viscosity coeff. momentum laterally (non-dim)
577  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  
578  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
579  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))  
580  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
581  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
582  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
583  C                 for mixing of heat vertically ( units of r^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
584  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
585  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
586  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
587  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
588  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
589  C                 for mixing of salt vertically ( units of r^2/s ),  C                 for mixing of salt vertically ( units of r^2/s ),
590  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
591  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
592  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
593  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
594  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
595  C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979  C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
596    C     BL79LatVary    :: polarwise of this latitude diffKrBL79 is applied with
597    C                       gradual transition to diffKrBLEQ towards Equator
598    C     diffKrBLEQsurf :: same as diffKrBL79surf but at Equator
599    C     diffKrBLEQdeep :: same as diffKrBL79deep but at Equator
600    C     diffKrBLEQscl  :: same as diffKrBL79scl but at Equator
601    C     diffKrBLEQHo   :: same as diffKrBL79Ho but at Equator
602  C     deltaT    :: Default timestep ( s )  C     deltaT    :: Default timestep ( s )
603  C     deltaTClock  :: Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
604  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
# Line 605  C     mtFacMom      :: Metric terms trac Line 645  C     mtFacMom      :: Metric terms trac
645  C     cosPower      :: Power of cosine of latitude to multiply viscosity  C     cosPower      :: Power of cosine of latitude to multiply viscosity
646  C     cAdjFreq      :: Frequency of convective adjustment  C     cAdjFreq      :: Frequency of convective adjustment
647  C  C
648  C     taveFreq      :: Frequency with which time-averaged model state  C     taveFreq      :: Frequency with which time-averaged model state
649  C                      is written to post-processing files ( s ).  C                      is written to post-processing files ( s ).
650  C     tave_lastIter :: (for state variable only) fraction of the last time  C     tave_lastIter :: (for state variable only) fraction of the last time
651  C                      step (of each taveFreq period) put in the time average.  C                      step (of each taveFreq period) put in the time average.
652  C                      (fraction for 1rst iter = 1 - tave_lastIter)  C                      (fraction for 1rst iter = 1 - tave_lastIter)
653  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
654  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
# Line 620  C                          (note: extern Line 660  C                          (note: extern
660  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
661  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
662  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
663  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
664  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
665  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
666  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
667  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
668  C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.  C     hMixCrit    :: criteria for mixed-layer diagnostic
669  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
670  C                          ( g*rho if horiz in m and vertical in Pa ).  C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
671  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)
672  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
 C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)  
673  C                           (default=2: full drag ; =1: gives half-slip BC)  C                           (default=2: full drag ; =1: gives half-slip BC)
674  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
675  C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)  C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
# Line 640  C                           is to be rep Line 679  C                           is to be rep
679  C                           (affects myabs, mymin, mymax)  C                           (affects myabs, mymin, mymax)
680  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
681  C                      (i.e. allows convection at different Rayleigh numbers)  C                      (i.e. allows convection at different Rayleigh numbers)
682    C     phiEuler      :: Euler angle, rotation about original z-axis
683    C     thetaEuler    :: Euler angle, rotation about new x-axis
684    C     psiEuler      :: Euler angle, rotation about new z-axis
685        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
686       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
687       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
# Line 651  C                      (i.e. allows conv Line 693  C                      (i.e. allows conv
693       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
694       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
695       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
696       & viscA4, viscA4W,       & viscA4, viscA4W, viscA4Max,
697       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Grid, viscA4GridMax, viscA4GridMin,
698       & viscAhRemax, viscA4Remax,       & viscAhReMax, viscA4ReMax,
699       & viscC4leith, viscC4leithD, viscAr,       & viscC4leith, viscC4leithD, viscAr,
700       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
701       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
702       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
703         & BL79LatVary,
704         & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
705       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
706       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
707       & gravity, recip_Gravity, gBaro,       & gravity, recip_gravity, gBaro,
708       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
709       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
710       & rhoConstFresh, convertEmP2rUnit, tRef, sRef, phiRef, dBdrRef,       & rhoConstFresh, tRef, sRef, phiRef, dBdrRef,
711         & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
712       & baseTime, startTime, endTime,       & baseTime, startTime, endTime,
713       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
714       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
715       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
716       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
717       & tauThetaClimRelax, tauSaltClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
      & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,  
718       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
719       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
720       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
721       & horiVertRatio, recip_horiVertRatio,       & ivdc_kappa, hMixCriteria, Ro_SeaLevel,
      & ivdc_kappa, Ro_SeaLevel,  
722       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
723       & smoothAbsFuncRange,       & smoothAbsFuncRange,
724       & tCylIn, tCylOut       & tCylIn, tCylOut,
725         & phiEuler, thetaEuler, psiEuler
726    
727        _RL cg2dTargetResidual        _RL cg2dTargetResidual
728        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
# Line 709  C                      (i.e. allows conv Line 753  C                      (i.e. allows conv
753        _RL hFacInf        _RL hFacInf
754        _RL hFacSup        _RL hFacSup
755        _RL beta        _RL beta
756          _RL viscAr
757        _RL viscAh        _RL viscAh
758        _RL viscAhW        _RL viscAhW
759        _RL viscAhD        _RL viscAhD
760        _RL viscAhZ        _RL viscAhZ
761        _RL viscAhMax        _RL viscAhMax
762        _RL viscAhReMax        _RL viscAhReMax
763        _RL viscAhGrid        _RL viscAhGrid, viscAhGridMax, viscAhGridMin
       _RL viscAhGridMax  
       _RL viscAhGridMin  
764        _RL viscC2leith        _RL viscC2leith
765        _RL viscC2leithD        _RL viscC2leithD
766        _RL viscC2smag        _RL viscC2smag
       _RL viscC4smag  
       _RL viscAr  
767        _RL viscA4        _RL viscA4
768        _RL viscA4W        _RL viscA4W
769        _RL viscA4D        _RL viscA4D
# Line 732  C                      (i.e. allows conv Line 773  C                      (i.e. allows conv
773        _RL viscA4Grid, viscA4GridMax, viscA4GridMin        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
774        _RL viscC4leith        _RL viscC4leith
775        _RL viscC4leithD        _RL viscC4leithD
776          _RL viscC4smag
777        _RL diffKhT        _RL diffKhT
778        _RL diffKrNrT(Nr)        _RL diffKrNrT(Nr)
779        _RL diffK4T        _RL diffK4T
# Line 742  C                      (i.e. allows conv Line 784  C                      (i.e. allows conv
784        _RL diffKrBL79deep        _RL diffKrBL79deep
785        _RL diffKrBL79scl        _RL diffKrBL79scl
786        _RL diffKrBL79Ho        _RL diffKrBL79Ho
787          _RL BL79LatVary
788          _RL diffKrBLEQsurf
789          _RL diffKrBLEQdeep
790          _RL diffKrBLEQscl
791          _RL diffKrBLEQHo
792        _RL delt        _RL delt
793        _RL tauCD        _RL tauCD
794        _RL rCD        _RL rCD
# Line 753  C                      (i.e. allows conv Line 800  C                      (i.e. allows conv
800        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
801        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
802        _RL rhoConstFresh        _RL rhoConstFresh
       _RL convertEmP2rUnit  
803        _RL tRef(Nr)        _RL tRef(Nr)
804        _RL sRef(Nr)        _RL sRef(Nr)
805        _RL phiRef(2*Nr+1)        _RL phiRef(2*Nr+1)
806        _RL dBdrRef(Nr)        _RL dBdrRef(Nr)
807          _RL rVel2wUnit(Nr+1), wUnit2rVel(Nr+1)
808          _RL mass2rUnit, rUnit2mass
809        _RL baseTime        _RL baseTime
810        _RL startTime        _RL startTime
811        _RL endTime        _RL endTime
# Line 782  C                      (i.e. allows conv Line 830  C                      (i.e. allows conv
830        _RL rotationPeriod        _RL rotationPeriod
831        _RL tauThetaClimRelax        _RL tauThetaClimRelax
832        _RL tauSaltClimRelax        _RL tauSaltClimRelax
       _RL tauTr1ClimRelax  
       _RL lambdaTr1ClimRelax  
833        _RL latBandClimRelax        _RL latBandClimRelax
834        _RL externForcingCycle        _RL externForcingCycle
835        _RL externForcingPeriod        _RL externForcingPeriod
836        _RL convertFW2Salt        _RL convertFW2Salt
837        _RL temp_EvPrRn        _RL temp_EvPrRn
838        _RL salt_EvPrRn        _RL salt_EvPrRn
       _RL horiVertRatio  
       _RL recip_horiVertRatio  
839        _RL ivdc_kappa        _RL ivdc_kappa
840          _RL hMixCriteria
841        _RL Ro_SeaLevel        _RL Ro_SeaLevel
842        _RL sideDragFactor        _RL sideDragFactor
843        _RL bottomDragLinear        _RL bottomDragLinear
# Line 801  C                      (i.e. allows conv Line 846  C                      (i.e. allows conv
846        _RL nh_Am2        _RL nh_Am2
847        _RL tCylIn        _RL tCylIn
848        _RL tCylOut        _RL tCylOut
849          _RL phiEuler, thetaEuler, psiEuler
850    
851  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
852        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
# Line 816  C     atm_kappa :: kappa = R/Cp (R: cons Line 862  C     atm_kappa :: kappa = R/Cp (R: cons
862  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
863  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])
864  C     integr_GeoPot :: option to select the way we integrate the geopotential  C     integr_GeoPot :: option to select the way we integrate the geopotential
865  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
866  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
867  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
868        COMMON /PARM_ATM/        COMMON /PARM_ATM/
# Line 833  C Logical flags for selecting packages Line 879  C Logical flags for selecting packages
879        LOGICAL useMY82        LOGICAL useMY82
880        LOGICAL useGGL90        LOGICAL useGGL90
881        LOGICAL useKPP        LOGICAL useKPP
882          LOGICAL useGAD
883        LOGICAL useGMRedi        LOGICAL useGMRedi
884        LOGICAL useOBCS        LOGICAL useOBCS
885        LOGICAL useAIM        LOGICAL useAIM
# Line 864  C Logical flags for selecting packages Line 911  C Logical flags for selecting packages
911        LOGICAL useRunClock        LOGICAL useRunClock
912        LOGICAL useEMBED_FILES        LOGICAL useEMBED_FILES
913        LOGICAL useMYPACKAGE        LOGICAL useMYPACKAGE
914          LOGICAL useSALT_PLUME
915        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
916       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
917       &        useGMRedi, useOBCS, useAIM, useLand,       &        useGAD, useGMRedi, useOBCS, useAIM, useLand,
918       &        useCAL, useEXF, useEBM, useGrdchk, useECCO,       &        useCAL, useEXF, useEBM, useGrdchk, useECCO,
919       &        useSHAP_FILT, useZONAL_FILT, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useFLT,
920       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
921       &        useSBO, useSEAICE, useShelfIce,       &        useSBO, useSEAICE, useShelfIce,
922       &        useThSIce, useATM2D, useBulkForce,       &        useThSIce, useATM2D, useBulkForce,
923       &        usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID,       &        usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID,
924       &        useRunClock, useEMBED_FILES, useMYPACKAGE       &        useRunClock, useEMBED_FILES, useMYPACKAGE, useSALT_PLUME
925    
926  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
927  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***

Legend:
Removed from v.1.193  
changed lines
  Added in v.1.216

  ViewVC Help
Powered by ViewVC 1.1.22