/[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.208 by dimitri, Wed Nov 28 00:18:17 2007 UTC revision 1.232 by mlosch, Mon Nov 23 16:13:57 2009 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 84  C     surfQnetFile    :: File containing Line 63  C     surfQnetFile    :: File containing
63  C     surfQswFile     :: File containing surface shortwave radiation  C     surfQswFile     :: File containing surface shortwave radiation
64  C     dQdTfile        :: File containing thermal relaxation coefficient  C     dQdTfile        :: File containing thermal relaxation coefficient
65  C     EmPmRfile       :: File containing surface fresh water flux  C     EmPmRfile       :: File containing surface fresh water flux
66    C           NOTE: for backward compatibility EmPmRfile is specified in
67    C                 m/s when using external_fields_load.F.  It is converted
68    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 95  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 104  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 118  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 135  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 161  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     selectAddFluid      :: option to add mass source/sink of fluid in the interior
147    C                            (3-D generalisation of oceanic real-fresh water flux)
148    C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
149  C     momForcingOutAB     :: =1: take momentum forcing contribution  C     momForcingOutAB     :: =1: take momentum forcing contribution
150  C                           out of (=0: in) Adams-Bashforth time stepping.  C                           out of (=0: in) Adams-Bashforth time stepping.
151  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
# Line 170  C     tempVertAdvScheme   :: Temp. Vert. Line 155  C     tempVertAdvScheme   :: Temp. Vert.
155  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
156  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
157  C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)  C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)
158    C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)
159    C     monitorSelect       :: select group of variables to monitor
160    C                            =1 : dynvars ; =2 : + vort ; =3 : + surface
161  C     debugLevel          :: debug level selector: higher -> more writing  C     debugLevel          :: debug level selector: higher -> more writing
162    
163        COMMON /PARM_I/        COMMON /PARM_I/
# Line 181  C     debugLevel          :: debug level Line 169  C     debugLevel          :: debug level
169       &        writeStatePrec,       &        writeStatePrec,
170       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
171       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
172         &        selectAddFluid,
173       &        momForcingOutAB, tracForcingOutAB,       &        momForcingOutAB, tracForcingOutAB,
174       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
175       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
176       &        selectKEscheme,       &        selectKEscheme, selectVortScheme,
177       &        debugLevel       &        monitorSelect, debugLevel
178        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
179        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
180        INTEGER cg2dPreCondFreq        INTEGER cg2dPreCondFreq
# Line 199  C     debugLevel          :: debug level Line 188  C     debugLevel          :: debug level
188        INTEGER readBinaryPrec        INTEGER readBinaryPrec
189        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
190        INTEGER select_rStar        INTEGER select_rStar
191          INTEGER selectAddFluid
192        INTEGER momForcingOutAB, tracForcingOutAB        INTEGER momForcingOutAB, tracForcingOutAB
193        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
194        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
195        INTEGER selectKEscheme        INTEGER selectKEscheme
196          INTEGER selectVortScheme
197          INTEGER monitorSelect
198        INTEGER debugLevel        INTEGER debugLevel
199    
 C  
       INTEGER debLevZero  
       PARAMETER(debLevZero=0)  
       INTEGER debLevA  
       PARAMETER(debLevA=1)  
       INTEGER debLevB  
       PARAMETER(debLevB=2)  
   
200  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
201    C- Coordinate + Grid params:
202    C     fluidIsAir       :: Set to indicate that the fluid major constituent
203    C                        is air
204    C     fluidIsWater     :: Set to indicate that the fluid major constituent
205    C                        is water
206    C     usingPCoords     :: Set to indicate that we are working in a pressure
207    C                        type coordinate (p or p*).
208    C     usingZCoords     :: Set to indicate that we are working in a height
209    C                        type coordinate (z or z*)
210    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
211    C                         this requires specific code for restart & exchange
212  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
213  C                          coordinate frame.  C                          coordinate frame.
214  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
215  C                               spherical polar frame.  C                               spherical polar frame.
216  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     rotateGrid      :: rotate grid coordinates to geographical coordinates
217    C                        according to Euler angles phiEuler, thetaEuler, psiEuler
218  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
219    C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
220  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
221  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
222    C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
223    C- Momentum params:
224    C     no_slip_sides  :: Impose "no-slip" at lateral boundaries.
225  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
226    C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
227    C                       on irregular grids)
228    C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
229    C     useAreaViscLength :: Set to true to use old scaling for viscous lengths,
230    C                          e.g., L2=Raz.  May be preferable for cube sphere.
231  C     momViscosity  :: Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
232  C     momAdvection  :: Flag which turns advection of momentum on and off.  C     momAdvection  :: Flag which turns advection of momentum on and off.
233  C     momForcing    :: Flag which turns external forcing of momentum on  C     momForcing    :: Flag which turns external forcing of momentum on
234  C                     and off.  C                      and off.
235  C     momPressureForcing :: Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
236  C                          on and off.  C                          on and off.
237  C     metricTerms   :: Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
238  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
239  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
240  C     tempAdvection :: Flag which turns advection of temperature on  C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
241  C                     and off.  C     useConstantF  :: Coriolis parameter set to f0
242  C     tempForcing   :: Flag which turns external forcing of temperature on  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
243  C                     and off.  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
244  C     saltAdvection :: Flag which turns advection of salinity on  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
245  C                     and off.  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
246  C     saltForcing   :: Flag which turns external forcing of salinity on  C                                (default = F = use mom_fluxform package)
247  C                     and off.  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986)
248    C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
249    C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
250    C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
251    C     useAbsVorticity :: work with f+zeta in Coriolis terms
252    C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
253    C     momStepping    :: Turns momentum equation time-stepping off
254    C- Temp. & Salt params:
255    C     tempStepping   :: Turns temperature equation time-stepping off
256    C     saltStepping   :: Turns salinity equation time-stepping off
257    C     tempAdvection  :: Flag which turns advection of temperature on and off.
258    C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
259    C     tempForcing    :: Flag which turns external forcing of temperature on
260    C                       and off.
261    C     saltAdvection  :: Flag which turns advection of salinity on and off.
262    C     saltIsActiveTr :: Salinity  is a dynamically active tracer
263    C     saltForcing    :: Flag which turns external forcing of salinity on
264    C                       and off.
265    C     maskIniTemp    :: apply mask to initial Pot.Temp.
266    C     maskIniSalt    :: apply mask to initial salinity
267    C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
268    C     checkIniSalt   :: check for points with identically zero initial salinity
269  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
270  C                         as a real Fresh Water (=> changes the Sea Level)  C                         as a real Fresh Water (=> changes the Sea Level)
271  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)
272  C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable  C- Pressure solver related parameters (PARM02)
273  C                       on irregular grids)  C     useSRCGSolver  :: Set to true to use conjugate gradient
274  C     useAreaViscLength :: Set to true to use old scaling for viscous  C                       solver with single reduction (only one call of
275  C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.  C                       s/r mpi_allreduce), default is false
276  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms  C- Time-stepping params:
277  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
278  C     implicitFreeSurface :: Set to true to use implicit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
279  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
280  C     linFSConserveTr     :: Set to true to correct source/sink of tracer  C     linFSConserveTr     :: Set to true to correct source/sink of tracer
281  C                            at the surface due to Linear Free Surface  C                            at the surface due to Linear Free Surface
282  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
283  C                           linear relation Phi_surf = Bo_surf*eta  C                            linear relation Phi_surf = Bo_surf*eta
284  C     use3Dsolver   :: set to true to use 3-D pressure solver  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
285    C     nonHydrostatic   :: Using non-hydrostatic algorithm
286    C     use3Dsolver      :: set to true to use 3-D pressure solver
287  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
288  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  
289  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
290  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
291  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
# Line 284  C     momDissip_In_AB   :: if False, put Line 297  C     momDissip_In_AB   :: if False, put
297  C                          out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
298  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
299  C                          apply AB on tracer tendencies (rather than on Tracer)  C                          apply AB on tracer tendencies (rather than on Tracer)
300  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match  C- Other forcing params -
301  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     balanceEmPmR    :: substract global mean of EmPmR at every time step
302  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from  C     balanceQnet     :: substract global mean of Qnet at every time step
303  C                           before checkpoint-54a, Jul 06, 2004.  C     balancePrintMean:: print substracted global means to STDOUT
304  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
305  C                        climatology is required.  C                        climatology is required.
306  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
307  C                        climatology is required.  C                        climatology is required.
308    C     allowFreezing  :: Allows surface water to freeze and form ice
309    C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
310  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
311  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  
312  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
313  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
314  C                       slow (f77) or does not work (f90).  When  C                       slow (f77) or does not work (f90).  When
315  C                       useSingleCpuIO is set, mdsio_writefield.F  C                       useSingleCpuIO is set, mdsio_writefield.F
316  C                       outputs from master mpi process only.  C                       outputs from master mpi process only.
317  C     allowFreezing  :: Allows surface water to freeze and form ice  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
318  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
319    C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
320    C                           before checkpoint-54a, Jul 06, 2004.
321  C     pickup_write_mdsio :: use mdsio to write pickups  C     pickup_write_mdsio :: use mdsio to write pickups
322  C     pickup_read_mdsio  :: use mdsio to read  pickups  C     pickup_read_mdsio  :: use mdsio to read  pickups
323  C     pickup_write_immed :: echo the pickup immediately (for conversion)  C     pickup_write_immed :: echo the pickup immediately (for conversion)
324    C     writePickupAtEnd   :: write pickup at the last timestep
325  C     timeave_mdsio      :: use mdsio for timeave output  C     timeave_mdsio      :: use mdsio for timeave output
326  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
327  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
328  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
329  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  
330    
331        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/
332         & fluidIsAir, fluidIsWater,
333         & usingPCoords, usingZCoords, useDynP_inEos_Zc,
334         & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
335       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
336       & deepAtmosphere, setInterFDr, setCenterDr,       & deepAtmosphere, setInterFDr, setCenterDr,
337       & no_slip_sides,no_slip_bottom,       & no_slip_sides, no_slip_bottom,
338       & momViscosity, momAdvection, momForcing, useCoriolis,       & useFullLeith, useStrainTensionVisc, useAreaViscLength,
339       & momPressureForcing, vectorInvariantMomentum,       & momViscosity, momAdvection, momForcing,
340       & tempAdvection, tempForcing,       & momPressureForcing, metricTerms, useNHMTerms,
341       & saltAdvection, saltForcing,       & useCoriolis, use3dCoriolis,
342         & useConstantF, useBetaPlaneF, useSphereF,
343         & useCDscheme, vectorInvariantMomentum,
344         & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
345         & upwindVorticity, highOrderVorticity,
346         & useAbsVorticity, upwindShear,
347         & momStepping, tempStepping, saltStepping,
348         & tempAdvection, tempIsActiveTr, tempForcing,
349         & saltAdvection, saltIsActiveTr, saltForcing,
350         & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
351       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
      & useFullLeith, useStrainTensionVisc,  
      & useAreaViscLength,  
352       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
353       & uniformLin_PhiSurf,       & uniformLin_PhiSurf,
354         & quasiHydrostatic, nonHydrostatic,
355       & use3Dsolver, implicitIntGravWave, staggerTimeStep,       & use3Dsolver, implicitIntGravWave, staggerTimeStep,
      & momStepping, tempStepping, saltStepping,  
      & metricTerms, useNHMTerms,  
      & useConstantF, useBetaPlaneF, useSphereF, use3dCoriolis,  
      & useCDscheme,  
      & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,  
      & SadournyCoriolis, upwindVorticity, highOrderVorticity,  
      & useAbsVorticity, upwindShear,  
356       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
357       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
358       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
359       & momDissip_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
360       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & balanceEmPmR, balanceQnet, balancePrintMean,
361       & periodicExternalForcing,       & doThetaClimRelax, doSaltClimRelax,
      & fluidIsAir, fluidIsWater,  
      & usingPCoords, usingZCoords, useDynP_inEos_Zc,  
      & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,  
362       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
363         & periodicExternalForcing,
364         & globalFiles, useSingleCpuIO,
365       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
366       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
367         & writePickupAtEnd,
368       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
369       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast, debugMode,
370       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & inAdMode, inAdTrue, inAdFalse, inAdExact,
371       & balanceEmPmR, balanceQnet, balancePrintMean       & useSRCGSolver
372    
373          LOGICAL fluidIsAir
374          LOGICAL fluidIsWater
375          LOGICAL usingPCoords
376          LOGICAL usingZCoords
377          LOGICAL useDynP_inEos_Zc
378        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
379        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid, rotateGrid
380        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
381        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
382        LOGICAL deepAtmosphere        LOGICAL deepAtmosphere
# Line 381  C     balancePrintMean:: print substract Line 392  C     balancePrintMean:: print substract
392        LOGICAL useCoriolis        LOGICAL useCoriolis
393        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
394        LOGICAL tempAdvection        LOGICAL tempAdvection
395          LOGICAL tempIsActiveTr
396        LOGICAL tempForcing        LOGICAL tempForcing
397        LOGICAL saltAdvection        LOGICAL saltAdvection
398          LOGICAL saltIsActiveTr
399        LOGICAL saltForcing        LOGICAL saltForcing
400          LOGICAL maskIniTemp
401          LOGICAL maskIniSalt
402          LOGICAL checkIniTemp
403          LOGICAL checkIniSalt
404        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
405        LOGICAL useFullLeith        LOGICAL useFullLeith
406        LOGICAL useStrainTensionVisc        LOGICAL useStrainTensionVisc
# Line 393  C     balancePrintMean:: print substract Line 410  C     balancePrintMean:: print substract
410        LOGICAL exactConserv        LOGICAL exactConserv
411        LOGICAL linFSConserveTr        LOGICAL linFSConserveTr
412        LOGICAL uniformLin_PhiSurf        LOGICAL uniformLin_PhiSurf
413          LOGICAL quasiHydrostatic
414          LOGICAL nonHydrostatic
415        LOGICAL use3Dsolver        LOGICAL use3Dsolver
416        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
417        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
# Line 408  C     balancePrintMean:: print substract Line 427  C     balancePrintMean:: print substract
427        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
428        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
429        LOGICAL useJamartMomAdv        LOGICAL useJamartMomAdv
       LOGICAL SadournyCoriolis  
430        LOGICAL upwindVorticity        LOGICAL upwindVorticity
431        LOGICAL highOrderVorticity        LOGICAL highOrderVorticity
432        LOGICAL useAbsVorticity        LOGICAL useAbsVorticity
# Line 422  C     balancePrintMean:: print substract Line 440  C     balancePrintMean:: print substract
440        LOGICAL useMultiDimAdvec        LOGICAL useMultiDimAdvec
441        LOGICAL momDissip_In_AB        LOGICAL momDissip_In_AB
442        LOGICAL doAB_onGtGs        LOGICAL doAB_onGtGs
443          LOGICAL balanceEmPmR
444          LOGICAL balanceQnet
445          LOGICAL balancePrintMean
446        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
447        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
448        LOGICAL doTr1ClimRelax        LOGICAL allowFreezing
449          LOGICAL useOldFreezing
450        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
       LOGICAL fluidIsAir  
       LOGICAL fluidIsWater  
       LOGICAL usingPCoords  
       LOGICAL usingZCoords  
       LOGICAL useDynP_inEos_Zc  
       LOGICAL nonHydrostatic  
       LOGICAL quasiHydrostatic  
451        LOGICAL globalFiles        LOGICAL globalFiles
452        LOGICAL useSingleCpuIO        LOGICAL useSingleCpuIO
       LOGICAL allowFreezing  
       LOGICAL useOldFreezing  
453        LOGICAL pickupStrictlyMatch        LOGICAL pickupStrictlyMatch
454        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
455        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
       LOGICAL dumpInitAndLast  
       LOGICAL debugMode  
456        LOGICAL pickup_read_mdsio, pickup_write_mdsio        LOGICAL pickup_read_mdsio, pickup_write_mdsio
457        LOGICAL pickup_write_immed        LOGICAL pickup_write_immed, writePickupAtEnd
458        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
459        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
460          LOGICAL dumpInitAndLast
461          LOGICAL debugMode
462        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
463          LOGICAL useSRCGSolver
       LOGICAL balanceEmPmR  
       LOGICAL balanceQnet  
       LOGICAL balancePrintMean  
464    
465  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
466  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 485  C     rhoConst  :: Vertically constant r Line 495  C     rhoConst  :: Vertically constant r
495  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
496  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
497  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
498    C     rho1Ref   :: reference vertical profile for density
499  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
500  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
501  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
# Line 505  C     rUnit2mass :: units conversion fac Line 516  C     rUnit2mass :: units conversion fac
516  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].
517  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
518  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
519  C     phiMin    :: Latitude of southern most cell face.  C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
520  C     thetaMin  :: Longitude of western most cell face (this  C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
521  C                 is an "inert" parameter but it is included  C                :: parameter but it makes geographical references simple.)
522  C                 to make geographical references simple.)  C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
523  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).  C                :: most face (Lat-Lon grid).
524    C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
525  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
526  C     f0        :: Reference coriolis parameter ( 1/s )  C     f0         :: Reference coriolis parameter ( 1/s )
527  C                 ( Southern edge f for beta plane )  C                   ( Southern edge f for beta plane )
528  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta       :: df/dy ( s^-1.m^-1 )
529  C     omega     :: Angular velocity ( rad/s )  C     omega      :: Angular velocity ( rad/s )
530  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
531  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
532  C                 momentum laterally ( m^2/s )  C                   for vertical mixing of momentum ( units of r^2/s )
533  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  
534  C                   momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
535  C     viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
536  C                   coeff. for mixing of momentum laterally (non-dim)  C                   momentum laterally, no effect for hydrostatic
537    C                   model, defaults to viscAh if unset ( m^2/s )
538    C                   Not used if variable horiz. viscosity is used.
539    C     viscA4     :: Biharmonic viscosity coeff. for mixing of
540    C                   momentum laterally ( m^4/s )
541    C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
542    C                   momentum laterally, no effect for hydrostatic
543    C                   model, defaults to viscA4 if unset ( m^2/s )
544    C                   Not used if variable horiz. viscosity is used.
545    C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
546    C                   (act on Divergence part) ( m^2/s )
547    C     viscAhZ    :: Eddy viscosity coeff. for mixing of momentum laterally
548    C                   (act on Vorticity  part) ( m^2/s )
549    C     viscA4D    :: Biharmonic viscosity coeff. for mixing of momentum laterally
550    C                   (act on Divergence part) ( m^4/s )
551    C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
552    C                   (act on Vorticity  part) ( m^4/s )
553    C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
554    C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
555    C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
556    C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
557    C     viscC2smag   :: Smagorinsky non-dimensional viscosity factor (harmonic)
558    C     viscC4smag   :: Smagorinsky non-dimensional viscosity factor (biharmonic)
559    C     viscAhMax    :: Maximum eddy viscosity coeff. for mixing of
560    C                    momentum laterally ( m^2/s )
561    C     viscAhReMax  :: Maximum gridscale Reynolds number for eddy viscosity
562    C                     coeff. for mixing of momentum laterally (non-dim)
563    C     viscAhGrid   :: non-dimensional grid-size dependent viscosity
564  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
565  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
566  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max    :: Maximum biharmonic viscosity coeff. for mixing of
567  C                 momentum laterally ( m^4/s )  C                     momentum laterally ( m^4/s )
568  C     viscA4ReMax :: Maximum Gridscale Reynolds number for  C     viscA4ReMax  :: Maximum Gridscale Reynolds number for
569  C                  biharmonic viscosity coeff. momentum laterally (non-dim)  C                     biharmonic viscosity coeff. momentum laterally (non-dim)
570  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  
571  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
572  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))  
573  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
574  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
575  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
576  C                 for mixing of heat vertically ( units of r^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
577  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
578  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
579  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
580  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
581  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
582  C                 for mixing of salt vertically ( units of r^2/s ),  C                 for mixing of salt vertically ( units of r^2/s ),
583  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
584  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
585  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 601  C                     Implicit part of S Line 613  C                     Implicit part of S
613  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
614  C                     Implicit part of barotropic flow Divergence ( 0-1 )  C                     Implicit part of barotropic flow Divergence ( 0-1 )
615  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
616  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    :: Minimum dimensional size of a cell (affects hFacC etc..., m)
617  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    :: Minimum dimensional size of a cell (affects hFacC etc..., Pa)
618  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)
619  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
620  C     hFacSup        that control vanishing and creating levels  C     hFacSup          that control vanishing and creating levels
621  C     tauCD        :: CD scheme coupling timescale ( 1/s )  C     tauCD         :: CD scheme coupling timescale ( s )
622  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )  C     rCD           :: CD scheme normalised coupling parameter (= 1 - deltaT/tauCD)
623    C     epsAB_CD      :: Adams-Bashforth-2 stabilizing weight used in CD scheme
624  C     baseTime      :: model base time (time origin) = time @ iteration zero  C     baseTime      :: model base time (time origin) = time @ iteration zero
625  C     startTime     :: Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
626  C     endTime       :: Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
# Line 626  C     mtFacMom      :: Metric terms trac Line 639  C     mtFacMom      :: Metric terms trac
639  C     cosPower      :: Power of cosine of latitude to multiply viscosity  C     cosPower      :: Power of cosine of latitude to multiply viscosity
640  C     cAdjFreq      :: Frequency of convective adjustment  C     cAdjFreq      :: Frequency of convective adjustment
641  C  C
642  C     taveFreq      :: Frequency with which time-averaged model state  C     taveFreq      :: Frequency with which time-averaged model state
643  C                      is written to post-processing files ( s ).  C                      is written to post-processing files ( s ).
644  C     tave_lastIter :: (for state variable only) fraction of the last time  C     tave_lastIter :: (for state variable only) fraction of the last time
645  C                      step (of each taveFreq period) put in the time average.  C                      step (of each taveFreq period) put in the time average.
646  C                      (fraction for 1rst iter = 1 - tave_lastIter)  C                      (fraction for 1rst iter = 1 - tave_lastIter)
647  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
648  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
# Line 641  C                          (note: extern Line 654  C                          (note: extern
654  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
655  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
656  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
657  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
658  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
659  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
660  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
661  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
662  C     hMixCrit    :: criteria for mixed-layer diagnostic  C     hMixCriteria:: criteria for mixed-layer diagnostic
663    C     dRhoSmall   :: parameter for mixed-layer diagnostic
664    C     hMixSmooth  :: Smoothing parameter for mixed-layer diag (default=0=no smoothing)
665  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
666  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
667  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
668  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
669  C                           (default=2: full drag ; =1: gives half-slip BC)  C                           (default=2: full drag ; =1: gives half-slip BC)
670  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
671  C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)  C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
# Line 660  C                           is to be rep Line 675  C                           is to be rep
675  C                           (affects myabs, mymin, mymax)  C                           (affects myabs, mymin, mymax)
676  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
677  C                      (i.e. allows convection at different Rayleigh numbers)  C                      (i.e. allows convection at different Rayleigh numbers)
678    C     phiEuler      :: Euler angle, rotation about original z-axis
679    C     thetaEuler    :: Euler angle, rotation about new x-axis
680    C     psiEuler      :: Euler angle, rotation about new z-axis
681        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
682       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
683       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
684       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
685       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
686       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & xgOrigin, ygOrigin, rSphere, recip_RSphere, f0, beta,
687       & viscAh, viscAhW, viscAhMax,       & viscAh, viscAhW, viscAhMax,
688       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
689       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
690       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
691       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
692       & viscA4, viscA4W,       & viscA4, viscA4W, viscA4Max,
693       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Grid, viscA4GridMax, viscA4GridMin,
694       & viscAhRemax, viscA4Remax,       & viscAhReMax, viscA4ReMax,
695       & viscC4leith, viscC4leithD, viscAr,       & viscC4leith, viscC4leithD, viscArNr,
696       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
697       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
698       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
699       & BL79LatVary,       & BL79LatVary,
700       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
701       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & tauCD, rCD, epsAB_CD,
702         & freeSurfFac, implicSurfPress, implicDiv2Dflow,
703       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
704       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
705       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
706       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
707       & rhoConstFresh, tRef, sRef, phiRef, dBdrRef,       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
708       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
709       & baseTime, startTime, endTime,       & baseTime, startTime, endTime,
710       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
711       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
712       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
713       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
714       & tauThetaClimRelax, tauSaltClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
      & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,  
715       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
716       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
717       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
718       & ivdc_kappa, hMixCriteria, Ro_SeaLevel,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, Ro_SeaLevel,
719       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
720       & smoothAbsFuncRange,       & smoothAbsFuncRange,
721       & tCylIn, tCylOut       & tCylIn, tCylOut,
722         & phiEuler, thetaEuler, psiEuler
723    
724        _RL cg2dTargetResidual        _RL cg2dTargetResidual
725        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
# Line 716  C                      (i.e. allows conv Line 735  C                      (i.e. allows conv
735        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
736        _RL deltaTfreesurf        _RL deltaTfreesurf
737        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
738        _RL phiMin        _RL xgOrigin
739        _RL thetaMin        _RL ygOrigin
740        _RL rSphere        _RL rSphere
741        _RL recip_rSphere        _RL recip_rSphere
742        _RL f0        _RL f0
# Line 731  C                      (i.e. allows conv Line 750  C                      (i.e. allows conv
750        _RL hFacInf        _RL hFacInf
751        _RL hFacSup        _RL hFacSup
752        _RL beta        _RL beta
753          _RL viscArNr(Nr)
754        _RL viscAh        _RL viscAh
755        _RL viscAhW        _RL viscAhW
756        _RL viscAhD        _RL viscAhD
757        _RL viscAhZ        _RL viscAhZ
758        _RL viscAhMax        _RL viscAhMax
759        _RL viscAhReMax        _RL viscAhReMax
760        _RL viscAhGrid        _RL viscAhGrid, viscAhGridMax, viscAhGridMin
       _RL viscAhGridMax  
       _RL viscAhGridMin  
761        _RL viscC2leith        _RL viscC2leith
762        _RL viscC2leithD        _RL viscC2leithD
763        _RL viscC2smag        _RL viscC2smag
       _RL viscC4smag  
       _RL viscAr  
764        _RL viscA4        _RL viscA4
765        _RL viscA4W        _RL viscA4W
766        _RL viscA4D        _RL viscA4D
# Line 754  C                      (i.e. allows conv Line 770  C                      (i.e. allows conv
770        _RL viscA4Grid, viscA4GridMax, viscA4GridMin        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
771        _RL viscC4leith        _RL viscC4leith
772        _RL viscC4leithD        _RL viscC4leithD
773          _RL viscC4smag
774        _RL diffKhT        _RL diffKhT
775        _RL diffKrNrT(Nr)        _RL diffKrNrT(Nr)
776        _RL diffK4T        _RL diffK4T
# Line 769  C                      (i.e. allows conv Line 786  C                      (i.e. allows conv
786        _RL diffKrBLEQdeep        _RL diffKrBLEQdeep
787        _RL diffKrBLEQscl        _RL diffKrBLEQscl
788        _RL diffKrBLEQHo        _RL diffKrBLEQHo
789        _RL delt        _RL tauCD, rCD, epsAB_CD
       _RL tauCD  
       _RL rCD  
790        _RL gravity        _RL gravity
791        _RL recip_gravity        _RL recip_gravity
792        _RL gBaro        _RL gBaro
# Line 780  C                      (i.e. allows conv Line 795  C                      (i.e. allows conv
795        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
796        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
797        _RL rhoConstFresh        _RL rhoConstFresh
798          _RL rho1Ref(Nr)
799        _RL tRef(Nr)        _RL tRef(Nr)
800        _RL sRef(Nr)        _RL sRef(Nr)
801        _RL phiRef(2*Nr+1)        _RL phiRef(2*Nr+1)
# Line 810  C                      (i.e. allows conv Line 826  C                      (i.e. allows conv
826        _RL rotationPeriod        _RL rotationPeriod
827        _RL tauThetaClimRelax        _RL tauThetaClimRelax
828        _RL tauSaltClimRelax        _RL tauSaltClimRelax
       _RL tauTr1ClimRelax  
       _RL lambdaTr1ClimRelax  
829        _RL latBandClimRelax        _RL latBandClimRelax
830        _RL externForcingCycle        _RL externForcingCycle
831        _RL externForcingPeriod        _RL externForcingPeriod
# Line 820  C                      (i.e. allows conv Line 834  C                      (i.e. allows conv
834        _RL salt_EvPrRn        _RL salt_EvPrRn
835        _RL ivdc_kappa        _RL ivdc_kappa
836        _RL hMixCriteria        _RL hMixCriteria
837          _RL dRhoSmall
838          _RL hMixSmooth
839        _RL Ro_SeaLevel        _RL Ro_SeaLevel
840        _RL sideDragFactor        _RL sideDragFactor
841        _RL bottomDragLinear        _RL bottomDragLinear
# Line 828  C                      (i.e. allows conv Line 844  C                      (i.e. allows conv
844        _RL nh_Am2        _RL nh_Am2
845        _RL tCylIn        _RL tCylIn
846        _RL tCylOut        _RL tCylOut
847          _RL phiEuler, thetaEuler, psiEuler
848    
849  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
850        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
# Line 843  C     atm_kappa :: kappa = R/Cp (R: cons Line 860  C     atm_kappa :: kappa = R/Cp (R: cons
860  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
861  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])
862  C     integr_GeoPot :: option to select the way we integrate the geopotential  C     integr_GeoPot :: option to select the way we integrate the geopotential
863  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
864  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
865  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
866        COMMON /PARM_ATM/        COMMON /PARM_ATM/
# Line 855  C             derived from the orography Line 872  C             derived from the orography
872        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
873    
874  C Logical flags for selecting packages  C Logical flags for selecting packages
875          LOGICAL useGAD
876          LOGICAL useOBCS
877          LOGICAL useSHAP_FILT
878          LOGICAL useZONAL_FILT
879        LOGICAL useOPPS        LOGICAL useOPPS
880        LOGICAL usePP81        LOGICAL usePP81
881        LOGICAL useMY82        LOGICAL useMY82
882        LOGICAL useGGL90        LOGICAL useGGL90
883        LOGICAL useKPP        LOGICAL useKPP
       LOGICAL useGAD  
884        LOGICAL useGMRedi        LOGICAL useGMRedi
885        LOGICAL useOBCS        LOGICAL useDOWN_SLOPE
       LOGICAL useAIM  
       LOGICAL useLand  
886        LOGICAL useCAL        LOGICAL useCAL
887        LOGICAL useEXF        LOGICAL useEXF
888          LOGICAL useBulkForce
889        LOGICAL useEBM        LOGICAL useEBM
890          LOGICAL useCheapAML
891        LOGICAL useGrdchk        LOGICAL useGrdchk
892          LOGICAL useSMOOTH
893        LOGICAL useECCO        LOGICAL useECCO
894        LOGICAL useSHAP_FILT        LOGICAL useSBO
       LOGICAL useZONAL_FILT  
895        LOGICAL useFLT        LOGICAL useFLT
896        LOGICAL usePTRACERS        LOGICAL usePTRACERS
897        LOGICAL useGCHEM        LOGICAL useGCHEM
898        LOGICAL useRBCS        LOGICAL useRBCS
899        LOGICAL useOffLine        LOGICAL useOffLine
900        LOGICAL useMATRIX        LOGICAL useMATRIX
       LOGICAL useSBO  
901        LOGICAL useSEAICE        LOGICAL useSEAICE
902          LOGICAL useSALT_PLUME
903        LOGICAL useShelfIce        LOGICAL useShelfIce
904        LOGICAL useThSIce        LOGICAL useThSIce
905        LOGICAL useATM2d        LOGICAL useATM2d
906        LOGICAL useBulkForce        LOGICAL useAIM
907        LOGICAL usefizhi        LOGICAL useLand
908        LOGICAL usegridalt        LOGICAL useFizhi
909          LOGICAL useGridAlt
910        LOGICAL useDiagnostics        LOGICAL useDiagnostics
       LOGICAL useMNC  
911        LOGICAL useREGRID        LOGICAL useREGRID
912          LOGICAL useLayers
913          LOGICAL useMNC
914        LOGICAL useRunClock        LOGICAL useRunClock
915        LOGICAL useEMBED_FILES        LOGICAL useEMBED_FILES
916        LOGICAL useMYPACKAGE        LOGICAL useMYPACKAGE
       LOGICAL useSaltPlume  
917        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
918         &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
919       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
920       &        useGAD, useGMRedi, useOBCS, useAIM, useLand,       &        useGMRedi, useDOWN_SLOPE,
921       &        useCAL, useEXF, useEBM, useGrdchk, useECCO,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
922       &        useSHAP_FILT, useZONAL_FILT, useFLT,       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,
923       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
924       &        useSBO, useSEAICE, useShelfIce,       &        useSEAICE, useSALT_PLUME, useShelfIce, useThSIce,
925       &        useThSIce, useATM2D, useBulkForce,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
926       &        usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID,       &        useDiagnostics, useREGRID, useLayers, useMNC,
927       &        useRunClock, useEMBED_FILES, useMYPACKAGE, useSaltPlume       &        useRunClock, useEMBED_FILES,
928         &        useMYPACKAGE
929  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
930  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
931  CEH3 ;;; End: ***  CEH3 ;;; End: ***
Legend:
Removed from v.1.208  
changed lines
  Added in v.1.232
  ViewVC Help
Powered by ViewVC 1.1.22