/[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.200 by dimitri, Wed Apr 11 00:00:47 2007 UTC revision 1.218 by jmc, Fri Jul 18 22:19:26 2008 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  )  
   
 C     Checkpoint data  
       INTEGER maxNoChkptLev  
       PARAMETER ( maxNoChkptLev = 2 )  
   
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     checkPtSuff :: List of checkpoint file suffices  C     buoyancyRelation :: Flag used to indicate which relation to use to
29    C                         get buoyancy.
30    C     eosType         :: choose the equation of state:
31    C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
32    C     pickupSuff      :: force to start from pickup files (even if nIter0=0)
33    C                        and read pickup files with this suffix (max 10 Char.)
34    C     mdsioLocalDir   :: read-write tiled file from/to this directory name
35    C                        (+ 4 digits Processor-Rank) instead of current dir.
36  C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)  C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
37  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
38  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
# Line 58  C     delXFile      :: File containing X Line 42  C     delXFile      :: File containing X
42  C     delYFile      :: File containing Y-spacing grid definition (1.D array)  C     delYFile      :: File containing Y-spacing grid definition (1.D array)
43  C     horizGridFile :: File containing horizontal-grid definition  C     horizGridFile :: File containing horizontal-grid definition
44  C                        (only when using curvilinear_grid)  C                        (only when using curvilinear_grid)
45  C     bathyFile   :: File containing bathymetry. If not defined bathymetry  C     bathyFile       :: File containing bathymetry. If not defined bathymetry
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).
49  C     shelfIceFile:: File containing the topography of the shelfice draught  C     shelfIceFile    :: File containing the topography of the shelfice draught
50  C                    (unit=m)  C                        (unit=m)
51  C     hydrogThetaFile :: File containing initial hydrographic data for potential  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
52  C                       temperature.  C                        for potential temperature.
53  C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
54    C                        for salinity.
55  C     diffKrFile      :: File containing 3D specification of vertical diffusivity  C     diffKrFile      :: File containing 3D specification of vertical diffusivity
56  C     zonalWindFile   :: File containing zonal wind data  C     zonalWindFile   :: File containing zonal wind data
57  C     meridWindFile   :: File containing meridional wind data  C     meridWindFile   :: File containing meridional wind data
58  C     thetaClimFile   :: File containing theta climataology used  C     thetaClimFile   :: File containing surface theta climataology used
59  C                       in relaxation term -lambda(theta-theta*)  C                       in relaxation term -lambda(theta-theta*)
60  C     saltClimFile    :: File containing salt climataology used  C     saltClimFile    :: File containing surface salt climataology used
61  C                       in relaxation term -lambda(salt-salt*)  C                       in relaxation term -lambda(salt-salt*)
62  C     surfQfile       :: File containing surface heat flux, excluding SW  C     surfQfile       :: File containing surface heat flux, excluding SW
63  C                        (old version, kept for backward compatibility)  C                        (old version, kept for backward compatibility)
# Line 80  C     surfQnetFile    :: File containing Line 65  C     surfQnetFile    :: File containing
65  C     surfQswFile     :: File containing surface shortwave radiation  C     surfQswFile     :: File containing surface shortwave radiation
66  C     dQdTfile        :: File containing thermal relaxation coefficient  C     dQdTfile        :: File containing thermal relaxation coefficient
67  C     EmPmRfile       :: File containing surface fresh water flux  C     EmPmRfile       :: File containing surface fresh water flux
68    C           NOTE: for backward compatibility EmPmRfile is specified in
69    C                 m/s when using external_fields_load.F.  It is converted
70    C                 to kg/m2/s by multiplying by rhoConstFresh.
71  C     saltFluxFile    :: File containing surface salt flux  C     saltFluxFile    :: File containing surface salt flux
72  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
73  C     eddyTauxFile    :: File containing zonal Eddy stress data  C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data
74  C     eddyTauyFile    :: File containing meridional Eddy stress data  C     eddyPsiYFile    :: File containing meridional Eddy streamfunction data
 C     buoyancyRelation :: Flag used to indicate which relation to use to  
 C                        get buoyancy.  
 C     eosType         :: choose the equation of state:  
 C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS  
75  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
76        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/
77         &                buoyancyRelation, eosType,
78         &                pickupSuff, mdsioLocalDir,
79       &                tRefFile, sRefFile, rhoRefFile,       &                tRefFile, sRefFile, rhoRefFile,
80       &                delRFile, delRcFile,       &                delRFile, delRcFile,
81       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
82       &                bathyFile, topoFile, shelfIceFile,       &                bathyFile, topoFile, shelfIceFile,
83       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
84       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
85       &                saltClimFile, buoyancyRelation,       &                saltClimFile,
86       &                EmPmRfile, saltFluxFile,       &                EmPmRfile, saltFluxFile,
87       &                surfQfile, surfQnetFile, surfQswFile,       &                surfQfile, surfQnetFile, surfQswFile,
88       &                lambdaThetaFile, lambdaSaltFile,       &                lambdaThetaFile, lambdaSaltFile,
89       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
90       &                dQdTfile, ploadFile,       &                dQdTfile, ploadFile,
91       &                eddyTauxFile, eddyTauyFile,       &                eddyPsiXFile, eddyPsiYFile,
      &                eosType, pickupSuff,  
      &                mdsioLocalDir,  
92       &                the_run_name       &                the_run_name
93        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
94          CHARACTER*(6)  eosType
95          CHARACTER*(10) pickupSuff
96          CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
97        CHARACTER*(MAX_LEN_FNAM) tRefFile        CHARACTER*(MAX_LEN_FNAM) tRefFile
98        CHARACTER*(MAX_LEN_FNAM) sRefFile        CHARACTER*(MAX_LEN_FNAM) sRefFile
99        CHARACTER*(MAX_LEN_FNAM) rhoRefFile        CHARACTER*(MAX_LEN_FNAM) rhoRefFile
# Line 127  C     the_run_name    :: string identify Line 114  C     the_run_name    :: string identify
114        CHARACTER*(MAX_LEN_FNAM) surfQswFile        CHARACTER*(MAX_LEN_FNAM) surfQswFile
115        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
116        CHARACTER*(MAX_LEN_FNAM) saltFluxFile        CHARACTER*(MAX_LEN_FNAM) saltFluxFile
       CHARACTER*(MAX_LEN_FNAM) buoyancyRelation  
117        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
118        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
119        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
120        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
121        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) ploadFile
122        CHARACTER*(MAX_LEN_FNAM) eddyTauxFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile
123        CHARACTER*(MAX_LEN_FNAM) eddyTauyFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile
124        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
125        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
       CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir  
126        CHARACTER*(MAX_LEN_PREC/2) the_run_name        CHARACTER*(MAX_LEN_PREC/2) the_run_name
       CHARACTER*(6) eosType  
       CHARACTER*(10) pickupSuff  
127    
128  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
129  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
# Line 155  C     cg3dChkResFreq      :: Frequency w Line 138  C     cg3dChkResFreq      :: Frequency w
138  C                           in con. grad solver.  C                           in con. grad solver.
139  C     nIter0              :: Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
140  C     nTimeSteps          :: Number of timesteps to execute  C     nTimeSteps          :: Number of timesteps to execute
 C     numStepsPerPickup   :: For offline setup. Frequency of pickup  
 C                           of flow fields.  
141  C     writeStatePrec      :: Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
142  C     writeBinaryPrec     :: Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
143  C     readBinaryPrec      :: Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
 C     nCheckLev           :: Holds current checkpoint level  
144  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
145  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
146  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
# Line 174  C     tempVertAdvScheme   :: Temp. Vert. Line 154  C     tempVertAdvScheme   :: Temp. Vert.
154  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
155  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
156  C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)  C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)
157    C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)
158    C     monitorSelect       :: select group of variables to monitor
159    C                            =1 : dynvars ; =2 : + vort ; =3 : + surface
160  C     debugLevel          :: debug level selector: higher -> more writing  C     debugLevel          :: debug level selector: higher -> more writing
161    
162        COMMON /PARM_I/        COMMON /PARM_I/
# Line 182  C     debugLevel          :: debug level Line 165  C     debugLevel          :: debug level
165       &        cg3dMaxIters,       &        cg3dMaxIters,
166       &        cg3dChkResFreq,       &        cg3dChkResFreq,
167       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
168       &        numStepsPerPickup,       &        writeStatePrec,
      &        writeStatePrec, nCheckLev,  
169       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
170       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
171       &        momForcingOutAB, tracForcingOutAB,       &        momForcingOutAB, tracForcingOutAB,
172       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
173       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
174       &        selectKEscheme,       &        selectKEscheme, selectVortScheme,
175       &        debugLevel       &        monitorSelect, debugLevel
176        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
177        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
178        INTEGER cg2dPreCondFreq        INTEGER cg2dPreCondFreq
# Line 199  C     debugLevel          :: debug level Line 181  C     debugLevel          :: debug level
181        INTEGER nIter0        INTEGER nIter0
182        INTEGER nTimeSteps        INTEGER nTimeSteps
183        INTEGER nEndIter        INTEGER nEndIter
       INTEGER numStepsPerPickup  
184        INTEGER writeStatePrec        INTEGER writeStatePrec
185        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
186        INTEGER readBinaryPrec        INTEGER readBinaryPrec
       INTEGER nCheckLev  
187        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
188        INTEGER select_rStar        INTEGER select_rStar
189        INTEGER momForcingOutAB, tracForcingOutAB        INTEGER momForcingOutAB, tracForcingOutAB
190        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
191        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
192        INTEGER selectKEscheme        INTEGER selectKEscheme
193          INTEGER selectVortScheme
194          INTEGER monitorSelect
195        INTEGER debugLevel        INTEGER debugLevel
196    
 C  
       INTEGER debLevZero  
       PARAMETER(debLevZero=0)  
       INTEGER debLevA  
       PARAMETER(debLevA=1)  
       INTEGER debLevB  
       PARAMETER(debLevB=2)  
   
197  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
198    C- Coordinate + Grid params:
199    C     fluidIsAir       :: Set to indicate that the fluid major constituent
200    C                        is air
201    C     fluidIsWater     :: Set to indicate that the fluid major constituent
202    C                        is water
203    C     usingPCoords     :: Set to indicate that we are working in a pressure
204    C                        type coordinate (p or p*).
205    C     usingZCoords     :: Set to indicate that we are working in a height
206    C                        type coordinate (z or z*)
207    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
208    C                         this requires specific code for restart & exchange
209  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
210  C                          coordinate frame.  C                          coordinate frame.
211  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
212  C                               spherical polar frame.  C                               spherical polar frame.
213  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     rotateGrid      :: rotate grid coordinates to geographical coordinates
214    C                        according to Euler angles phiEuler, thetaEuler, psiEuler
215  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
216    C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
217  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
218  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
219    C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
220    C- Momentum params:
221    C     no_slip_sides  :: Impose "no-slip" at lateral boundaries.
222  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
223    C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
224    C                       on irregular grids)
225    C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
226    C     useAreaViscLength :: Set to true to use old scaling for viscous lengths,
227    C                          e.g., L2=Raz.  May be preferable for cube sphere.
228  C     momViscosity  :: Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
229  C     momAdvection  :: Flag which turns advection of momentum on and off.  C     momAdvection  :: Flag which turns advection of momentum on and off.
230  C     momForcing    :: Flag which turns external forcing of momentum on  C     momForcing    :: Flag which turns external forcing of momentum on
231  C                     and off.  C                      and off.
232  C     momPressureForcing :: Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
233  C                          on and off.  C                          on and off.
234  C     metricTerms   :: Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
235  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
236  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
237  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  
238  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
239  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
240  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  
241  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
242  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
243    C                                (default = F = use mom_fluxform package)
244    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986)
245  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  
246  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
247  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)  
248  C     useAbsVorticity :: work with f+zeta in Coriolis terms  C     useAbsVorticity :: work with f+zeta in Coriolis terms
249    C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
250    C     momStepping    :: Turns momentum equation time-stepping off
251    C- Temp. & Salt params:
252    C     tempStepping   :: Turns temperature equation time-stepping off
253    C     saltStepping   :: Turns salinity equation time-stepping off
254    C     tempAdvection  :: Flag which turns advection of temperature on and off.
255    C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
256    C     tempForcing    :: Flag which turns external forcing of temperature on
257    C                       and off.
258    C     saltAdvection  :: Flag which turns advection of salinity on and off.
259    C     saltIsActiveTr :: Salinity  is a dynamically active tracer
260    C     saltForcing    :: Flag which turns external forcing of salinity on
261    C                       and off.
262    C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
263    C                         as a real Fresh Water (=> changes the Sea Level)
264    C                         if F, converts P+R-E to salt flux (no SL effect)
265    C- Time-stepping params:
266    C     rigidLid            :: Set to true to use rigid lid
267    C     implicitFreeSurface :: Set to true to use implicit free surface
268    C     exactConserv        :: Set to true to conserve exactly the total Volume
269    C     linFSConserveTr     :: Set to true to correct source/sink of tracer
270    C                            at the surface due to Linear Free Surface
271    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
272    C                            linear relation Phi_surf = Bo_surf*eta
273    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
274    C     nonHydrostatic   :: Using non-hydrostatic algorithm
275    C     use3Dsolver      :: set to true to use 3-D pressure solver
276    C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
277    C     staggerTimeStep   :: enable a Stagger time stepping U,V (& W) then T,S
278  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
279  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
280  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
# Line 291  C     momDissip_In_AB   :: if False, put Line 286  C     momDissip_In_AB   :: if False, put
286  C                          out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
287  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
288  C                          apply AB on tracer tendencies (rather than on Tracer)  C                          apply AB on tracer tendencies (rather than on Tracer)
289  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C- Other forcing params -
290  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from  C     balanceEmPmR    :: substract global mean of EmPmR at every time step
291  C                           before checkpoint-54a, Jul 06, 2004.  C     balanceQnet     :: substract global mean of Qnet at every time step
292    C     balancePrintMean:: print substracted global means to STDOUT
293  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
294  C                        climatology is required.  C                        climatology is required.
295  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
296  C                        climatology is required.  C                        climatology is required.
297    C     allowFreezing  :: Allows surface water to freeze and form ice
298    C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
299  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
300  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  
301  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
302  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
303  C                       slow (f77) or does not work (f90).  When  C                       slow (f77) or does not work (f90).  When
304  C                       useSingleCpuIO is set, mdsio_writefield.F  C                       useSingleCpuIO is set, mdsio_writefield.F
305  C                       outputs from master mpi process only.  C                       outputs from master mpi process only.
306  C     allowFreezing  :: Allows surface water to freeze and form ice  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
307  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
308    C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
309    C                           before checkpoint-54a, Jul 06, 2004.
310  C     pickup_write_mdsio :: use mdsio to write pickups  C     pickup_write_mdsio :: use mdsio to write pickups
311  C     pickup_read_mdsio  :: use mdsio to read  pickups  C     pickup_read_mdsio  :: use mdsio to read  pickups
312  C     pickup_write_immed :: echo the pickup immediately (for conversion)  C     pickup_write_immed :: echo the pickup immediately (for conversion)
313    C     writePickupAtEnd   :: write pickup at the last timestep
314  C     timeave_mdsio      :: use mdsio for timeave output  C     timeave_mdsio      :: use mdsio for timeave output
315  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
316  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
317  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
318  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  
319    
320        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/
321         & fluidIsAir, fluidIsWater,
322         & usingPCoords, usingZCoords, useDynP_inEos_Zc,
323         & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
324       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
325       & deepAtmosphere, setInterFDr, setCenterDr,       & deepAtmosphere, setInterFDr, setCenterDr,
326       & no_slip_sides,no_slip_bottom,       & no_slip_sides, no_slip_bottom,
327       & momViscosity, momAdvection, momForcing, useCoriolis,       & useFullLeith, useStrainTensionVisc, useAreaViscLength,
328       & momPressureForcing, vectorInvariantMomentum,       & momViscosity, momAdvection, momForcing,
329       & tempAdvection, tempForcing,       & momPressureForcing, metricTerms, useNHMTerms,
330       & saltAdvection, saltForcing,       & useCoriolis, use3dCoriolis,
331         & useConstantF, useBetaPlaneF, useSphereF,
332         & useCDscheme, vectorInvariantMomentum,
333         & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
334         & upwindVorticity, highOrderVorticity,
335         & useAbsVorticity, upwindShear,
336         & momStepping, tempStepping, saltStepping,
337         & tempAdvection, tempIsActiveTr, tempForcing,
338         & saltAdvection, saltIsActiveTr, saltForcing,
339       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
      & useFullLeith, useStrainTensionVisc,  
      & useAreaViscLength,  
340       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
341       & uniformLin_PhiSurf,       & uniformLin_PhiSurf,
342         & quasiHydrostatic, nonHydrostatic,
343       & use3Dsolver, implicitIntGravWave, staggerTimeStep,       & use3Dsolver, implicitIntGravWave, staggerTimeStep,
      & momStepping, tempStepping, saltStepping,  
      & metricTerms, useNHMTerms,  
      & useConstantF, useBetaPlaneF, useSphereF, use3dCoriolis,  
      & useCDscheme,  
      & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,  
      & SadournyCoriolis, upwindVorticity, highOrderVorticity,  
      & useAbsVorticity, upwindShear,  
344       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
345       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
346       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
347       & momDissip_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
348       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & balanceEmPmR, balanceQnet, balancePrintMean,
349       & periodicExternalForcing,       & doThetaClimRelax, doSaltClimRelax,
      & fluidIsAir, fluidIsWater,  
      & usingPCoords, usingZCoords, useDynP_inEos_Zc,  
      & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,  
350       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
351       & usePickupBeforeC54, startFromPickupAB2,       & periodicExternalForcing,
352         & globalFiles, useSingleCpuIO,
353         & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
354       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
355         & writePickupAtEnd,
356       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
357       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast, debugMode,
358       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & inAdMode, inAdTrue, inAdFalse, inAdExact
      & balanceEmPmR, balanceQnet, balancePrintMean  
359    
360          LOGICAL fluidIsAir
361          LOGICAL fluidIsWater
362          LOGICAL usingPCoords
363          LOGICAL usingZCoords
364          LOGICAL useDynP_inEos_Zc
365        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
366        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid, rotateGrid
367        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
368        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
369        LOGICAL deepAtmosphere        LOGICAL deepAtmosphere
# Line 387  C     balancePrintMean:: print substract Line 379  C     balancePrintMean:: print substract
379        LOGICAL useCoriolis        LOGICAL useCoriolis
380        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
381        LOGICAL tempAdvection        LOGICAL tempAdvection
382          LOGICAL tempIsActiveTr
383        LOGICAL tempForcing        LOGICAL tempForcing
384        LOGICAL saltAdvection        LOGICAL saltAdvection
385          LOGICAL saltIsActiveTr
386        LOGICAL saltForcing        LOGICAL saltForcing
387        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
388        LOGICAL useFullLeith        LOGICAL useFullLeith
# Line 399  C     balancePrintMean:: print substract Line 393  C     balancePrintMean:: print substract
393        LOGICAL exactConserv        LOGICAL exactConserv
394        LOGICAL linFSConserveTr        LOGICAL linFSConserveTr
395        LOGICAL uniformLin_PhiSurf        LOGICAL uniformLin_PhiSurf
396          LOGICAL quasiHydrostatic
397          LOGICAL nonHydrostatic
398        LOGICAL use3Dsolver        LOGICAL use3Dsolver
399        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
400        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
# Line 414  C     balancePrintMean:: print substract Line 410  C     balancePrintMean:: print substract
410        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
411        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
412        LOGICAL useJamartMomAdv        LOGICAL useJamartMomAdv
       LOGICAL SadournyCoriolis  
413        LOGICAL upwindVorticity        LOGICAL upwindVorticity
414        LOGICAL highOrderVorticity        LOGICAL highOrderVorticity
415        LOGICAL useAbsVorticity        LOGICAL useAbsVorticity
# Line 428  C     balancePrintMean:: print substract Line 423  C     balancePrintMean:: print substract
423        LOGICAL useMultiDimAdvec        LOGICAL useMultiDimAdvec
424        LOGICAL momDissip_In_AB        LOGICAL momDissip_In_AB
425        LOGICAL doAB_onGtGs        LOGICAL doAB_onGtGs
426          LOGICAL balanceEmPmR
427          LOGICAL balanceQnet
428          LOGICAL balancePrintMean
429        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
430        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
431        LOGICAL doTr1ClimRelax        LOGICAL allowFreezing
432          LOGICAL useOldFreezing
433        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
       LOGICAL fluidIsAir  
       LOGICAL fluidIsWater  
       LOGICAL usingPCoords  
       LOGICAL usingZCoords  
       LOGICAL useDynP_inEos_Zc  
       LOGICAL nonHydrostatic  
       LOGICAL quasiHydrostatic  
434        LOGICAL globalFiles        LOGICAL globalFiles
435        LOGICAL useSingleCpuIO        LOGICAL useSingleCpuIO
436        LOGICAL allowFreezing        LOGICAL pickupStrictlyMatch
       LOGICAL useOldFreezing  
437        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
438        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
       LOGICAL dumpInitAndLast  
       LOGICAL debugMode  
439        LOGICAL pickup_read_mdsio, pickup_write_mdsio        LOGICAL pickup_read_mdsio, pickup_write_mdsio
440        LOGICAL pickup_write_immed        LOGICAL pickup_write_immed, writePickupAtEnd
441        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
442        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
443          LOGICAL dumpInitAndLast
444          LOGICAL debugMode
445        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
446    
       LOGICAL balanceEmPmR  
       LOGICAL balanceQnet  
       LOGICAL balancePrintMean  
   
447  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
448  C     cg2dTargetResidual  C     cg2dTargetResidual
449  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
# Line 502  C                :: z-coord: = 1 ; p-coo Line 489  C                :: z-coord: = 1 ; p-coo
489  C     wUnit2rVel :: units conversion factor (Non-Hydrostatic code),  C     wUnit2rVel :: units conversion factor (Non-Hydrostatic code),
490  C                :: from vertical velocity [m/s] to r-coordinate vertical velocity.  C                :: from vertical velocity [m/s] to r-coordinate vertical velocity.
491  C                :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel  C                :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel
492    C     mass2rUnit :: units conversion factor (surface forcing),
493    C                :: from mass per unit area [kg/m2] to vertical r-coordinate unit.
494    C                :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ;
495    C                :: p-coord: = gravity    ( [kg/m2] *  g = [Pa] ) ;
496    C     rUnit2mass :: units conversion factor (surface forcing),
497    C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
498    C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
499    C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
500  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
501  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
502  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
# Line 513  C                 ( Southern edge f for Line 508  C                 ( Southern edge f for
508  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
509  C     omega     :: Angular velocity ( rad/s )  C     omega     :: Angular velocity ( rad/s )
510  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
511    C     viscAr    :: Eddy viscosity coeff. for mixing of
512    C                 momentum vertically ( units of r^2/s )
513  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
514  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
515  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
516  C                 momentum laterally, no effect for hydrostatic  C                 momentum laterally, no effect for hydrostatic
517  C                 model, defaults to viscAh if unset ( m^2/s )  C                 model, defaults to viscAh if unset ( m^2/s )
518  C                 Not used if variable horiz. viscosity is used.  C                 Not used if variable horiz. viscosity is used.
 C     viscAr    :: Eddy viscosity coeff. for mixing of  
 C                 momentum vertically ( units of r^2/s )  
519  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
520  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
521  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical
# Line 535  C     viscA4D   :: Biharmonic viscosity Line 530  C     viscA4D   :: Biharmonic viscosity
530  C                  (act on Divergence part) ( m^4/s )  C                  (act on Divergence part) ( m^4/s )
531  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
532  C                  (act on Vorticity  part) ( m^4/s )  C                  (act on Vorticity  part) ( m^4/s )
533  C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
534  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
535  C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor (harmonic)  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
536  C     viscC4smag  :: Smagorinsky non-dimensional viscosity factor (biharmonic)  C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
537  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  C     viscC2smag   :: Smagorinsky non-dimensional viscosity factor (harmonic)
538  C                   momentum laterally ( m^2/s )  C     viscC4smag   :: Smagorinsky non-dimensional viscosity factor (biharmonic)
539  C     viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity  C     viscAhMax    :: Maximum eddy viscosity coeff. for mixing of
540  C                   coeff. for mixing of momentum laterally (non-dim)  C                    momentum laterally ( m^2/s )
541    C     viscAhReMax  :: Maximum gridscale Reynolds number for eddy viscosity
542    C                     coeff. for mixing of momentum laterally (non-dim)
543    C     viscAhGrid   :: non-dimensional grid-size dependent viscosity
544  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
545  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
546  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max    :: Maximum biharmonic viscosity coeff. for mixing of
547  C                 momentum laterally ( m^4/s )  C                     momentum laterally ( m^4/s )
548  C     viscA4ReMax :: Maximum Gridscale Reynolds number for  C     viscA4ReMax  :: Maximum Gridscale Reynolds number for
549  C                  biharmonic viscosity coeff. momentum laterally (non-dim)  C                     biharmonic viscosity coeff. momentum laterally (non-dim)
550  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  
551  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
552  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))  
553  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
554  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
555  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
556  C                 for mixing of heat vertically ( units of r^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
557  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
558  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
559  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
560  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
561  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
562  C                 for mixing of salt vertically ( units of r^2/s ),  C                 for mixing of salt vertically ( units of r^2/s ),
563  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
564  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
565  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
 C     diffKrBLEQsurf :: same as above at Equator  
566  C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979  C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
 C     diffKrBLEQdeep :: same as above at Equator  
567  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
 C     diffKrBLEQscl  :: same as above at Equator  
568  C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979  C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
569  C     diffKrBLEQHo   :: same as above at Equator  C     BL79LatVary    :: polarwise of this latitude diffKrBL79 is applied with
570  C     KbryanLewisLatTransition :: polarwise of this latitude diffKrBL79 is  C                       gradual transition to diffKrBLEQ towards Equator
571  C               applied with gradual transition to diffKrBLEQ towards Equator  C     diffKrBLEQsurf :: same as diffKrBL79surf but at Equator
572    C     diffKrBLEQdeep :: same as diffKrBL79deep but at Equator
573    C     diffKrBLEQscl  :: same as diffKrBL79scl but at Equator
574    C     diffKrBLEQHo   :: same as diffKrBL79Ho but at Equator
575  C     deltaT    :: Default timestep ( s )  C     deltaT    :: Default timestep ( s )
576  C     deltaTClock  :: Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
577  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
# Line 624  C     mtFacMom      :: Metric terms trac Line 618  C     mtFacMom      :: Metric terms trac
618  C     cosPower      :: Power of cosine of latitude to multiply viscosity  C     cosPower      :: Power of cosine of latitude to multiply viscosity
619  C     cAdjFreq      :: Frequency of convective adjustment  C     cAdjFreq      :: Frequency of convective adjustment
620  C  C
621  C     taveFreq      :: Frequency with which time-averaged model state  C     taveFreq      :: Frequency with which time-averaged model state
622  C                      is written to post-processing files ( s ).  C                      is written to post-processing files ( s ).
623  C     tave_lastIter :: (for state variable only) fraction of the last time  C     tave_lastIter :: (for state variable only) fraction of the last time
624  C                      step (of each taveFreq period) put in the time average.  C                      step (of each taveFreq period) put in the time average.
625  C                      (fraction for 1rst iter = 1 - tave_lastIter)  C                      (fraction for 1rst iter = 1 - tave_lastIter)
626  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
627  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
# Line 639  C                          (note: extern Line 633  C                          (note: extern
633  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
634  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
635  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
636  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
637  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
638  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
639  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
640  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
641  C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.  C     hMixCrit    :: criteria for mixed-layer diagnostic
642  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
643  C                          ( g*rho if horiz in m and vertical in Pa ).  C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
644  C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
645  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
 C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)  
646  C                           (default=2: full drag ; =1: gives half-slip BC)  C                           (default=2: full drag ; =1: gives half-slip BC)
647  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
648  C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)  C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
# Line 659  C                           is to be rep Line 652  C                           is to be rep
652  C                           (affects myabs, mymin, mymax)  C                           (affects myabs, mymin, mymax)
653  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
654  C                      (i.e. allows convection at different Rayleigh numbers)  C                      (i.e. allows convection at different Rayleigh numbers)
655    C     phiEuler      :: Euler angle, rotation about original z-axis
656    C     thetaEuler    :: Euler angle, rotation about new x-axis
657    C     psiEuler      :: Euler angle, rotation about new z-axis
658        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
659       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
660       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
# Line 670  C                      (i.e. allows conv Line 666  C                      (i.e. allows conv
666       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
667       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
668       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
669       & viscA4, viscA4W,       & viscA4, viscA4W, viscA4Max,
670       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Grid, viscA4GridMax, viscA4GridMin,
671       & viscAhRemax, viscA4Remax,       & viscAhReMax, viscA4ReMax,
672       & viscC4leith, viscC4leithD, viscAr,       & viscC4leith, viscC4leithD, viscAr,
673       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
674       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
675       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
676         & BL79LatVary,
677       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
      & KbryanLewisLatTransition,  
678       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
679       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
680       & gravity, recip_Gravity, gBaro,       & gravity, recip_gravity, gBaro,
681       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
682       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
683       & rhoConstFresh, convertEmP2rUnit, tRef, sRef, phiRef, dBdrRef,       & rhoConstFresh, tRef, sRef, phiRef, dBdrRef,
684       & rVel2wUnit, wUnit2rVel,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
685       & baseTime, startTime, endTime,       & baseTime, startTime, endTime,
686       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
687       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
688       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
689       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
690       & tauThetaClimRelax, tauSaltClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
      & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,  
691       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
692       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
693       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
694       & horiVertRatio, recip_horiVertRatio,       & ivdc_kappa, hMixCriteria, Ro_SeaLevel,
      & ivdc_kappa, Ro_SeaLevel,  
695       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
696       & smoothAbsFuncRange,       & smoothAbsFuncRange,
697       & tCylIn, tCylOut       & tCylIn, tCylOut,
698         & phiEuler, thetaEuler, psiEuler
699    
700        _RL cg2dTargetResidual        _RL cg2dTargetResidual
701        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
# Line 731  C                      (i.e. allows conv Line 726  C                      (i.e. allows conv
726        _RL hFacInf        _RL hFacInf
727        _RL hFacSup        _RL hFacSup
728        _RL beta        _RL beta
729          _RL viscAr
730        _RL viscAh        _RL viscAh
731        _RL viscAhW        _RL viscAhW
732        _RL viscAhD        _RL viscAhD
733        _RL viscAhZ        _RL viscAhZ
734        _RL viscAhMax        _RL viscAhMax
735        _RL viscAhReMax        _RL viscAhReMax
736        _RL viscAhGrid        _RL viscAhGrid, viscAhGridMax, viscAhGridMin
       _RL viscAhGridMax  
       _RL viscAhGridMin  
737        _RL viscC2leith        _RL viscC2leith
738        _RL viscC2leithD        _RL viscC2leithD
739        _RL viscC2smag        _RL viscC2smag
       _RL viscC4smag  
       _RL viscAr  
740        _RL viscA4        _RL viscA4
741        _RL viscA4W        _RL viscA4W
742        _RL viscA4D        _RL viscA4D
# Line 754  C                      (i.e. allows conv Line 746  C                      (i.e. allows conv
746        _RL viscA4Grid, viscA4GridMax, viscA4GridMin        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
747        _RL viscC4leith        _RL viscC4leith
748        _RL viscC4leithD        _RL viscC4leithD
749          _RL viscC4smag
750        _RL diffKhT        _RL diffKhT
751        _RL diffKrNrT(Nr)        _RL diffKrNrT(Nr)
752        _RL diffK4T        _RL diffK4T
# Line 764  C                      (i.e. allows conv Line 757  C                      (i.e. allows conv
757        _RL diffKrBL79deep        _RL diffKrBL79deep
758        _RL diffKrBL79scl        _RL diffKrBL79scl
759        _RL diffKrBL79Ho        _RL diffKrBL79Ho
760          _RL BL79LatVary
761        _RL diffKrBLEQsurf        _RL diffKrBLEQsurf
762        _RL diffKrBLEQdeep        _RL diffKrBLEQdeep
763        _RL diffKrBLEQscl        _RL diffKrBLEQscl
764        _RL diffKrBLEQHo        _RL diffKrBLEQHo
       _RL KbryanLewisLatTransition  
765        _RL delt        _RL delt
766        _RL tauCD        _RL tauCD
767        _RL rCD        _RL rCD
# Line 780  C                      (i.e. allows conv Line 773  C                      (i.e. allows conv
773        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
774        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
775        _RL rhoConstFresh        _RL rhoConstFresh
       _RL convertEmP2rUnit  
776        _RL tRef(Nr)        _RL tRef(Nr)
777        _RL sRef(Nr)        _RL sRef(Nr)
778        _RL phiRef(2*Nr+1)        _RL phiRef(2*Nr+1)
779        _RL dBdrRef(Nr)        _RL dBdrRef(Nr)
780        _RL rVel2wUnit(Nr+1), wUnit2rVel(Nr+1)        _RL rVel2wUnit(Nr+1), wUnit2rVel(Nr+1)
781          _RL mass2rUnit, rUnit2mass
782        _RL baseTime        _RL baseTime
783        _RL startTime        _RL startTime
784        _RL endTime        _RL endTime
# Line 810  C                      (i.e. allows conv Line 803  C                      (i.e. allows conv
803        _RL rotationPeriod        _RL rotationPeriod
804        _RL tauThetaClimRelax        _RL tauThetaClimRelax
805        _RL tauSaltClimRelax        _RL tauSaltClimRelax
       _RL tauTr1ClimRelax  
       _RL lambdaTr1ClimRelax  
806        _RL latBandClimRelax        _RL latBandClimRelax
807        _RL externForcingCycle        _RL externForcingCycle
808        _RL externForcingPeriod        _RL externForcingPeriod
809        _RL convertFW2Salt        _RL convertFW2Salt
810        _RL temp_EvPrRn        _RL temp_EvPrRn
811        _RL salt_EvPrRn        _RL salt_EvPrRn
       _RL horiVertRatio  
       _RL recip_horiVertRatio  
812        _RL ivdc_kappa        _RL ivdc_kappa
813          _RL hMixCriteria
814        _RL Ro_SeaLevel        _RL Ro_SeaLevel
815        _RL sideDragFactor        _RL sideDragFactor
816        _RL bottomDragLinear        _RL bottomDragLinear
# Line 829  C                      (i.e. allows conv Line 819  C                      (i.e. allows conv
819        _RL nh_Am2        _RL nh_Am2
820        _RL tCylIn        _RL tCylIn
821        _RL tCylOut        _RL tCylOut
822          _RL phiEuler, thetaEuler, psiEuler
823    
824  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
825        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
# Line 844  C     atm_kappa :: kappa = R/Cp (R: cons Line 835  C     atm_kappa :: kappa = R/Cp (R: cons
835  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
836  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])
837  C     integr_GeoPot :: option to select the way we integrate the geopotential  C     integr_GeoPot :: option to select the way we integrate the geopotential
838  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
839  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
840  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
841        COMMON /PARM_ATM/        COMMON /PARM_ATM/
# Line 893  C Logical flags for selecting packages Line 884  C Logical flags for selecting packages
884        LOGICAL useRunClock        LOGICAL useRunClock
885        LOGICAL useEMBED_FILES        LOGICAL useEMBED_FILES
886        LOGICAL useMYPACKAGE        LOGICAL useMYPACKAGE
887          LOGICAL useSALT_PLUME
888        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
889       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
890       &        useGAD, useGMRedi, useOBCS, useAIM, useLand,       &        useGAD, useGMRedi, useOBCS, useAIM, useLand,
# Line 902  C Logical flags for selecting packages Line 894  C Logical flags for selecting packages
894       &        useSBO, useSEAICE, useShelfIce,       &        useSBO, useSEAICE, useShelfIce,
895       &        useThSIce, useATM2D, useBulkForce,       &        useThSIce, useATM2D, useBulkForce,
896       &        usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID,       &        usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID,
897       &        useRunClock, useEMBED_FILES, useMYPACKAGE       &        useRunClock, useEMBED_FILES, useMYPACKAGE, useSALT_PLUME
898    
899  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
900  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***

Legend:
Removed from v.1.200  
changed lines
  Added in v.1.218

  ViewVC Help
Powered by ViewVC 1.1.22