/[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.205 by jmc, Fri Oct 19 14:34:13 2007 UTC revision 1.230 by jmc, Thu Oct 15 01:05:54 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
 C                     and off.  
 C     tempForcing   :: Flag which turns external forcing of temperature on  
 C                     and off.  
 C     saltAdvection :: Flag which turns advection of salinity on  
 C                     and off.  
 C     saltForcing   :: Flag which turns external forcing of salinity on  
 C                     and off.  
 C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  
 C                         as a real Fresh Water (=> changes the Sea Level)  
 C                         if F, converts P+R-E to salt flux (no SL effect)  
 C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable  
 C                       on irregular grids)  
 C     useAreaViscLength :: Set to true to use old scaling for viscous  
 C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.  
 C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms  
 C     rigidLid            :: Set to true to use rigid lid  
 C     implicitFreeSurface :: Set to true to use implicit free surface  
 C     exactConserv        :: Set to true to conserve exactly the total Volume  
 C     linFSConserveTr     :: Set to true to correct source/sink of tracer  
 C                            at the surface due to Linear Free Surface  
 C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the  
 C                           linear relation Phi_surf = Bo_surf*eta  
 C     use3Dsolver   :: set to true to use 3-D pressure solver  
 C     implicitIntGravWave :: treat Internal Gravity Wave implicitly  
 C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V  
 C     momStepping   :: Turns momentum equation time-stepping off  
 C     tempStepping  :: Turns temperature equation time-stepping off  
 C     saltStepping  :: Turns salinity equation time-stepping off  
241  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
242  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
243  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
 C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off  
244  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
245  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
246    C                                (default = F = use mom_fluxform package)
247    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986)
248  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
 C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny  
249  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
250  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
 C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)  
251  C     useAbsVorticity :: work with f+zeta in Coriolis terms  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
270    C                         as a real Fresh Water (=> changes the Sea Level)
271    C                         if F, converts P+R-E to salt flux (no SL effect)
272    C- Time-stepping params:
273    C     rigidLid            :: Set to true to use rigid lid
274    C     implicitFreeSurface :: Set to true to use implicit free surface
275    C     exactConserv        :: Set to true to conserve exactly the total Volume
276    C     linFSConserveTr     :: Set to true to correct source/sink of tracer
277    C                            at the surface due to Linear Free Surface
278    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
279    C                            linear relation Phi_surf = Bo_surf*eta
280    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
281    C     nonHydrostatic   :: Using non-hydrostatic algorithm
282    C     use3Dsolver      :: set to true to use 3-D pressure solver
283    C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
284    C     staggerTimeStep   :: enable a Stagger time stepping U,V (& W) then T,S
285  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
286  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
287  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 293  C     momDissip_In_AB   :: if False, put
293  C                          out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
294  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
295  C                          apply AB on tracer tendencies (rather than on Tracer)  C                          apply AB on tracer tendencies (rather than on Tracer)
296  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C- Other forcing params -
297  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from  C     balanceEmPmR    :: substract global mean of EmPmR at every time step
298  C                           before checkpoint-54a, Jul 06, 2004.  C     balanceQnet     :: substract global mean of Qnet at every time step
299    C     balancePrintMean:: print substracted global means to STDOUT
300  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
301  C                        climatology is required.  C                        climatology is required.
302  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
303  C                        climatology is required.  C                        climatology is required.
304    C     allowFreezing  :: Allows surface water to freeze and form ice
305    C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
306  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
307  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  
308  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
309  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
310  C                       slow (f77) or does not work (f90).  When  C                       slow (f77) or does not work (f90).  When
311  C                       useSingleCpuIO is set, mdsio_writefield.F  C                       useSingleCpuIO is set, mdsio_writefield.F
312  C                       outputs from master mpi process only.  C                       outputs from master mpi process only.
313  C     allowFreezing  :: Allows surface water to freeze and form ice  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
314  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
315    C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
316    C                           before checkpoint-54a, Jul 06, 2004.
317  C     pickup_write_mdsio :: use mdsio to write pickups  C     pickup_write_mdsio :: use mdsio to write pickups
318  C     pickup_read_mdsio  :: use mdsio to read  pickups  C     pickup_read_mdsio  :: use mdsio to read  pickups
319  C     pickup_write_immed :: echo the pickup immediately (for conversion)  C     pickup_write_immed :: echo the pickup immediately (for conversion)
320    C     writePickupAtEnd   :: write pickup at the last timestep
321  C     timeave_mdsio      :: use mdsio for timeave output  C     timeave_mdsio      :: use mdsio for timeave output
322  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
323  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
324  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
325  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  
326    
327        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/
328         & fluidIsAir, fluidIsWater,
329         & usingPCoords, usingZCoords, useDynP_inEos_Zc,
330         & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
331       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
332       & deepAtmosphere, setInterFDr, setCenterDr,       & deepAtmosphere, setInterFDr, setCenterDr,
333       & no_slip_sides,no_slip_bottom,       & no_slip_sides, no_slip_bottom,
334       & momViscosity, momAdvection, momForcing, useCoriolis,       & useFullLeith, useStrainTensionVisc, useAreaViscLength,
335       & momPressureForcing, vectorInvariantMomentum,       & momViscosity, momAdvection, momForcing,
336       & tempAdvection, tempForcing,       & momPressureForcing, metricTerms, useNHMTerms,
337       & saltAdvection, saltForcing,       & useCoriolis, use3dCoriolis,
338         & useConstantF, useBetaPlaneF, useSphereF,
339         & useCDscheme, vectorInvariantMomentum,
340         & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
341         & upwindVorticity, highOrderVorticity,
342         & useAbsVorticity, upwindShear,
343         & momStepping, tempStepping, saltStepping,
344         & tempAdvection, tempIsActiveTr, tempForcing,
345         & saltAdvection, saltIsActiveTr, saltForcing,
346         & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
347       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
      & useFullLeith, useStrainTensionVisc,  
      & useAreaViscLength,  
348       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
349       & uniformLin_PhiSurf,       & uniformLin_PhiSurf,
350         & quasiHydrostatic, nonHydrostatic,
351       & use3Dsolver, implicitIntGravWave, staggerTimeStep,       & use3Dsolver, implicitIntGravWave, staggerTimeStep,
      & momStepping, tempStepping, saltStepping,  
      & metricTerms, useNHMTerms,  
      & useConstantF, useBetaPlaneF, useSphereF, use3dCoriolis,  
      & useCDscheme,  
      & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,  
      & SadournyCoriolis, upwindVorticity, highOrderVorticity,  
      & useAbsVorticity, upwindShear,  
352       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
353       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
354       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
355       & momDissip_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
356       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & balanceEmPmR, balanceQnet, balancePrintMean,
357       & periodicExternalForcing,       & doThetaClimRelax, doSaltClimRelax,
      & fluidIsAir, fluidIsWater,  
      & usingPCoords, usingZCoords, useDynP_inEos_Zc,  
      & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,  
358       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
359       & usePickupBeforeC54, startFromPickupAB2,       & periodicExternalForcing,
360         & globalFiles, useSingleCpuIO,
361         & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
362       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
363         & writePickupAtEnd,
364       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
365       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast, debugMode,
366       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & inAdMode, inAdTrue, inAdFalse, inAdExact
      & balanceEmPmR, balanceQnet, balancePrintMean  
367    
368          LOGICAL fluidIsAir
369          LOGICAL fluidIsWater
370          LOGICAL usingPCoords
371          LOGICAL usingZCoords
372          LOGICAL useDynP_inEos_Zc
373        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
374        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid, rotateGrid
375        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
376        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
377        LOGICAL deepAtmosphere        LOGICAL deepAtmosphere
# Line 380  C     balancePrintMean:: print substract Line 387  C     balancePrintMean:: print substract
387        LOGICAL useCoriolis        LOGICAL useCoriolis
388        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
389        LOGICAL tempAdvection        LOGICAL tempAdvection
390          LOGICAL tempIsActiveTr
391        LOGICAL tempForcing        LOGICAL tempForcing
392        LOGICAL saltAdvection        LOGICAL saltAdvection
393          LOGICAL saltIsActiveTr
394        LOGICAL saltForcing        LOGICAL saltForcing
395          LOGICAL maskIniTemp
396          LOGICAL maskIniSalt
397          LOGICAL checkIniTemp
398          LOGICAL checkIniSalt
399        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
400        LOGICAL useFullLeith        LOGICAL useFullLeith
401        LOGICAL useStrainTensionVisc        LOGICAL useStrainTensionVisc
# Line 392  C     balancePrintMean:: print substract Line 405  C     balancePrintMean:: print substract
405        LOGICAL exactConserv        LOGICAL exactConserv
406        LOGICAL linFSConserveTr        LOGICAL linFSConserveTr
407        LOGICAL uniformLin_PhiSurf        LOGICAL uniformLin_PhiSurf
408          LOGICAL quasiHydrostatic
409          LOGICAL nonHydrostatic
410        LOGICAL use3Dsolver        LOGICAL use3Dsolver
411        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
412        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
# Line 407  C     balancePrintMean:: print substract Line 422  C     balancePrintMean:: print substract
422        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
423        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
424        LOGICAL useJamartMomAdv        LOGICAL useJamartMomAdv
       LOGICAL SadournyCoriolis  
425        LOGICAL upwindVorticity        LOGICAL upwindVorticity
426        LOGICAL highOrderVorticity        LOGICAL highOrderVorticity
427        LOGICAL useAbsVorticity        LOGICAL useAbsVorticity
# Line 421  C     balancePrintMean:: print substract Line 435  C     balancePrintMean:: print substract
435        LOGICAL useMultiDimAdvec        LOGICAL useMultiDimAdvec
436        LOGICAL momDissip_In_AB        LOGICAL momDissip_In_AB
437        LOGICAL doAB_onGtGs        LOGICAL doAB_onGtGs
438          LOGICAL balanceEmPmR
439          LOGICAL balanceQnet
440          LOGICAL balancePrintMean
441        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
442        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
443        LOGICAL doTr1ClimRelax        LOGICAL allowFreezing
444          LOGICAL useOldFreezing
445        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
       LOGICAL fluidIsAir  
       LOGICAL fluidIsWater  
       LOGICAL usingPCoords  
       LOGICAL usingZCoords  
       LOGICAL useDynP_inEos_Zc  
       LOGICAL nonHydrostatic  
       LOGICAL quasiHydrostatic  
446        LOGICAL globalFiles        LOGICAL globalFiles
447        LOGICAL useSingleCpuIO        LOGICAL useSingleCpuIO
448        LOGICAL allowFreezing        LOGICAL pickupStrictlyMatch
       LOGICAL useOldFreezing  
449        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
450        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
       LOGICAL dumpInitAndLast  
       LOGICAL debugMode  
451        LOGICAL pickup_read_mdsio, pickup_write_mdsio        LOGICAL pickup_read_mdsio, pickup_write_mdsio
452        LOGICAL pickup_write_immed        LOGICAL pickup_write_immed, writePickupAtEnd
453        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
454        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
455          LOGICAL dumpInitAndLast
456          LOGICAL debugMode
457        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
458    
       LOGICAL balanceEmPmR  
       LOGICAL balanceQnet  
       LOGICAL balancePrintMean  
   
459  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
460  C     cg2dTargetResidual  C     cg2dTargetResidual
461  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
# Line 483  C     rhoConst  :: Vertically constant r Line 489  C     rhoConst  :: Vertically constant r
489  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
490  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
491  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
492    C     rho1Ref   :: reference vertical profile for density
493  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
494  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
495  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
# Line 503  C     rUnit2mass :: units conversion fac Line 510  C     rUnit2mass :: units conversion fac
510  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].
511  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
512  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
513  C     phiMin    :: Latitude of southern most cell face.  C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
514  C     thetaMin  :: Longitude of western most cell face (this  C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
515  C                 is an "inert" parameter but it is included  C                :: parameter but it makes geographical references simple.)
516  C                 to make geographical references simple.)  C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
517  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).  C                :: most face (Lat-Lon grid).
518    C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
519  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
520  C     f0        :: Reference coriolis parameter ( 1/s )  C     f0         :: Reference coriolis parameter ( 1/s )
521  C                 ( Southern edge f for beta plane )  C                   ( Southern edge f for beta plane )
522  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta       :: df/dy ( s^-1.m^-1 )
523  C     omega     :: Angular velocity ( rad/s )  C     omega      :: Angular velocity ( rad/s )
524  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
525  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
526  C                 momentum laterally ( m^2/s )  C                   for vertical mixing of momentum ( units of r^2/s )
527  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  
528  C                   momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
529  C     viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
530  C                   coeff. for mixing of momentum laterally (non-dim)  C                   momentum laterally, no effect for hydrostatic
531    C                   model, defaults to viscAh if unset ( m^2/s )
532    C                   Not used if variable horiz. viscosity is used.
533    C     viscA4     :: Biharmonic viscosity coeff. for mixing of
534    C                   momentum laterally ( m^4/s )
535    C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
536    C                   momentum laterally, no effect for hydrostatic
537    C                   model, defaults to viscA4 if unset ( m^2/s )
538    C                   Not used if variable horiz. viscosity is used.
539    C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
540    C                   (act on Divergence part) ( m^2/s )
541    C     viscAhZ    :: Eddy viscosity coeff. for mixing of momentum laterally
542    C                   (act on Vorticity  part) ( m^2/s )
543    C     viscA4D    :: Biharmonic viscosity coeff. for mixing of momentum laterally
544    C                   (act on Divergence part) ( m^4/s )
545    C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
546    C                   (act on Vorticity  part) ( m^4/s )
547    C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
548    C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
549    C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
550    C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
551    C     viscC2smag   :: Smagorinsky non-dimensional viscosity factor (harmonic)
552    C     viscC4smag   :: Smagorinsky non-dimensional viscosity factor (biharmonic)
553    C     viscAhMax    :: Maximum eddy viscosity coeff. for mixing of
554    C                    momentum laterally ( m^2/s )
555    C     viscAhReMax  :: Maximum gridscale Reynolds number for eddy viscosity
556    C                     coeff. for mixing of momentum laterally (non-dim)
557    C     viscAhGrid   :: non-dimensional grid-size dependent viscosity
558  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
559  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
560  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max    :: Maximum biharmonic viscosity coeff. for mixing of
561  C                 momentum laterally ( m^4/s )  C                     momentum laterally ( m^4/s )
562  C     viscA4ReMax :: Maximum Gridscale Reynolds number for  C     viscA4ReMax  :: Maximum Gridscale Reynolds number for
563  C                  biharmonic viscosity coeff. momentum laterally (non-dim)  C                     biharmonic viscosity coeff. momentum laterally (non-dim)
564  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  
565  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
566  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))  
567  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
568  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
569  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
570  C                 for mixing of heat vertically ( units of r^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
571  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
572  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
573  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
574  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
575  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
576  C                 for mixing of salt vertically ( units of r^2/s ),  C                 for mixing of salt vertically ( units of r^2/s ),
577  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
578  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
579  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 624  C     mtFacMom      :: Metric terms trac Line 632  C     mtFacMom      :: Metric terms trac
632  C     cosPower      :: Power of cosine of latitude to multiply viscosity  C     cosPower      :: Power of cosine of latitude to multiply viscosity
633  C     cAdjFreq      :: Frequency of convective adjustment  C     cAdjFreq      :: Frequency of convective adjustment
634  C  C
635  C     taveFreq      :: Frequency with which time-averaged model state  C     taveFreq      :: Frequency with which time-averaged model state
636  C                      is written to post-processing files ( s ).  C                      is written to post-processing files ( s ).
637  C     tave_lastIter :: (for state variable only) fraction of the last time  C     tave_lastIter :: (for state variable only) fraction of the last time
638  C                      step (of each taveFreq period) put in the time average.  C                      step (of each taveFreq period) put in the time average.
639  C                      (fraction for 1rst iter = 1 - tave_lastIter)  C                      (fraction for 1rst iter = 1 - tave_lastIter)
640  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
641  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
# Line 639  C                          (note: extern Line 647  C                          (note: extern
647  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
648  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
649  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
650  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
651  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
652  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
653  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
654  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
655  C     hMixCrit    :: criteria for mixed-layer diagnostic  C     hMixCriteria:: criteria for mixed-layer diagnostic
656    C     dRhoSmall   :: parameter for mixed-layer diagnostic
657    C     hMixSmooth  :: Smoothing parameter for mixed-layer diag (default=0=no smoothing)
658  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
659  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
660  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
661  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
662  C                           (default=2: full drag ; =1: gives half-slip BC)  C                           (default=2: full drag ; =1: gives half-slip BC)
663  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
664  C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)  C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
# Line 658  C                           is to be rep Line 668  C                           is to be rep
668  C                           (affects myabs, mymin, mymax)  C                           (affects myabs, mymin, mymax)
669  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
670  C                      (i.e. allows convection at different Rayleigh numbers)  C                      (i.e. allows convection at different Rayleigh numbers)
671    C     phiEuler      :: Euler angle, rotation about original z-axis
672    C     thetaEuler    :: Euler angle, rotation about new x-axis
673    C     psiEuler      :: Euler angle, rotation about new z-axis
674        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
675       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
676       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
677       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
678       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
679       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & xgOrigin, ygOrigin, rSphere, recip_RSphere, f0, beta,
680       & viscAh, viscAhW, viscAhMax,       & viscAh, viscAhW, viscAhMax,
681       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
682       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
683       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
684       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
685       & viscA4, viscA4W,       & viscA4, viscA4W, viscA4Max,
686       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Grid, viscA4GridMax, viscA4GridMin,
687       & viscAhRemax, viscA4Remax,       & viscAhReMax, viscA4ReMax,
688       & viscC4leith, viscC4leithD, viscAr,       & viscC4leith, viscC4leithD, viscArNr,
689       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
690       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
691       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
# Line 683  C                      (i.e. allows conv Line 696  C                      (i.e. allows conv
696       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
697       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
698       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
699       & rhoConstFresh, tRef, sRef, phiRef, dBdrRef,       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
700       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
701       & baseTime, startTime, endTime,       & baseTime, startTime, endTime,
702       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
703       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
704       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
705       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
706       & tauThetaClimRelax, tauSaltClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
      & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,  
707       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
708       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
709       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
710       & ivdc_kappa, hMixCriteria, Ro_SeaLevel,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, Ro_SeaLevel,
711       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
712       & smoothAbsFuncRange,       & smoothAbsFuncRange,
713       & tCylIn, tCylOut       & tCylIn, tCylOut,
714         & phiEuler, thetaEuler, psiEuler
715    
716        _RL cg2dTargetResidual        _RL cg2dTargetResidual
717        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
# Line 714  C                      (i.e. allows conv Line 727  C                      (i.e. allows conv
727        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
728        _RL deltaTfreesurf        _RL deltaTfreesurf
729        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
730        _RL phiMin        _RL xgOrigin
731        _RL thetaMin        _RL ygOrigin
732        _RL rSphere        _RL rSphere
733        _RL recip_rSphere        _RL recip_rSphere
734        _RL f0        _RL f0
# Line 729  C                      (i.e. allows conv Line 742  C                      (i.e. allows conv
742        _RL hFacInf        _RL hFacInf
743        _RL hFacSup        _RL hFacSup
744        _RL beta        _RL beta
745          _RL viscArNr(Nr)
746        _RL viscAh        _RL viscAh
747        _RL viscAhW        _RL viscAhW
748        _RL viscAhD        _RL viscAhD
749        _RL viscAhZ        _RL viscAhZ
750        _RL viscAhMax        _RL viscAhMax
751        _RL viscAhReMax        _RL viscAhReMax
752        _RL viscAhGrid        _RL viscAhGrid, viscAhGridMax, viscAhGridMin
       _RL viscAhGridMax  
       _RL viscAhGridMin  
753        _RL viscC2leith        _RL viscC2leith
754        _RL viscC2leithD        _RL viscC2leithD
755        _RL viscC2smag        _RL viscC2smag
       _RL viscC4smag  
       _RL viscAr  
756        _RL viscA4        _RL viscA4
757        _RL viscA4W        _RL viscA4W
758        _RL viscA4D        _RL viscA4D
# Line 752  C                      (i.e. allows conv Line 762  C                      (i.e. allows conv
762        _RL viscA4Grid, viscA4GridMax, viscA4GridMin        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
763        _RL viscC4leith        _RL viscC4leith
764        _RL viscC4leithD        _RL viscC4leithD
765          _RL viscC4smag
766        _RL diffKhT        _RL diffKhT
767        _RL diffKrNrT(Nr)        _RL diffKrNrT(Nr)
768        _RL diffK4T        _RL diffK4T
# Line 778  C                      (i.e. allows conv Line 789  C                      (i.e. allows conv
789        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
790        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
791        _RL rhoConstFresh        _RL rhoConstFresh
792          _RL rho1Ref(Nr)
793        _RL tRef(Nr)        _RL tRef(Nr)
794        _RL sRef(Nr)        _RL sRef(Nr)
795        _RL phiRef(2*Nr+1)        _RL phiRef(2*Nr+1)
# Line 808  C                      (i.e. allows conv Line 820  C                      (i.e. allows conv
820        _RL rotationPeriod        _RL rotationPeriod
821        _RL tauThetaClimRelax        _RL tauThetaClimRelax
822        _RL tauSaltClimRelax        _RL tauSaltClimRelax
       _RL tauTr1ClimRelax  
       _RL lambdaTr1ClimRelax  
823        _RL latBandClimRelax        _RL latBandClimRelax
824        _RL externForcingCycle        _RL externForcingCycle
825        _RL externForcingPeriod        _RL externForcingPeriod
# Line 818  C                      (i.e. allows conv Line 828  C                      (i.e. allows conv
828        _RL salt_EvPrRn        _RL salt_EvPrRn
829        _RL ivdc_kappa        _RL ivdc_kappa
830        _RL hMixCriteria        _RL hMixCriteria
831          _RL dRhoSmall
832          _RL hMixSmooth
833        _RL Ro_SeaLevel        _RL Ro_SeaLevel
834        _RL sideDragFactor        _RL sideDragFactor
835        _RL bottomDragLinear        _RL bottomDragLinear
# Line 826  C                      (i.e. allows conv Line 838  C                      (i.e. allows conv
838        _RL nh_Am2        _RL nh_Am2
839        _RL tCylIn        _RL tCylIn
840        _RL tCylOut        _RL tCylOut
841          _RL phiEuler, thetaEuler, psiEuler
842    
843  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
844        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
# Line 841  C     atm_kappa :: kappa = R/Cp (R: cons Line 854  C     atm_kappa :: kappa = R/Cp (R: cons
854  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
855  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])
856  C     integr_GeoPot :: option to select the way we integrate the geopotential  C     integr_GeoPot :: option to select the way we integrate the geopotential
857  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
858  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
859  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
860        COMMON /PARM_ATM/        COMMON /PARM_ATM/
# Line 853  C             derived from the orography Line 866  C             derived from the orography
866        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
867    
868  C Logical flags for selecting packages  C Logical flags for selecting packages
869          LOGICAL useGAD
870          LOGICAL useOBCS
871          LOGICAL useSHAP_FILT
872          LOGICAL useZONAL_FILT
873        LOGICAL useOPPS        LOGICAL useOPPS
874        LOGICAL usePP81        LOGICAL usePP81
875        LOGICAL useMY82        LOGICAL useMY82
876        LOGICAL useGGL90        LOGICAL useGGL90
877        LOGICAL useKPP        LOGICAL useKPP
       LOGICAL useGAD  
878        LOGICAL useGMRedi        LOGICAL useGMRedi
879        LOGICAL useOBCS        LOGICAL useDOWN_SLOPE
       LOGICAL useAIM  
       LOGICAL useLand  
880        LOGICAL useCAL        LOGICAL useCAL
881        LOGICAL useEXF        LOGICAL useEXF
882          LOGICAL useBulkForce
883        LOGICAL useEBM        LOGICAL useEBM
884          LOGICAL useCheapAML
885        LOGICAL useGrdchk        LOGICAL useGrdchk
886        LOGICAL useECCO        LOGICAL useECCO
887        LOGICAL useSHAP_FILT        LOGICAL useSBO
       LOGICAL useZONAL_FILT  
888        LOGICAL useFLT        LOGICAL useFLT
889        LOGICAL usePTRACERS        LOGICAL usePTRACERS
890        LOGICAL useGCHEM        LOGICAL useGCHEM
891        LOGICAL useRBCS        LOGICAL useRBCS
892        LOGICAL useOffLine        LOGICAL useOffLine
893        LOGICAL useMATRIX        LOGICAL useMATRIX
       LOGICAL useSBO  
894        LOGICAL useSEAICE        LOGICAL useSEAICE
895          LOGICAL useSALT_PLUME
896        LOGICAL useShelfIce        LOGICAL useShelfIce
897        LOGICAL useThSIce        LOGICAL useThSIce
898        LOGICAL useATM2d        LOGICAL useATM2d
899        LOGICAL useBulkForce        LOGICAL useAIM
900        LOGICAL usefizhi        LOGICAL useLand
901        LOGICAL usegridalt        LOGICAL useFizhi
902          LOGICAL useGridAlt
903        LOGICAL useDiagnostics        LOGICAL useDiagnostics
       LOGICAL useMNC  
904        LOGICAL useREGRID        LOGICAL useREGRID
905          LOGICAL useLayers
906          LOGICAL useMNC
907        LOGICAL useRunClock        LOGICAL useRunClock
908        LOGICAL useEMBED_FILES        LOGICAL useEMBED_FILES
909        LOGICAL useMYPACKAGE        LOGICAL useMYPACKAGE
910        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
911         &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
912       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
913       &        useGAD, useGMRedi, useOBCS, useAIM, useLand,       &        useGMRedi, useDOWN_SLOPE,
914       &        useCAL, useEXF, useEBM, useGrdchk, useECCO,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
915       &        useSHAP_FILT, useZONAL_FILT, useFLT,       &        useGrdchk, useECCO, useSBO, useFLT,
916       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
917       &        useSBO, useSEAICE, useShelfIce,       &        useSEAICE, useSALT_PLUME, useShelfIce, useThSIce,
918       &        useThSIce, useATM2D, useBulkForce,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
919       &        usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID,       &        useDiagnostics, useREGRID, useLayers, useMNC,
920       &        useRunClock, useEMBED_FILES, useMYPACKAGE       &        useRunClock, useEMBED_FILES,
921         &        useMYPACKAGE
922  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
923  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
924  CEH3 ;;; End: ***  CEH3 ;;; End: ***

Legend:
Removed from v.1.205  
changed lines
  Added in v.1.230

  ViewVC Help
Powered by ViewVC 1.1.22