/[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.210 by dimitri, Thu Dec 20 00:43:45 2007 UTC revision 1.235 by dimitri, Wed Jan 20 23:33:45 2010 UTC
# Line 24  C     Useful physical values Line 24  C     Useful physical values
24        Real*8 deg2rad        Real*8 deg2rad
25        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
26    
 C     Symbolic values  
 C     precXXXX :: Used to indicate what precision to use for  
 C                dumping model state.  
       INTEGER precFloat32  
       PARAMETER ( precFloat32 = 32 )  
       INTEGER precFloat64  
       PARAMETER ( precFloat64 = 64 )  
 C     UNSET_xxx :: Used to indicate variables that have not been given a value  
       Real*8 UNSET_FLOAT8  
       PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )  
       Real*4 UNSET_FLOAT4  
       PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )  
       _RL    UNSET_RL  
       PARAMETER ( UNSET_RL     = 1.234567D5 )  
       _RS    UNSET_RS  
       PARAMETER ( UNSET_RS     = 1.234567E5 )  
       INTEGER UNSET_I  
       PARAMETER ( UNSET_I      = 123456789  )  
   
27  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
28  C     buoyancyRelation :: Flag used to indicate which relation to use to  C     buoyancyRelation :: Flag used to indicate which relation to use to
29  C                         get buoyancy.  C                         get buoyancy.
# Line 65  C     bathyFile       :: File containing Line 46  C     bathyFile       :: File containing
46  C                        is taken from inline function.  C                        is taken from inline function.
47  C     topoFile        :: File containing the topography of the surface (unit=m)  C     topoFile        :: File containing the topography of the surface (unit=m)
48  C                        (mainly used for the atmosphere = ground height).  C                        (mainly used for the atmosphere = ground height).
 C     shelfIceFile    :: File containing the topography of the shelfice draught  
 C                        (unit=m)  
49  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
50  C                        for potential temperature.  C                        for potential temperature.
51  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
# Line 89  C                 m/s when using externa Line 68  C                 m/s when using externa
68  C                 to kg/m2/s by multiplying by rhoConstFresh.  C                 to kg/m2/s by multiplying by rhoConstFresh.
69  C     saltFluxFile    :: File containing surface salt flux  C     saltFluxFile    :: File containing surface salt flux
70  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
71  C     eddyTauxFile    :: File containing zonal Eddy stress data  C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data
72  C     eddyTauyFile    :: File containing meridional Eddy stress data  C     eddyPsiYFile    :: File containing meridional Eddy streamfunction data
73  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
74        COMMON /PARM_C/        COMMON /PARM_C/
75       &                buoyancyRelation, eosType,       &                buoyancyRelation, eosType,
# Line 98  C     the_run_name    :: string identify Line 77  C     the_run_name    :: string identify
77       &                tRefFile, sRefFile, rhoRefFile,       &                tRefFile, sRefFile, rhoRefFile,
78       &                delRFile, delRcFile,       &                delRFile, delRcFile,
79       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
80       &                bathyFile, topoFile, shelfIceFile,       &                bathyFile, topoFile,
81       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
82       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
83       &                saltClimFile,       &                saltClimFile,
# Line 107  C     the_run_name    :: string identify Line 86  C     the_run_name    :: string identify
86       &                lambdaThetaFile, lambdaSaltFile,       &                lambdaThetaFile, lambdaSaltFile,
87       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
88       &                dQdTfile, ploadFile,       &                dQdTfile, ploadFile,
89       &                eddyTauxFile, eddyTauyFile,       &                eddyPsiXFile, eddyPsiYFile,
90       &                the_run_name       &                the_run_name
91        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
92        CHARACTER*(6)  eosType        CHARACTER*(6)  eosType
# Line 121  C     the_run_name    :: string identify Line 100  C     the_run_name    :: string identify
100        CHARACTER*(MAX_LEN_FNAM) delXFile        CHARACTER*(MAX_LEN_FNAM) delXFile
101        CHARACTER*(MAX_LEN_FNAM) delYFile        CHARACTER*(MAX_LEN_FNAM) delYFile
102        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
103        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
104        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
105        CHARACTER*(MAX_LEN_FNAM) diffKrFile        CHARACTER*(MAX_LEN_FNAM) diffKrFile
106        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
# Line 138  C     the_run_name    :: string identify Line 117  C     the_run_name    :: string identify
117        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
118        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
119        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) ploadFile
120        CHARACTER*(MAX_LEN_FNAM) eddyTauxFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile
121        CHARACTER*(MAX_LEN_FNAM) eddyTauyFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile
122        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
123        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
124        CHARACTER*(MAX_LEN_PREC/2) the_run_name        CHARACTER*(MAX_LEN_PREC/2) the_run_name
# Line 164  C     nonlinFreeSurf      :: option rela Line 143  C     nonlinFreeSurf      :: option rela
143  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
144  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
145  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
146    C     selectNHfreeSurf    :: option for Non-Hydrostatic (free-)Surface formulation:
147    C                           =0 (default) hydrostatic surf. ; > 0 add NH effects.
148    C     selectAddFluid      :: option to add mass source/sink of fluid in the interior
149    C                            (3-D generalisation of oceanic real-fresh water flux)
150    C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
151  C     momForcingOutAB     :: =1: take momentum forcing contribution  C     momForcingOutAB     :: =1: take momentum forcing contribution
152  C                           out of (=0: in) Adams-Bashforth time stepping.  C                           out of (=0: in) Adams-Bashforth time stepping.
153  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
# Line 173  C     tempVertAdvScheme   :: Temp. Vert. Line 157  C     tempVertAdvScheme   :: Temp. Vert.
157  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
158  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
159  C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)  C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)
160    C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)
161    C     monitorSelect       :: select group of variables to monitor
162    C                            =1 : dynvars ; =2 : + vort ; =3 : + surface
163  C     debugLevel          :: debug level selector: higher -> more writing  C     debugLevel          :: debug level selector: higher -> more writing
164    
165        COMMON /PARM_I/        COMMON /PARM_I/
# Line 184  C     debugLevel          :: debug level Line 171  C     debugLevel          :: debug level
171       &        writeStatePrec,       &        writeStatePrec,
172       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
173       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
174         &        selectNHfreeSurf,
175         &        selectAddFluid,
176       &        momForcingOutAB, tracForcingOutAB,       &        momForcingOutAB, tracForcingOutAB,
177       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
178       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
179       &        selectKEscheme,       &        selectKEscheme, selectVortScheme,
180       &        debugLevel       &        monitorSelect, debugLevel
181        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
182        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
183        INTEGER cg2dPreCondFreq        INTEGER cg2dPreCondFreq
# Line 202  C     debugLevel          :: debug level Line 191  C     debugLevel          :: debug level
191        INTEGER readBinaryPrec        INTEGER readBinaryPrec
192        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
193        INTEGER select_rStar        INTEGER select_rStar
194          INTEGER selectNHfreeSurf
195          INTEGER selectAddFluid
196        INTEGER momForcingOutAB, tracForcingOutAB        INTEGER momForcingOutAB, tracForcingOutAB
197        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
198        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
199        INTEGER selectKEscheme        INTEGER selectKEscheme
200          INTEGER selectVortScheme
201          INTEGER monitorSelect
202        INTEGER debugLevel        INTEGER debugLevel
203    
 C  
       INTEGER debLevZero  
       PARAMETER(debLevZero=0)  
       INTEGER debLevA  
       PARAMETER(debLevA=1)  
       INTEGER debLevB  
       PARAMETER(debLevB=2)  
   
204  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
205    C- Coordinate + Grid params:
206    C     fluidIsAir       :: Set to indicate that the fluid major constituent
207    C                        is air
208    C     fluidIsWater     :: Set to indicate that the fluid major constituent
209    C                        is water
210    C     usingPCoords     :: Set to indicate that we are working in a pressure
211    C                        type coordinate (p or p*).
212    C     usingZCoords     :: Set to indicate that we are working in a height
213    C                        type coordinate (z or z*)
214    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
215    C                         this requires specific code for restart & exchange
216  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
217  C                          coordinate frame.  C                          coordinate frame.
218  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
219  C                               spherical polar frame.  C                               spherical polar frame.
220  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     rotateGrid      :: rotate grid coordinates to geographical coordinates
221    C                        according to Euler angles phiEuler, thetaEuler, psiEuler
222  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
223    C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
224  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
225  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
226    C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
227    C- Momentum params:
228    C     no_slip_sides  :: Impose "no-slip" at lateral boundaries.
229  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
230    C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
231    C                       on irregular grids)
232    C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
233    C     useAreaViscLength :: Set to true to use old scaling for viscous lengths,
234    C                          e.g., L2=Raz.  May be preferable for cube sphere.
235  C     momViscosity  :: Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
236  C     momAdvection  :: Flag which turns advection of momentum on and off.  C     momAdvection  :: Flag which turns advection of momentum on and off.
237  C     momForcing    :: Flag which turns external forcing of momentum on  C     momForcing    :: Flag which turns external forcing of momentum on
238  C                     and off.  C                      and off.
239  C     momPressureForcing :: Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
240  C                          on and off.  C                          on and off.
241  C     metricTerms   :: Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
242  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
243  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
244  C     tempAdvection :: Flag which turns advection of temperature on  C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
245  C                     and off.  C     useConstantF  :: Coriolis parameter set to f0
246  C     tempForcing   :: Flag which turns external forcing of temperature on  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
247  C                     and off.  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
248  C     saltAdvection :: Flag which turns advection of salinity on  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
249  C                     and off.  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
250  C     saltForcing   :: Flag which turns external forcing of salinity on  C                                (default = F = use mom_fluxform package)
251  C                     and off.  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986)
252    C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
253    C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
254    C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
255    C     useAbsVorticity :: work with f+zeta in Coriolis terms
256    C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
257    C     momStepping    :: Turns momentum equation time-stepping off
258    C- Temp. & Salt params:
259    C     tempStepping   :: Turns temperature equation time-stepping off
260    C     saltStepping   :: Turns salinity equation time-stepping off
261    C     tempAdvection  :: Flag which turns advection of temperature on and off.
262    C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
263    C     tempForcing    :: Flag which turns external forcing of temperature on
264    C                       and off.
265    C     saltAdvection  :: Flag which turns advection of salinity on and off.
266    C     saltIsActiveTr :: Salinity  is a dynamically active tracer
267    C     saltForcing    :: Flag which turns external forcing of salinity on
268    C                       and off.
269    C     maskIniTemp    :: apply mask to initial Pot.Temp.
270    C     maskIniSalt    :: apply mask to initial salinity
271    C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
272    C     checkIniSalt   :: check for points with identically zero initial salinity
273  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
274  C                         as a real Fresh Water (=> changes the Sea Level)  C                         as a real Fresh Water (=> changes the Sea Level)
275  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)
276  C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable  C- Pressure solver related parameters (PARM02)
277  C                       on irregular grids)  C     useSRCGSolver  :: Set to true to use conjugate gradient
278  C     useAreaViscLength :: Set to true to use old scaling for viscous  C                       solver with single reduction (only one call of
279  C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.  C                       s/r mpi_allreduce), default is false
280  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms  C- Time-stepping params:
281  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
282  C     implicitFreeSurface :: Set to true to use implicit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
283  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
284  C     linFSConserveTr     :: Set to true to correct source/sink of tracer  C     linFSConserveTr     :: Set to true to correct source/sink of tracer
285  C                            at the surface due to Linear Free Surface  C                            at the surface due to Linear Free Surface
286  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
287  C                           linear relation Phi_surf = Bo_surf*eta  C                            linear relation Phi_surf = Bo_surf*eta
288  C     use3Dsolver   :: set to true to use 3-D pressure solver  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
289    C     nonHydrostatic   :: Using non-hydrostatic algorithm
290    C     use3Dsolver      :: set to true to use 3-D pressure solver
291  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
292  C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V  C     staggerTimeStep   :: enable a Stagger time stepping U,V (& W) then T,S
 C     momStepping   :: Turns momentum equation time-stepping off  
 C     tempStepping  :: Turns temperature equation time-stepping off  
 C     saltStepping  :: Turns salinity equation time-stepping off  
 C     useConstantF  :: Coriolis parameter set to f0  
 C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  
 C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  
 C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off  
 C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  
 C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  
 C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term  
 C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny  
 C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term  
 C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)  
 C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)  
 C     useAbsVorticity :: work with f+zeta in Coriolis terms  
293  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
294  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
295  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
# Line 287  C     momDissip_In_AB   :: if False, put Line 301  C     momDissip_In_AB   :: if False, put
301  C                          out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
302  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
303  C                          apply AB on tracer tendencies (rather than on Tracer)  C                          apply AB on tracer tendencies (rather than on Tracer)
304  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match  C- Other forcing params -
305  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     balanceEmPmR    :: substract global mean of EmPmR at every time step
306  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from  C     balanceQnet     :: substract global mean of Qnet at every time step
307  C                           before checkpoint-54a, Jul 06, 2004.  C     balancePrintMean:: print substracted global means to STDOUT
308  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
309  C                        climatology is required.  C                        climatology is required.
310  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
311  C                        climatology is required.  C                        climatology is required.
312    C     allowFreezing  :: Allows surface water to freeze and form ice
313    C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
314  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
315  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  
316  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
317  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
318  C                       slow (f77) or does not work (f90).  When  C                       slow (f77) or does not work (f90).  When
319  C                       useSingleCpuIO is set, mdsio_writefield.F  C                       useSingleCpuIO is set, mdsio_writefield.F
320  C                       outputs from master mpi process only.  C                       outputs from master mpi process only.
321  C     allowFreezing  :: Allows surface water to freeze and form ice  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
322  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
323    C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
324    C                           before checkpoint-54a, Jul 06, 2004.
325  C     pickup_write_mdsio :: use mdsio to write pickups  C     pickup_write_mdsio :: use mdsio to write pickups
326  C     pickup_read_mdsio  :: use mdsio to read  pickups  C     pickup_read_mdsio  :: use mdsio to read  pickups
327  C     pickup_write_immed :: echo the pickup immediately (for conversion)  C     pickup_write_immed :: echo the pickup immediately (for conversion)
328    C     writePickupAtEnd   :: write pickup at the last timestep
329  C     timeave_mdsio      :: use mdsio for timeave output  C     timeave_mdsio      :: use mdsio for timeave output
330  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
331  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
332  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
333  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  
334    
335        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/
336         & fluidIsAir, fluidIsWater,
337         & usingPCoords, usingZCoords, useDynP_inEos_Zc,
338         & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
339       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
340       & deepAtmosphere, setInterFDr, setCenterDr,       & deepAtmosphere, setInterFDr, setCenterDr,
341       & no_slip_sides,no_slip_bottom,       & no_slip_sides, no_slip_bottom,
342       & momViscosity, momAdvection, momForcing, useCoriolis,       & useFullLeith, useStrainTensionVisc, useAreaViscLength,
343       & momPressureForcing, vectorInvariantMomentum,       & momViscosity, momAdvection, momForcing,
344       & tempAdvection, tempForcing,       & momPressureForcing, metricTerms, useNHMTerms,
345       & saltAdvection, saltForcing,       & useCoriolis, use3dCoriolis,
346         & useConstantF, useBetaPlaneF, useSphereF,
347         & useCDscheme, vectorInvariantMomentum,
348         & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
349         & upwindVorticity, highOrderVorticity,
350         & useAbsVorticity, upwindShear,
351         & momStepping, tempStepping, saltStepping,
352         & tempAdvection, tempIsActiveTr, tempForcing,
353         & saltAdvection, saltIsActiveTr, saltForcing,
354         & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
355       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
      & useFullLeith, useStrainTensionVisc,  
      & useAreaViscLength,  
356       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
357       & uniformLin_PhiSurf,       & uniformLin_PhiSurf,
358         & quasiHydrostatic, nonHydrostatic,
359       & use3Dsolver, implicitIntGravWave, staggerTimeStep,       & use3Dsolver, implicitIntGravWave, staggerTimeStep,
      & momStepping, tempStepping, saltStepping,  
      & metricTerms, useNHMTerms,  
      & useConstantF, useBetaPlaneF, useSphereF, use3dCoriolis,  
      & useCDscheme,  
      & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,  
      & SadournyCoriolis, upwindVorticity, highOrderVorticity,  
      & useAbsVorticity, upwindShear,  
360       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
361       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
362       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
363       & momDissip_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
364       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & balanceEmPmR, balanceQnet, balancePrintMean,
365       & periodicExternalForcing,       & doThetaClimRelax, doSaltClimRelax,
      & fluidIsAir, fluidIsWater,  
      & usingPCoords, usingZCoords, useDynP_inEos_Zc,  
      & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,  
366       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
367         & periodicExternalForcing,
368         & globalFiles, useSingleCpuIO,
369       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
370       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
371         & writePickupAtEnd,
372       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
373       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast, debugMode,
374       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & inAdMode, inAdTrue, inAdFalse, inAdExact,
375       & balanceEmPmR, balanceQnet, balancePrintMean       & useSRCGSolver
376    
377          LOGICAL fluidIsAir
378          LOGICAL fluidIsWater
379          LOGICAL usingPCoords
380          LOGICAL usingZCoords
381          LOGICAL useDynP_inEos_Zc
382        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
383        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid, rotateGrid
384        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
385        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
386        LOGICAL deepAtmosphere        LOGICAL deepAtmosphere
# Line 384  C     balancePrintMean:: print substract Line 396  C     balancePrintMean:: print substract
396        LOGICAL useCoriolis        LOGICAL useCoriolis
397        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
398        LOGICAL tempAdvection        LOGICAL tempAdvection
399          LOGICAL tempIsActiveTr
400        LOGICAL tempForcing        LOGICAL tempForcing
401        LOGICAL saltAdvection        LOGICAL saltAdvection
402          LOGICAL saltIsActiveTr
403        LOGICAL saltForcing        LOGICAL saltForcing
404          LOGICAL maskIniTemp
405          LOGICAL maskIniSalt
406          LOGICAL checkIniTemp
407          LOGICAL checkIniSalt
408        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
409        LOGICAL useFullLeith        LOGICAL useFullLeith
410        LOGICAL useStrainTensionVisc        LOGICAL useStrainTensionVisc
# Line 396  C     balancePrintMean:: print substract Line 414  C     balancePrintMean:: print substract
414        LOGICAL exactConserv        LOGICAL exactConserv
415        LOGICAL linFSConserveTr        LOGICAL linFSConserveTr
416        LOGICAL uniformLin_PhiSurf        LOGICAL uniformLin_PhiSurf
417          LOGICAL quasiHydrostatic
418          LOGICAL nonHydrostatic
419        LOGICAL use3Dsolver        LOGICAL use3Dsolver
420        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
421        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
# Line 411  C     balancePrintMean:: print substract Line 431  C     balancePrintMean:: print substract
431        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
432        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
433        LOGICAL useJamartMomAdv        LOGICAL useJamartMomAdv
       LOGICAL SadournyCoriolis  
434        LOGICAL upwindVorticity        LOGICAL upwindVorticity
435        LOGICAL highOrderVorticity        LOGICAL highOrderVorticity
436        LOGICAL useAbsVorticity        LOGICAL useAbsVorticity
# Line 425  C     balancePrintMean:: print substract Line 444  C     balancePrintMean:: print substract
444        LOGICAL useMultiDimAdvec        LOGICAL useMultiDimAdvec
445        LOGICAL momDissip_In_AB        LOGICAL momDissip_In_AB
446        LOGICAL doAB_onGtGs        LOGICAL doAB_onGtGs
447          LOGICAL balanceEmPmR
448          LOGICAL balanceQnet
449          LOGICAL balancePrintMean
450        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
451        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
452        LOGICAL doTr1ClimRelax        LOGICAL allowFreezing
453          LOGICAL useOldFreezing
454        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
       LOGICAL fluidIsAir  
       LOGICAL fluidIsWater  
       LOGICAL usingPCoords  
       LOGICAL usingZCoords  
       LOGICAL useDynP_inEos_Zc  
       LOGICAL nonHydrostatic  
       LOGICAL quasiHydrostatic  
455        LOGICAL globalFiles        LOGICAL globalFiles
456        LOGICAL useSingleCpuIO        LOGICAL useSingleCpuIO
       LOGICAL allowFreezing  
       LOGICAL useOldFreezing  
457        LOGICAL pickupStrictlyMatch        LOGICAL pickupStrictlyMatch
458        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
459        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
       LOGICAL dumpInitAndLast  
       LOGICAL debugMode  
460        LOGICAL pickup_read_mdsio, pickup_write_mdsio        LOGICAL pickup_read_mdsio, pickup_write_mdsio
461        LOGICAL pickup_write_immed        LOGICAL pickup_write_immed, writePickupAtEnd
462        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
463        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
464          LOGICAL dumpInitAndLast
465          LOGICAL debugMode
466        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
467          LOGICAL useSRCGSolver
       LOGICAL balanceEmPmR  
       LOGICAL balanceQnet  
       LOGICAL balancePrintMean  
468    
469  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
470  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 488  C     rhoConst  :: Vertically constant r Line 499  C     rhoConst  :: Vertically constant r
499  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
500  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
501  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
502    C     rho1Ref   :: reference vertical profile for density
503  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
504  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
505  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
# Line 508  C     rUnit2mass :: units conversion fac Line 520  C     rUnit2mass :: units conversion fac
520  C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].  C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
521  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
522  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
523  C     phiMin    :: Latitude of southern most cell face.  C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
524  C     thetaMin  :: Longitude of western most cell face (this  C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
525  C                 is an "inert" parameter but it is included  C                :: parameter but it makes geographical references simple.)
526  C                 to make geographical references simple.)  C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
527  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).  C                :: most face (Lat-Lon grid).
528    C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
529  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
530  C     f0        :: Reference coriolis parameter ( 1/s )  C     f0         :: Reference coriolis parameter ( 1/s )
531  C                 ( Southern edge f for beta plane )  C                   ( Southern edge f for beta plane )
532  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta       :: df/dy ( s^-1.m^-1 )
533  C     omega     :: Angular velocity ( rad/s )  C     omega      :: Angular velocity ( rad/s )
534  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
535  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
536  C                 momentum laterally ( m^2/s )  C                   for vertical mixing of momentum ( units of r^2/s )
537  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical  C     viscAh     :: Eddy viscosity coeff. for mixing of
 C                 momentum laterally, no effect for hydrostatic  
 C                 model, defaults to viscAh if unset ( m^2/s )  
 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 )  
 C     viscA4    :: Biharmonic viscosity coeff. for mixing of  
 C                 momentum laterally ( m^4/s )  
 C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical  
 C                 momentum laterally, no effect for hydrostatic  
 C                 model, defaults to viscA4 if unset ( m^2/s )  
 C                 Not used if variable horiz. viscosity is used.  
 C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally  
 C                  (act on Divergence part) ( m^2/s )  
 C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally  
 C                  (act on Vorticity  part) ( m^2/s )  
 C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally  
 C                  (act on Divergence part) ( m^4/s )  
 C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  
 C                  (act on Vorticity  part) ( m^4/s )  
 C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))  
 C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))  
 C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor (harmonic)  
 C     viscC4smag  :: Smagorinsky non-dimensional viscosity factor (biharmonic)  
 C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  
538  C                   momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
539  C     viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
540  C                   coeff. for mixing of momentum laterally (non-dim)  C                   momentum laterally, no effect for hydrostatic
541    C                   model, defaults to viscAh if unset ( m^2/s )
542    C                   Not used if variable horiz. viscosity is used.
543    C     viscA4     :: Biharmonic viscosity coeff. for mixing of
544    C                   momentum laterally ( m^4/s )
545    C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
546    C                   momentum laterally, no effect for hydrostatic
547    C                   model, defaults to viscA4 if unset ( m^2/s )
548    C                   Not used if variable horiz. viscosity is used.
549    C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
550    C                   (act on Divergence part) ( m^2/s )
551    C     viscAhZ    :: Eddy viscosity coeff. for mixing of momentum laterally
552    C                   (act on Vorticity  part) ( m^2/s )
553    C     viscA4D    :: Biharmonic viscosity coeff. for mixing of momentum laterally
554    C                   (act on Divergence part) ( m^4/s )
555    C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
556    C                   (act on Vorticity  part) ( m^4/s )
557    C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
558    C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
559    C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
560    C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
561    C     viscC2smag   :: Smagorinsky non-dimensional viscosity factor (harmonic)
562    C     viscC4smag   :: Smagorinsky non-dimensional viscosity factor (biharmonic)
563    C     viscAhMax    :: Maximum eddy viscosity coeff. for mixing of
564    C                    momentum laterally ( m^2/s )
565    C     viscAhReMax  :: Maximum gridscale Reynolds number for eddy viscosity
566    C                     coeff. for mixing of momentum laterally (non-dim)
567    C     viscAhGrid   :: non-dimensional grid-size dependent viscosity
568  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
569  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
570  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max    :: Maximum biharmonic viscosity coeff. for mixing of
571  C                 momentum laterally ( m^4/s )  C                     momentum laterally ( m^4/s )
572  C     viscA4ReMax :: Maximum Gridscale Reynolds number for  C     viscA4ReMax  :: Maximum Gridscale Reynolds number for
573  C                  biharmonic viscosity coeff. momentum laterally (non-dim)  C                     biharmonic viscosity coeff. momentum laterally (non-dim)
574  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  
575  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
576  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))  
577  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
578  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
579  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
580  C                 for mixing of heat vertically ( units of r^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
581  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
582  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
583  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
584  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
585  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
586  C                 for mixing of salt vertically ( units of r^2/s ),  C                 for mixing of salt vertically ( units of r^2/s ),
587  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
588  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
589  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
# Line 603  C     implicSurfPress :: parameter of th Line 616  C     implicSurfPress :: parameter of th
616  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
617  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
618  C                     Implicit part of barotropic flow Divergence ( 0-1 )  C                     Implicit part of barotropic flow Divergence ( 0-1 )
619    C     implicitNHPress :: parameter of the Crank-Nickelson time stepping :
620    C                     Implicit part of Non-Hydrostatic Pressure Gradient ( 0-1 )
621  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
622  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    :: Minimum dimensional size of a cell (affects hFacC etc..., m)
623  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    :: Minimum dimensional size of a cell (affects hFacC etc..., Pa)
624  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)  C     hFacMinDr    :: Minimum dimensional size of a cell (-> hFacC etc..., r units)
625  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
626  C     hFacSup        that control vanishing and creating levels  C     hFacSup          that control vanishing and creating levels
627  C     tauCD        :: CD scheme coupling timescale ( 1/s )  C     tauCD         :: CD scheme coupling timescale ( s )
628  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )  C     rCD           :: CD scheme normalised coupling parameter (= 1 - deltaT/tauCD)
629    C     epsAB_CD      :: Adams-Bashforth-2 stabilizing weight used in CD scheme
630  C     baseTime      :: model base time (time origin) = time @ iteration zero  C     baseTime      :: model base time (time origin) = time @ iteration zero
631  C     startTime     :: Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
632  C     endTime       :: Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
# Line 629  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 644  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     hMixCrit    :: criteria for mixed-layer diagnostic  C     hMixCriteria:: criteria for mixed-layer diagnostic
669    C     dRhoSmall   :: parameter for mixed-layer diagnostic
670    C     hMixSmooth  :: Smoothing parameter for mixed-layer diag (default=0=no smoothing)
671  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
672  C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as  C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
673  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
674  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
675  C                           (default=2: full drag ; =1: gives half-slip BC)  C                           (default=2: full drag ; =1: gives half-slip BC)
676  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
677  C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)  C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
# Line 663  C                           is to be rep Line 681  C                           is to be rep
681  C                           (affects myabs, mymin, mymax)  C                           (affects myabs, mymin, mymax)
682  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
683  C                      (i.e. allows convection at different Rayleigh numbers)  C                      (i.e. allows convection at different Rayleigh numbers)
684    C     phiEuler      :: Euler angle, rotation about original z-axis
685    C     thetaEuler    :: Euler angle, rotation about new x-axis
686    C     psiEuler      :: Euler angle, rotation about new z-axis
687        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
688       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
689       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
690       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
691       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
692       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & xgOrigin, ygOrigin, rSphere, recip_RSphere, f0, beta,
693       & viscAh, viscAhW, viscAhMax,       & viscAh, viscAhW, viscAhMax,
694       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
695       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
696       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
697       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
698       & viscA4, viscA4W,       & viscA4, viscA4W, viscA4Max,
699       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Grid, viscA4GridMax, viscA4GridMin,
700       & viscAhRemax, viscA4Remax,       & viscAhReMax, viscA4ReMax,
701       & viscC4leith, viscC4leithD, viscAr,       & viscC4leith, viscC4leithD, viscArNr,
702       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
703       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
704       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
705       & BL79LatVary,       & BL79LatVary,
706       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
707       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & tauCD, rCD, epsAB_CD,
708         & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
709       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
710       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
711       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
712       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
713       & rhoConstFresh, tRef, sRef, phiRef, dBdrRef,       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
714       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
715       & baseTime, startTime, endTime,       & baseTime, startTime, endTime,
716       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
717       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
718       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
719       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
720       & tauThetaClimRelax, tauSaltClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
      & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,  
721       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
722       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
723       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
724       & ivdc_kappa, hMixCriteria, Ro_SeaLevel,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, Ro_SeaLevel,
725       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
726       & smoothAbsFuncRange,       & smoothAbsFuncRange,
727       & tCylIn, tCylOut       & tCylIn, tCylOut,
728         & phiEuler, thetaEuler, psiEuler
729    
730        _RL cg2dTargetResidual        _RL cg2dTargetResidual
731        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
# Line 719  C                      (i.e. allows conv Line 741  C                      (i.e. allows conv
741        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
742        _RL deltaTfreesurf        _RL deltaTfreesurf
743        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
744        _RL phiMin        _RL xgOrigin
745        _RL thetaMin        _RL ygOrigin
746        _RL rSphere        _RL rSphere
747        _RL recip_rSphere        _RL recip_rSphere
748        _RL f0        _RL f0
749        _RL freeSurfFac        _RL freeSurfFac
750        _RL implicSurfPress        _RL implicSurfPress
751        _RL implicDiv2Dflow        _RL implicDiv2Dflow
752          _RL implicitNHPress
753        _RL hFacMin        _RL hFacMin
754        _RL hFacMinDz        _RL hFacMinDz
755        _RL hFacMinDp        _RL hFacMinDp
# Line 734  C                      (i.e. allows conv Line 757  C                      (i.e. allows conv
757        _RL hFacInf        _RL hFacInf
758        _RL hFacSup        _RL hFacSup
759        _RL beta        _RL beta
760          _RL viscArNr(Nr)
761        _RL viscAh        _RL viscAh
762        _RL viscAhW        _RL viscAhW
763        _RL viscAhD        _RL viscAhD
764        _RL viscAhZ        _RL viscAhZ
765        _RL viscAhMax        _RL viscAhMax
766        _RL viscAhReMax        _RL viscAhReMax
767        _RL viscAhGrid        _RL viscAhGrid, viscAhGridMax, viscAhGridMin
       _RL viscAhGridMax  
       _RL viscAhGridMin  
768        _RL viscC2leith        _RL viscC2leith
769        _RL viscC2leithD        _RL viscC2leithD
770        _RL viscC2smag        _RL viscC2smag
       _RL viscC4smag  
       _RL viscAr  
771        _RL viscA4        _RL viscA4
772        _RL viscA4W        _RL viscA4W
773        _RL viscA4D        _RL viscA4D
# Line 757  C                      (i.e. allows conv Line 777  C                      (i.e. allows conv
777        _RL viscA4Grid, viscA4GridMax, viscA4GridMin        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
778        _RL viscC4leith        _RL viscC4leith
779        _RL viscC4leithD        _RL viscC4leithD
780          _RL viscC4smag
781        _RL diffKhT        _RL diffKhT
782        _RL diffKrNrT(Nr)        _RL diffKrNrT(Nr)
783        _RL diffK4T        _RL diffK4T
# Line 772  C                      (i.e. allows conv Line 793  C                      (i.e. allows conv
793        _RL diffKrBLEQdeep        _RL diffKrBLEQdeep
794        _RL diffKrBLEQscl        _RL diffKrBLEQscl
795        _RL diffKrBLEQHo        _RL diffKrBLEQHo
796        _RL delt        _RL tauCD, rCD, epsAB_CD
       _RL tauCD  
       _RL rCD  
797        _RL gravity        _RL gravity
798        _RL recip_gravity        _RL recip_gravity
799        _RL gBaro        _RL gBaro
# Line 783  C                      (i.e. allows conv Line 802  C                      (i.e. allows conv
802        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
803        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
804        _RL rhoConstFresh        _RL rhoConstFresh
805          _RL rho1Ref(Nr)
806        _RL tRef(Nr)        _RL tRef(Nr)
807        _RL sRef(Nr)        _RL sRef(Nr)
808        _RL phiRef(2*Nr+1)        _RL phiRef(2*Nr+1)
# Line 813  C                      (i.e. allows conv Line 833  C                      (i.e. allows conv
833        _RL rotationPeriod        _RL rotationPeriod
834        _RL tauThetaClimRelax        _RL tauThetaClimRelax
835        _RL tauSaltClimRelax        _RL tauSaltClimRelax
       _RL tauTr1ClimRelax  
       _RL lambdaTr1ClimRelax  
836        _RL latBandClimRelax        _RL latBandClimRelax
837        _RL externForcingCycle        _RL externForcingCycle
838        _RL externForcingPeriod        _RL externForcingPeriod
# Line 823  C                      (i.e. allows conv Line 841  C                      (i.e. allows conv
841        _RL salt_EvPrRn        _RL salt_EvPrRn
842        _RL ivdc_kappa        _RL ivdc_kappa
843        _RL hMixCriteria        _RL hMixCriteria
844          _RL dRhoSmall
845          _RL hMixSmooth
846        _RL Ro_SeaLevel        _RL Ro_SeaLevel
847        _RL sideDragFactor        _RL sideDragFactor
848        _RL bottomDragLinear        _RL bottomDragLinear
# Line 831  C                      (i.e. allows conv Line 851  C                      (i.e. allows conv
851        _RL nh_Am2        _RL nh_Am2
852        _RL tCylIn        _RL tCylIn
853        _RL tCylOut        _RL tCylOut
854          _RL phiEuler, thetaEuler, psiEuler
855    
856  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
857        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
# Line 846  C     atm_kappa :: kappa = R/Cp (R: cons Line 867  C     atm_kappa :: kappa = R/Cp (R: cons
867  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
868  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])
869  C     integr_GeoPot :: option to select the way we integrate the geopotential  C     integr_GeoPot :: option to select the way we integrate the geopotential
870  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
871  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
872  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
873        COMMON /PARM_ATM/        COMMON /PARM_ATM/
# Line 858  C             derived from the orography Line 879  C             derived from the orography
879        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
880    
881  C Logical flags for selecting packages  C Logical flags for selecting packages
882          LOGICAL useGAD
883          LOGICAL useOBCS
884          LOGICAL useSHAP_FILT
885          LOGICAL useZONAL_FILT
886        LOGICAL useOPPS        LOGICAL useOPPS
887        LOGICAL usePP81        LOGICAL usePP81
888        LOGICAL useMY82        LOGICAL useMY82
889        LOGICAL useGGL90        LOGICAL useGGL90
890        LOGICAL useKPP        LOGICAL useKPP
       LOGICAL useGAD  
891        LOGICAL useGMRedi        LOGICAL useGMRedi
892        LOGICAL useOBCS        LOGICAL useDOWN_SLOPE
       LOGICAL useAIM  
       LOGICAL useLand  
893        LOGICAL useCAL        LOGICAL useCAL
894        LOGICAL useEXF        LOGICAL useEXF
895          LOGICAL useBulkForce
896        LOGICAL useEBM        LOGICAL useEBM
897          LOGICAL useCheapAML
898        LOGICAL useGrdchk        LOGICAL useGrdchk
899          LOGICAL useSMOOTH
900        LOGICAL useECCO        LOGICAL useECCO
901        LOGICAL useSHAP_FILT        LOGICAL useSBO
       LOGICAL useZONAL_FILT  
902        LOGICAL useFLT        LOGICAL useFLT
903        LOGICAL usePTRACERS        LOGICAL usePTRACERS
904        LOGICAL useGCHEM        LOGICAL useGCHEM
905        LOGICAL useRBCS        LOGICAL useRBCS
906        LOGICAL useOffLine        LOGICAL useOffLine
907        LOGICAL useMATRIX        LOGICAL useMATRIX
       LOGICAL useSBO  
908        LOGICAL useSEAICE        LOGICAL useSEAICE
909          LOGICAL useSALT_PLUME
910        LOGICAL useShelfIce        LOGICAL useShelfIce
911          LOGICAL useICEFRONT
912        LOGICAL useThSIce        LOGICAL useThSIce
913        LOGICAL useATM2d        LOGICAL useATM2d
914        LOGICAL useBulkForce        LOGICAL useAIM
915        LOGICAL usefizhi        LOGICAL useLand
916        LOGICAL usegridalt        LOGICAL useFizhi
917          LOGICAL useGridAlt
918        LOGICAL useDiagnostics        LOGICAL useDiagnostics
       LOGICAL useMNC  
919        LOGICAL useREGRID        LOGICAL useREGRID
920          LOGICAL useLayers
921          LOGICAL useMNC
922        LOGICAL useRunClock        LOGICAL useRunClock
923        LOGICAL useEMBED_FILES        LOGICAL useEMBED_FILES
924        LOGICAL useMYPACKAGE        LOGICAL useMYPACKAGE
       LOGICAL useSALT_PLUME  
925        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
926         &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
927       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
928       &        useGAD, useGMRedi, useOBCS, useAIM, useLand,       &        useGMRedi, useDOWN_SLOPE,
929       &        useCAL, useEXF, useEBM, useGrdchk, useECCO,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
930       &        useSHAP_FILT, useZONAL_FILT, useFLT,       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,
931       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
932       &        useSBO, useSEAICE, useShelfIce,       &        useSEAICE, useSALT_PLUME, useShelfIce,
933       &        useThSIce, useATM2D, useBulkForce,       &        useICEFRONT, useThSIce,
934       &        usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
935       &        useRunClock, useEMBED_FILES, useMYPACKAGE, useSALT_PLUME       &        useDiagnostics, useREGRID, useLayers, useMNC,
936         &        useRunClock, useEMBED_FILES,
937         &        useMYPACKAGE
938  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
939  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
940  CEH3 ;;; End: ***  CEH3 ;;; End: ***

Legend:
Removed from v.1.210  
changed lines
  Added in v.1.235

  ViewVC Help
Powered by ViewVC 1.1.22