/[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.68 by jmc, Sat Feb 9 23:38:55 2002 UTC revision 1.261 by jmc, Fri Jun 15 13:17:34 2012 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3  C  C
4    
5  CBOP  CBOP
6  C    !ROUTINE: PARAMS.h  C     !ROUTINE: PARAMS.h
7  C    !INTERFACE:  C     !INTERFACE:
8  C    include PARAMS.h  C     #include PARAMS.h
9  C    !DESCRIPTION: \bv  
10  C     *==========================================================*  C     !DESCRIPTION:
11  C     | PARAMS.h                                                    C     Header file defining model "parameters".  The values from the
12  C     | o Header file defining model "parameters".                  C     model standard input file are stored into the variables held
13  C     *==========================================================*  C     here. Notes describing the parameters can also be found here.
14  C     | The values from the model standard input file are          
 C     | stored into the variables held here. Notes describing      
 C     | the parameters can also be found here.                      
 C     *==========================================================*  
 C     \ev  
15  CEOP  CEOP
16    
17  C     Macros for special grid options  C     Macros for special grid options
# Line 27  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     bathyFile   :: File containing bathymetry. If not defined bathymetry  C                         get buoyancy.
30  C                   is taken from inline function.  C     eosType         :: choose the equation of state:
31  C     topoFile    :: File containing the topography of the surface (unit=m)  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
32  C                   (mainly used for the atmosphere = ground height).  C     pickupSuff      :: force to start from pickup files (even if nIter0=0)
33  C     hydrogThetaFile :: File containing initial hydrographic data for potential  C                        and read pickup files with this suffix (max 10 Char.)
34  C                       temperature.  C     mdsioLocalDir   :: read-write tiled file from/to this directory name
35  C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.  C                        (+ 4 digits Processor-Rank) instead of current dir.
36    C     adTapeDir       :: read-write checkpointing tape files from/to this
37    C                        directory name instead of current dir. Conflicts
38    C                        mdsioLocalDir, so only one of the two can be set.
39    C                        In contrast to mdsioLocalDir, if specified adTapeDir
40    C                        must exist before the model starts.
41    C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
42    C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
43    C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
44    C     delRFile      :: File containing vertical grid spacing delR  (1.D array)
45    C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)
46    C     hybSigmFile   :: File containing hybrid-sigma vertical coord. coeff. (2x 1.D)
47    C     delXFile      :: File containing X-spacing grid definition (1.D array)
48    C     delYFile      :: File containing Y-spacing grid definition (1.D array)
49    C     horizGridFile :: File containing horizontal-grid definition
50    C                        (only when using curvilinear_grid)
51    C     bathyFile       :: File containing bathymetry. If not defined bathymetry
52    C                        is taken from inline function.
53    C     topoFile        :: File containing the topography of the surface (unit=m)
54    C                        (mainly used for the atmosphere = ground height).
55    C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
56    C                        for potential temperature.
57    C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
58    C                        for salinity.
59    C     diffKrFile      :: File containing 3D specification of vertical diffusivity
60    C     viscAhDfile     :: File containing 3D specification of horizontal viscosity
61    C     viscAhZfile     :: File containing 3D specification of horizontal viscosity
62    C     viscA4Dfile     :: File containing 3D specification of horizontal viscosity
63    C     viscA4Zfile     :: File containing 3D specification of horizontal viscosity
64  C     zonalWindFile   :: File containing zonal wind data  C     zonalWindFile   :: File containing zonal wind data
65  C     meridWindFile   :: File containing meridional wind data  C     meridWindFile   :: File containing meridional wind data
66  C     thetaClimFile   :: File containing theta climataology used  C     thetaClimFile   :: File containing surface theta climataology used
67  C                       in relaxation term -lambda(theta-theta*)  C                        in relaxation term -lambda(theta-theta*)
68  C     saltClimFile    :: File containing salt climataology used  C     saltClimFile    :: File containing surface salt climataology used
69  C                       in relaxation term -lambda(salt-salt*)  C                        in relaxation term -lambda(salt-salt*)
70  C     surfQfile       :: File containing surface heat flux  C     surfQfile       :: File containing surface heat flux, excluding SW
71  C     surfQswfile     :: File containing surface shortwave radiation  C                        (old version, kept for backward compatibility)
72    C     surfQnetFile    :: File containing surface net heat flux
73    C     surfQswFile     :: File containing surface shortwave radiation
74  C     dQdTfile        :: File containing thermal relaxation coefficient  C     dQdTfile        :: File containing thermal relaxation coefficient
75  C     EmPmRfile       :: File containing surface fresh water flux  C     EmPmRfile       :: File containing surface fresh water flux
76  C     buoyancyRelation :: Flag used to indicate which relation to use to  C           NOTE: for backward compatibility EmPmRfile is specified in
77  C                        get buoyancy.  C                 m/s when using external_fields_load.F.  It is converted
78        COMMON /PARM_C/ checkPtSuff,  C                 to kg/m2/s by multiplying by rhoConstFresh.
79    C     saltFluxFile    :: File containing surface salt flux
80    C     pLoadFile       :: File containing pressure loading
81    C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data
82    C     eddyPsiYFile    :: File containing meridional Eddy streamfunction data
83    C     the_run_name    :: string identifying the name of the model "run"
84          COMMON /PARM_C/
85         &                buoyancyRelation, eosType,
86         &                pickupSuff, mdsioLocalDir, adTapeDir,
87         &                tRefFile, sRefFile, rhoRefFile,
88         &                delRFile, delRcFile, hybSigmFile,
89         &                delXFile, delYFile, horizGridFile,
90       &                bathyFile, topoFile,       &                bathyFile, topoFile,
91       &                hydrogThetaFile, hydrogSaltFile,       &                viscAhDfile, viscAhZfile,
92         &                viscA4Dfile, viscA4Zfile,
93         &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
94       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
95       &                saltClimFile, buoyancyRelation,       &                saltClimFile,
96       &                EmPmRfile, surfQfile, surfQswfile,       &                EmPmRfile, saltFluxFile,
97         &                surfQfile, surfQnetFile, surfQswFile,
98         &                lambdaThetaFile, lambdaSaltFile,
99       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
100       &                dQdTfile       &                dQdTfile, ploadFile,
101        CHARACTER*(5) checkPtSuff(maxNoChkptLev)       &                eddyPsiXFile, eddyPsiYFile,
102         &                the_run_name
103          CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
104          CHARACTER*(6)  eosType
105          CHARACTER*(10) pickupSuff
106          CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
107          CHARACTER*(MAX_LEN_FNAM) adTapeDir
108          CHARACTER*(MAX_LEN_FNAM) tRefFile
109          CHARACTER*(MAX_LEN_FNAM) sRefFile
110          CHARACTER*(MAX_LEN_FNAM) rhoRefFile
111          CHARACTER*(MAX_LEN_FNAM) delRFile
112          CHARACTER*(MAX_LEN_FNAM) delRcFile
113          CHARACTER*(MAX_LEN_FNAM) hybSigmFile
114          CHARACTER*(MAX_LEN_FNAM) delXFile
115          CHARACTER*(MAX_LEN_FNAM) delYFile
116          CHARACTER*(MAX_LEN_FNAM) horizGridFile
117        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
118        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
119        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) diffKrFile
120          CHARACTER*(MAX_LEN_FNAM) viscAhDfile
121          CHARACTER*(MAX_LEN_FNAM) viscAhZfile
122          CHARACTER*(MAX_LEN_FNAM) viscA4Dfile
123          CHARACTER*(MAX_LEN_FNAM) viscA4Zfile
124        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
125        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
126        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
127        CHARACTER*(MAX_LEN_FNAM) saltClimFile        CHARACTER*(MAX_LEN_FNAM) saltClimFile
128        CHARACTER*(MAX_LEN_FNAM) surfQfile        CHARACTER*(MAX_LEN_FNAM) surfQfile
129        CHARACTER*(MAX_LEN_FNAM) surfQswfile        CHARACTER*(MAX_LEN_FNAM) surfQnetFile
130          CHARACTER*(MAX_LEN_FNAM) surfQswFile
131        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
132        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) saltFluxFile
133        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
134        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
135        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
136        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
137          CHARACTER*(MAX_LEN_FNAM) ploadFile
138          CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile
139          CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile
140          CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
141          CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
142          CHARACTER*(MAX_LEN_PREC/2) the_run_name
143    
144  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
145  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
146  C                           two-dimensional con. grad solver.  C                            two-dimensional con. grad solver.
147  C     cg2dChkResFreq      :: Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
148  C                           in con. grad solver.  C                            in con. grad solver.
149    C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
150    C                            (non-linear free-surf.)
151  C     cg3dMaxIters        :: Maximum number of iterations in the  C     cg3dMaxIters        :: Maximum number of iterations in the
152  C                           three-dimensional con. grad solver.  C                            three-dimensional con. grad solver.
153  C     cg3dChkResFreq      :: Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
154  C                           in con. grad solver.  C                            in con. grad solver.
155    C     printResidualFreq   :: Frequency for printing residual in CG iterations
156  C     nIter0              :: Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
157  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.  
158  C     writeStatePrec      :: Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
159  C     writeBinaryPrec     :: Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
160  C     readBinaryPrec      :: Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
161  C     nCheckLev           :: Holds current checkpoint level  C     selectCoriMap       :: select setting of Coriolis parameter map:
162    C                           =0 f-Plane (Constant Coriolis, = f0)
163    C                           =1 Beta-Plane Coriolis (= f0 + beta.y)
164    C                           =2 Spherical Coriolis (= 2.omega.sin(phi))
165    C                           =3 Read Coriolis 2-d fields from files.
166    C     selectSigmaCoord    :: option related to sigma vertical coordinate
167  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
168  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
169    C     select_rStar        :: option related to r* vertical coordinate
170    C                           =0 (default) use r coord. ; > 0 use r*
171    C     selectNHfreeSurf    :: option for Non-Hydrostatic (free-)Surface formulation:
172    C                           =0 (default) hydrostatic surf. ; > 0 add NH effects.
173    C     selectAddFluid      :: option to add mass source/sink of fluid in the interior
174    C                            (3-D generalisation of oceanic real-fresh water flux)
175    C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
176    C     momForcingOutAB     :: =1: take momentum forcing contribution
177    C                            out of (=0: in) Adams-Bashforth time stepping.
178    C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
179    C                            out of (=0: in) Adams-Bashforth time stepping.
180    C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
181    C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
182    C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
183    C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
184    C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)
185    C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)
186    C     monitorSelect       :: select group of variables to monitor
187    C                            =1 : dynvars ; =2 : + vort ; =3 : + surface
188    C-    debugLevel          :: controls printing of algorithm intermediate results
189    C                            and statistics ; higher -> more writing
190    
191        COMMON /PARM_I/        COMMON /PARM_I/
192       &        cg2dMaxIters,       &        cg2dMaxIters, cg2dChkResFreq, cg2dPreCondFreq,
193       &        cg2dChkResFreq,       &        cg3dMaxIters, cg3dChkResFreq,
194       &        cg3dMaxIters,       &        printResidualFreq,
      &        cg3dChkResFreq,  
195       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
196       &        numStepsPerPickup,       &        writeStatePrec,
      &        writeStatePrec, nCheckLev,  
197       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
198       &        nonlinFreeSurf,       &        selectCoriMap,
199       &        tempAdvScheme, saltAdvScheme, tracerAdvScheme       &        selectSigmaCoord,
200         &        nonlinFreeSurf, select_rStar,
201         &        selectNHfreeSurf,
202         &        selectAddFluid,
203         &        momForcingOutAB, tracForcingOutAB,
204         &        tempAdvScheme, tempVertAdvScheme,
205         &        saltAdvScheme, saltVertAdvScheme,
206         &        selectKEscheme, selectVortScheme,
207         &        monitorSelect, debugLevel
208        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
209        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
210          INTEGER cg2dPreCondFreq
211        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
212        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
213          INTEGER printResidualFreq
214        INTEGER nIter0        INTEGER nIter0
215        INTEGER nTimeSteps        INTEGER nTimeSteps
216        INTEGER nEndIter        INTEGER nEndIter
       INTEGER numStepsPerPickup  
217        INTEGER writeStatePrec        INTEGER writeStatePrec
218        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
219        INTEGER readBinaryPrec        INTEGER readBinaryPrec
220        INTEGER nCheckLev        INTEGER selectCoriMap
221          INTEGER selectSigmaCoord
222        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
223        INTEGER tempAdvScheme        INTEGER select_rStar
224        INTEGER saltAdvScheme        INTEGER selectNHfreeSurf
225        INTEGER tracerAdvScheme        INTEGER selectAddFluid
226          INTEGER momForcingOutAB, tracForcingOutAB
227          INTEGER tempAdvScheme, tempVertAdvScheme
228          INTEGER saltAdvScheme, saltVertAdvScheme
229          INTEGER selectKEscheme
230          INTEGER selectVortScheme
231          INTEGER monitorSelect
232          INTEGER debugLevel
233    
234  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
235    C- Coordinate + Grid params:
236    C     fluidIsAir       :: Set to indicate that the fluid major constituent
237    C                         is air
238    C     fluidIsWater     :: Set to indicate that the fluid major constituent
239    C                         is water
240    C     usingPCoords     :: Set to indicate that we are working in a pressure
241    C                         type coordinate (p or p*).
242    C     usingZCoords     :: Set to indicate that we are working in a height
243    C                         type coordinate (z or z*)
244    C     useDynP_inEos_Zc   :: use the dynamical pressure in EOS (with Z-coord.)
245    C                           this requires specific code for restart & exchange
246  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
247  C                          coordinate frame.  C                           coordinate frame.
248  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
249  C                               spherical polar frame.  C                                spherical polar frame.
250  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     rotateGrid      :: rotate grid coordinates to geographical coordinates
251    C                        according to Euler angles phiEuler, thetaEuler, psiEuler
252    C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
253    C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
254    C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
255    C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
256    C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
257    C- Momentum params:
258    C     no_slip_sides  :: Impose "no-slip" at lateral boundaries.
259  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
260  C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V  C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
261    C                       on irregular grids)
262    C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
263    C     useAreaViscLength :: Set to true to use old scaling for viscous lengths,
264    C                          e.g., L2=Raz.  May be preferable for cube sphere.
265  C     momViscosity  :: Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
266  C     momAdvection  :: Flag which turns advection of momentum on and off.  C     momAdvection  :: Flag which turns advection of momentum on and off.
267  C     momForcing    :: Flag which turns external forcing of momentum on  C     momForcing    :: Flag which turns external forcing of momentum on
268  C                     and off.  C                      and off.
269  C     momPressureForcing :: Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
270  C                          on and off.  C                          on and off.
271  C     metricTerms   :: Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
272  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
273  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
274  C     tempDiffusion :: Flag which turns diffusion of temperature on  C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
275  C                     and off.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
276  C     tempAdvection :: Flag which turns advection of temperature on  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
277  C                     and off.  C                                (default = F = use mom_fluxform package)
278  C     tempForcing   :: Flag which turns external forcing of temperature on  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986)
279  C                     and off.  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
280  C     saltDiffusion :: Flag which turns diffusion of salinit on  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
281  C                     and off.  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
282  C     saltAdvection :: Flag which turns advection of salinit on  C     useAbsVorticity :: work with f+zeta in Coriolis terms
283  C                     and off.  C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
284  C     saltForcing   :: Flag which turns external forcing of salinit on  C     momStepping    :: Turns momentum equation time-stepping off
285  C                     and off.  C     calc_wVelocity :: Turns of vertical velocity calculation off
286  C     useRealFreshWaterFlux :: if true (=Natural BCS), treats P+R-E flux  C- Temp. & Salt params:
287  C                         as a real Fresh Water (=> changes the seal level)  C     tempStepping   :: Turns temperature equation time-stepping off
288  C                              if false, converts P+R-E to virtual salt flux  C     saltStepping   :: Turns salinity equation time-stepping off
289    C     tempAdvection  :: Flag which turns advection of temperature on and off.
290    C     tempVertDiff4  :: use vertical bi-harmonic diffusion for temperature
291    C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
292    C     tempForcing    :: Flag which turns external forcing of temperature on
293    C                       and off.
294    C     saltAdvection  :: Flag which turns advection of salinity on and off.
295    C     saltVertDiff4  :: use vertical bi-harmonic diffusion for salinity
296    C     saltIsActiveTr :: Salinity  is a dynamically active tracer
297    C     saltForcing    :: Flag which turns external forcing of salinity on
298    C                       and off.
299    C     maskIniTemp    :: apply mask to initial Pot.Temp.
300    C     maskIniSalt    :: apply mask to initial salinity
301    C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
302    C     checkIniSalt   :: check for points with identically zero initial salinity
303    C- Pressure solver related parameters (PARM02)
304    C     useSRCGSolver  :: Set to true to use conjugate gradient
305    C                       solver with single reduction (only one call of
306    C                       s/r mpi_allreduce), default is false
307    C- Time-stepping & free-surface params:
308  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
309  C     implicitFreeSurface :: Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
 C     exactConserv        :: Set to true to conserve exactly the total Volume  
310  C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the  C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
311  C                           linear relation Phi_surf = Bo_surf*eta  C                            linear relation Phi_surf = Bo_surf*eta
312  C     momStepping   :: Turns momentum equation time-stepping off  C     uniformFreeSurfLev  :: TRUE if free-surface level-index is uniform (=1)
313  C     tempStepping  :: Turns temperature equation time-stepping off  C     exactConserv        :: Set to true to conserve exactly the total Volume
314  C     saltStepping  :: Turns salinity equation time-stepping off  C     linFSConserveTr     :: Set to true to correct source/sink of tracer
315  C     tr1Stepping   :: Turns passive tracer 1 time-stepping on/off  C                            at the surface due to Linear Free Surface
316  C     useConstantF  :: Coriolis parameter set to f0  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
317  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C                         as a real Fresh Water (=> changes the Sea Level)
318  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C                         if F, converts P+R-E to salt flux (no SL effect)
319    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
320    C     nonHydrostatic   :: Using non-hydrostatic algorithm
321    C     use3Dsolver      :: set to true to use 3-D pressure solver
322    C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
323    C     staggerTimeStep   :: enable a Stagger time stepping U,V (& W) then T,S
324    C     doResetHFactors   :: Do reset thickness factors @ beginning of each time-step
325  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
326  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
327    C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
328    C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity
329    C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
330    C     multiDimAdvection :: Flag that enable multi-dimension advection
331    C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
332    C     momDissip_In_AB   :: if False, put Dissipation tendency contribution
333    C                          out off Adams-Bashforth time stepping.
334    C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
335    C                          apply AB on tracer tendencies (rather than on Tracer)
336    C- Other forcing params -
337    C     balanceEmPmR    :: substract global mean of EmPmR at every time step
338    C     balanceQnet     :: substract global mean of Qnet at every time step
339    C     balancePrintMean:: print substracted global means to STDOUT
340  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
341  C                        climatology is required.  C                        climatology is required.
342  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
343  C                        climatology is required.  C                        climatology is required.
344    C     allowFreezing  :: Allows surface water to freeze and form ice
345    C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
346  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
347  C     usingPCoords     :: Set to indicate that we are working in pressure  C- I/O parameters -
348  C                        coords.  C     globalFiles    :: Selects between "global" and "tiled" files.
349  C     usingZCoords     :: Set to indicate that we are working in height  C                       On some platforms with MPI, option globalFiles is either
350  C                        coords.  C                       slow or does not work. Use useSingleCpuIO instead.
351  C     nonHydrostatic :: Using non-hydrostatic terms  C     useSingleCpuIO :: moved to EEPARAMS.h
352  C     globalFiles    :: Selects between "global" and "tiled" files  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
353  C     allowFreezing  :: Allows water to freeze and form ice  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
354  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
355  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  C                           before checkpoint-54a, Jul 06, 2004.
356        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,  C     pickup_write_mdsio :: use mdsio to write pickups
357       & usingCurvilinearGrid,  C     pickup_read_mdsio  :: use mdsio to read  pickups
358       & no_slip_sides,no_slip_bottom,  C     pickup_write_immed :: echo the pickup immediately (for conversion)
359       & staggerTimeStep,  C     writePickupAtEnd   :: write pickup at the last timestep
360       & momViscosity, momAdvection, momForcing, useCoriolis,  C     timeave_mdsio      :: use mdsio for timeave output
361       & momPressureForcing, vectorInvariantMomentum,  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
362       & tempDiffusion, tempAdvection, tempForcing,  C     monitor_stdio      :: use stdio for monitor output
363       & saltDiffusion, saltAdvection, saltForcing,  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
364       & useRealFreshWaterFlux,  C                        & Last iteration, in addition multiple of dumpFreq iter.
365       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,  C     printDomain     :: controls printing of domain fields (bathy, hFac ...).
366       & momStepping, tempStepping, saltStepping, tr1Stepping,  
367       & metricTerms, usingSphericalPolarMTerms,        COMMON /PARM_L/
368       & useConstantF, useBetaPlaneF, useSphereF,       & fluidIsAir, fluidIsWater,
369         & usingPCoords, usingZCoords, useDynP_inEos_Zc,
370         & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
371         & usingCurvilinearGrid, usingCylindricalGrid,
372         & deepAtmosphere, setInterFDr, setCenterDr,
373         & no_slip_sides, no_slip_bottom,
374         & useFullLeith, useStrainTensionVisc, useAreaViscLength,
375         & momViscosity, momAdvection, momForcing,
376         & momPressureForcing, metricTerms, useNHMTerms,
377         & useCoriolis, use3dCoriolis,
378         & useCDscheme, vectorInvariantMomentum,
379         & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
380         & upwindVorticity, highOrderVorticity,
381         & useAbsVorticity, upwindShear,
382         & momStepping, calc_wVelocity, tempStepping, saltStepping,
383         & tempAdvection, tempVertDiff4, tempIsActiveTr, tempForcing,
384         & saltAdvection, saltVertDiff4, saltIsActiveTr, saltForcing,
385         & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
386         & useSRCGSolver,
387         & rigidLid, implicitFreeSurface,
388         & uniformLin_PhiSurf, uniformFreeSurfLev,
389         & exactConserv, linFSConserveTr, useRealFreshWaterFlux,
390         & quasiHydrostatic, nonHydrostatic, use3Dsolver,
391         & implicitIntGravWave, staggerTimeStep, doResetHFactors,
392       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
393       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
394       & periodicExternalForcing, usingPCoords, usingZCoords,       & multiDimAdvection, useMultiDimAdvec,
395       & nonHydrostatic, globalFiles,       & momDissip_In_AB, doAB_onGtGs,
396       & allowFreezing, groundAtK1,       & balanceEmPmR, balanceQnet, balancePrintMean,
397       & usePickupBeforeC35, debugMode,       & doThetaClimRelax, doSaltClimRelax,
398       & readPickupWithTracer, writePickupWithTracer,       & allowFreezing, useOldFreezing,
399       & multiDimAdvection, useEnergyConservingCoriolis,       & periodicExternalForcing,
400       & useJamartWetPoints       & globalFiles,
401         & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
402         & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
403         & writePickupAtEnd,
404         & timeave_mdsio, snapshot_mdsio, monitor_stdio,
405         & outputTypesInclusive, dumpInitAndLast,
406         & printDomain,
407         & inAdMode, inAdTrue, inAdFalse, inAdExact
408    
409          LOGICAL fluidIsAir
410          LOGICAL fluidIsWater
411          LOGICAL usingPCoords
412          LOGICAL usingZCoords
413          LOGICAL useDynP_inEos_Zc
414        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
415        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid, rotateGrid
416          LOGICAL usingCylindricalGrid
417        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
418        LOGICAL usingSphericalPolarMTerms        LOGICAL deepAtmosphere
419          LOGICAL setInterFDr
420          LOGICAL setCenterDr
421          LOGICAL useNHMTerms
422        LOGICAL no_slip_sides        LOGICAL no_slip_sides
423        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
424        LOGICAL staggerTimeStep        LOGICAL useFullLeith
425          LOGICAL useStrainTensionVisc
426          LOGICAL useAreaViscLength
427        LOGICAL momViscosity        LOGICAL momViscosity
428        LOGICAL momAdvection        LOGICAL momAdvection
429        LOGICAL momForcing        LOGICAL momForcing
430        LOGICAL momPressureForcing        LOGICAL momPressureForcing
431        LOGICAL useCoriolis        LOGICAL useCoriolis
432        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
       LOGICAL tempDiffusion  
433        LOGICAL tempAdvection        LOGICAL tempAdvection
434          LOGICAL tempVertDiff4
435          LOGICAL tempIsActiveTr
436        LOGICAL tempForcing        LOGICAL tempForcing
       LOGICAL saltDiffusion  
437        LOGICAL saltAdvection        LOGICAL saltAdvection
438          LOGICAL saltVertDiff4
439          LOGICAL saltIsActiveTr
440        LOGICAL saltForcing        LOGICAL saltForcing
441        LOGICAL useRealFreshWaterFlux        LOGICAL maskIniTemp
442          LOGICAL maskIniSalt
443          LOGICAL checkIniTemp
444          LOGICAL checkIniSalt
445          LOGICAL useSRCGSolver
446        LOGICAL rigidLid        LOGICAL rigidLid
447        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
       LOGICAL exactConserv  
448        LOGICAL uniformLin_PhiSurf        LOGICAL uniformLin_PhiSurf
449          LOGICAL uniformFreeSurfLev
450          LOGICAL exactConserv
451          LOGICAL linFSConserveTr
452          LOGICAL useRealFreshWaterFlux
453          LOGICAL quasiHydrostatic
454          LOGICAL nonHydrostatic
455          LOGICAL use3Dsolver
456          LOGICAL implicitIntGravWave
457          LOGICAL staggerTimeStep
458          LOGICAL doResetHFactors
459        LOGICAL momStepping        LOGICAL momStepping
460          LOGICAL calc_wVelocity
461        LOGICAL tempStepping        LOGICAL tempStepping
462        LOGICAL saltStepping        LOGICAL saltStepping
       LOGICAL tr1Stepping  
463        LOGICAL metricTerms        LOGICAL metricTerms
464        LOGICAL useConstantF        LOGICAL use3dCoriolis
465        LOGICAL useBetaPlaneF        LOGICAL useCDscheme
466        LOGICAL useSphereF        LOGICAL useEnergyConservingCoriolis
467          LOGICAL useJamartWetPoints
468          LOGICAL useJamartMomAdv
469          LOGICAL upwindVorticity
470          LOGICAL highOrderVorticity
471          LOGICAL useAbsVorticity
472          LOGICAL upwindShear
473        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
474        LOGICAL implicitViscosity        LOGICAL implicitViscosity
475          LOGICAL tempImplVertAdv
476          LOGICAL saltImplVertAdv
477          LOGICAL momImplVertAdv
478          LOGICAL multiDimAdvection
479          LOGICAL useMultiDimAdvec
480          LOGICAL momDissip_In_AB
481          LOGICAL doAB_onGtGs
482          LOGICAL balanceEmPmR
483          LOGICAL balanceQnet
484          LOGICAL balancePrintMean
485        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
486        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
487        LOGICAL doTr1ClimRelax        LOGICAL allowFreezing
488          LOGICAL useOldFreezing
489        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
       LOGICAL usingPCoords  
       LOGICAL usingZCoords  
       LOGICAL nonHydrostatic  
490        LOGICAL globalFiles        LOGICAL globalFiles
491        LOGICAL allowFreezing        LOGICAL pickupStrictlyMatch
492        LOGICAL groundAtK1        LOGICAL usePickupBeforeC54
493        LOGICAL usePickupBeforeC35        LOGICAL startFromPickupAB2
494        LOGICAL debugMode        LOGICAL pickup_read_mdsio, pickup_write_mdsio
495        LOGICAL readPickupWithTracer        LOGICAL pickup_write_immed, writePickupAtEnd
496        LOGICAL writePickupWithTracer        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
497        LOGICAL multiDimAdvection        LOGICAL outputTypesInclusive
498        LOGICAL useEnergyConservingCoriolis        LOGICAL dumpInitAndLast
499        LOGICAL useJamartWetPoints        LOGICAL printDomain
500          LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
501    
502  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
503  C     gg2dTargetResidual  C     cg2dTargetResidual
504  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
505  C     cg2dTargetResWunit  C     cg2dTargetResWunit
506  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
# Line 299  C           number of iterations for con Line 520  C           number of iterations for con
520  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
521  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
522  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
 C     delP      :: Vertical grid spacing ( Pa ).  
 C     delZ      :: Vertical grid spacing ( m  ).  
523  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
524    C     delRc     :: Vertical grid spacing between cell centers (r unit).
525  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
526  C     delY        on input flags.  C     delY         on input flags. Note: moved to header file SET_GRID.h
527    C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
528    C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
529    C                :: parameter but it makes geographical references simple.)
530    C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
531    C                :: most face (Lat-Lon grid).
532  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
533  C     recip_gravity and its inverse  C     recip_gravity and its inverse
534  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
535  C     ronil     :: Reference density  C     rhoNil    :: Reference density for the linear equation of state
536  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density (Boussinesq)
537  C     startTime :: Start time for model ( s )  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
538  C     phiMin    :: Latitude of southern most cell face.  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
539  C     thetaMin  :: Longitude of western most cell face (this  C     rhoConstFresh :: Constant reference density for fresh water (rain)
540  C                 is an "inert" parameter but it is included  C     rho1Ref   :: reference vertical profile for density
541  C                 to make geographical references simple.)  C     tRef      :: reference vertical profile for potential temperature
542  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).  C     sRef      :: reference vertical profile for salinity/specific humidity
543  C     recip_RSphere  :: Reciprocal radius of sphere ( m ).  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
544  C     f0        :: Reference coriolis parameter ( 1/s )  C     dBdrRef   :: vertical gradient of reference buoyancy  [(m/s/r)^2]:
545  C                 ( Southern edge f for beta plane )  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
546  C     beta      :: df/dy ( s^-1.m^-1 )  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
547  C     omega     :: Angular velocity ( rad/s )  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
548  C     viscAh    :: Eddy viscosity coeff. for mixing of  C                :: from r-coordinate vertical velocity to vertical velocity [m/s].
549  C                 momentum laterally ( m^2/s )  C                :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit
550  C     viscAz    :: Eddy viscosity coeff. for mixing of  C     wUnit2rVel :: units conversion factor (Non-Hydrostatic code),
551  C                 momentum vertically ( m^2/s )  C                :: from vertical velocity [m/s] to r-coordinate vertical velocity.
552  C     viscAp    :: Eddy viscosity coeff. for mixing of  C                :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel
553  C                 momentum vertically ( Pa^2/s )  C     mass2rUnit :: units conversion factor (surface forcing),
554  C     viscAr    :: Eddy viscosity coeff. for mixing of  C                :: from mass per unit area [kg/m2] to vertical r-coordinate unit.
555  C                 momentum vertically ( units of r^2/s )  C                :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ;
556  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C                :: p-coord: = gravity    ( [kg/m2] *  g = [Pa] ) ;
557  C                 momentum laterally ( m^4/s )  C     rUnit2mass :: units conversion factor (surface forcing),
558    C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
559    C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
560    C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
561    C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
562    C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
563    C     radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
564    C     f0         :: Reference coriolis parameter ( 1/s )
565    C                   ( Southern edge f for beta plane )
566    C     beta       :: df/dy ( s^-1.m^-1 )
567    C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
568    C                   of rotation (reference value = 2.Omega.Cos(Phi))
569    C     omega      :: Angular velocity ( rad/s )
570    C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
571    C     viscArNr   :: vertical profile of Eddy viscosity coeff.
572    C                   for vertical mixing of momentum ( units of r^2/s )
573    C     viscAh     :: Eddy viscosity coeff. for mixing of
574    C                   momentum laterally ( m^2/s )
575    C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
576    C                   momentum laterally, no effect for hydrostatic
577    C                   model, defaults to viscAh if unset ( m^2/s )
578    C                   Not used if variable horiz. viscosity is used.
579    C     viscA4     :: Biharmonic viscosity coeff. for mixing of
580    C                   momentum laterally ( m^4/s )
581    C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
582    C                   momentum laterally, no effect for hydrostatic
583    C                   model, defaults to viscA4 if unset ( m^2/s )
584    C                   Not used if variable horiz. viscosity is used.
585    C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
586    C                   (act on Divergence part) ( m^2/s )
587    C     viscAhZ    :: Eddy viscosity coeff. for mixing of momentum laterally
588    C                   (act on Vorticity  part) ( m^2/s )
589    C     viscA4D    :: Biharmonic viscosity coeff. for mixing of momentum laterally
590    C                   (act on Divergence part) ( m^4/s )
591    C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
592    C                   (act on Vorticity  part) ( m^4/s )
593    C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
594    C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
595    C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
596    C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
597    C     viscC2smag   :: Smagorinsky non-dimensional viscosity factor (harmonic)
598    C     viscC4smag   :: Smagorinsky non-dimensional viscosity factor (biharmonic)
599    C     viscAhMax    :: Maximum eddy viscosity coeff. for mixing of
600    C                    momentum laterally ( m^2/s )
601    C     viscAhReMax  :: Maximum gridscale Reynolds number for eddy viscosity
602    C                     coeff. for mixing of momentum laterally (non-dim)
603    C     viscAhGrid   :: non-dimensional grid-size dependent viscosity
604    C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
605    C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
606    C     viscA4Max    :: Maximum biharmonic viscosity coeff. for mixing of
607    C                     momentum laterally ( m^4/s )
608    C     viscA4ReMax  :: Maximum Gridscale Reynolds number for
609    C                     biharmonic viscosity coeff. momentum laterally (non-dim)
610    C     viscA4Grid   :: non-dimensional grid-size dependent bi-harmonic viscosity
611    C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
612    C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
613  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
614  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
 C     diffKzT   :: Laplacian diffusion coeff. for mixing of  
 C                 heat vertically ( m^2/s )  
 C     diffKpT   :: Laplacian diffusion coeff. for mixing of  
 C                 heat vertically ( Pa^2/s )  
 C     diffKrT   :: Laplacian diffusion coeff. for mixing of  
 C                 heat vertically ( units of r^2/s )  
615  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
616  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
617    C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
618    C                 for mixing of heat vertically ( units of r^2/s )
619    C     diffKr4T  :: vertical profile of Biharmonic diffusion coeff.
620    C                 for mixing of heat vertically ( units of r^4/s )
621  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
622  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
 C     diffKzS   :: Laplacian diffusion coeff. for mixing of  
 C                 salt vertically ( m^2/s )  
 C     diffKpS   :: Laplacian diffusion coeff. for mixing of  
 C                 salt vertically ( Pa^2/s )  
 C     diffKrS   :: Laplacian diffusion coeff. for mixing of  
 C                 salt vertically ( units of r^2/s )  
623  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
624  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
625    C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
626    C                 for mixing of salt vertically ( units of r^2/s ),
627    C     diffKr4S  :: vertical profile of Biharmonic diffusion coeff.
628    C                 for mixing of salt vertically ( units of r^4/s )
629    C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
630    C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
631    C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
632    C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
633    C     BL79LatVary    :: polarwise of this latitude diffKrBL79 is applied with
634    C                       gradual transition to diffKrBLEQ towards Equator
635    C     diffKrBLEQsurf :: same as diffKrBL79surf but at Equator
636    C     diffKrBLEQdeep :: same as diffKrBL79deep but at Equator
637    C     diffKrBLEQscl  :: same as diffKrBL79scl but at Equator
638    C     diffKrBLEQHo   :: same as diffKrBL79Ho but at Equator
639  C     deltaT    :: Default timestep ( s )  C     deltaT    :: Default timestep ( s )
640  C     deltaTClock  :: Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
641  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
# Line 358  C                    it will be the deep Line 644  C                    it will be the deep
644  C                    Frequency of checkpointing and dumping of the model state  C                    Frequency of checkpointing and dumping of the model state
645  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
646  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
647  C     deltaTtracer :: Timestep for tracer equations ( s )  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
648  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
649  C                    freesurfac = 1. uses implicit free surface  C     freeSurfFac  :: Parameter to turn implicit free surface term on or off
650  C                    freesurfac = 0. uses rigid lid  C                     freeSurFac = 1. uses implicit free surface
651    C                     freeSurFac = 0. uses rigid lid
652    C     abEps        :: Adams-Bashforth-2 stabilizing weight
653    C     alph_AB      :: Adams-Bashforth-3 primary factor
654    C     beta_AB      :: Adams-Bashforth-3 secondary factor
655  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
656  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
657  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
658  C                     Implicit part of barotropic flow Divergence ( 0-1 )  C                     Implicit part of barotropic flow Divergence ( 0-1 )
659    C     implicitNHPress :: parameter of the Crank-Nickelson time stepping :
660    C                     Implicit part of Non-Hydrostatic Pressure Gradient ( 0-1 )
661  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
662  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    :: Minimum dimensional size of a cell (affects hFacC etc..., m)
663  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    :: Minimum dimensional size of a cell (affects hFacC etc..., Pa)
664  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)  C     hFacMinDr    :: Minimum dimensional size of a cell (-> hFacC etc..., r units)
665  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
666  C     hFacSup        that control vanishing and creating levels  C     hFacSup          that control vanishing and creating levels
667  C     tauCD        :: CD scheme coupling timescale ( 1/s )  C     tauCD         :: CD scheme coupling timescale ( s )
668  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )  C     rCD           :: CD scheme normalised coupling parameter (= 1 - deltaT/tauCD)
669    C     epsAB_CD      :: Adams-Bashforth-2 stabilizing weight used in CD scheme
670    C     baseTime      :: model base time (time origin) = time @ iteration zero
671  C     startTime     :: Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
672  C     endTime       :: Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
673  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
674  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
675  C     dumpFreq      :: Frequency with which model state is written to  C     dumpFreq      :: Frequency with which model state is written to
676  C                     post-processing files ( s ).  C                      post-processing files ( s ).
677  C     diagFreq      :: Frequency with which model writes diagnostic output  C     diagFreq      :: Frequency with which model writes diagnostic output
678  C                     of intermediate quantities.  C                      of intermediate quantities.
679  C     afFacMom      :: Advection of momentum term tracer parameter  C     afFacMom      :: Advection of momentum term tracer parameter
680  C     vfFacMom      :: Momentum viscosity tracer parameter  C     vfFacMom      :: Momentum viscosity tracer parameter
681  C     pfFacMom      :: Momentum pressure forcing tracer parameter  C     pfFacMom      :: Momentum pressure forcing tracer parameter
# Line 391  C     mtFacMom      :: Metric terms trac Line 685  C     mtFacMom      :: Metric terms trac
685  C     cosPower      :: Power of cosine of latitude to multiply viscosity  C     cosPower      :: Power of cosine of latitude to multiply viscosity
686  C     cAdjFreq      :: Frequency of convective adjustment  C     cAdjFreq      :: Frequency of convective adjustment
687  C  C
688  C     taveFreq      :: Frequency with which time-averaged model state is written to  C     taveFreq      :: Frequency with which time-averaged model state
689  C                     post-processing files ( s ).  C                      is written to post-processing files ( s ).
690    C     tave_lastIter :: (for state variable only) fraction of the last time
691    C                      step (of each taveFreq period) put in the time average.
692    C                      (fraction for 1rst iter = 1 - tave_lastIter)
693  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
 C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).  
694  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
695  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).  C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
696    C                         i.e. where |yC| <= latBandClimRelax
697  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
698  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
699  C                          (note: externForcingCycle must be an integer  C                          (note: externForcingCycle must be an integer
700  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
701  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
702  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
703  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
704  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
705  C     trac_EvPrRn :: tracer concentration in Rain & Evap.  C     temp_addMass :: temperature of addMass array
706  C        (notes: a) tracer content of Rain/Evap only used if both  C     salt_addMass :: salinity of addMass array
707    C        (notes: a) tracer content of Rain/Evap only used if both
708  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
709  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
710  C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.  C     hMixCriteria:: criteria for mixed-layer diagnostic
711  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).  C     dRhoSmall   :: parameter for mixed-layer diagnostic
712  C                          ( g*rho if horiz in m and vertical in Pa ).  C     hMixSmooth  :: Smoothing parameter for mixed-layer diag (default=0=no smoothing)
713  C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
714  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
715  C     bottomDragLinear   :: Drag coefficient built in to core dynamics  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
716  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )  C     rSigmaBnd   :: vertical position (in r-unit) of r/sigma transition (Hybrid-Sigma)
717        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
718    C                           (default=2: full drag ; =1: gives half-slip BC)
719    C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
720    C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
721    C               (if using zcoordinate, units becomes linear: m/s, quadratic: [-])
722    C     smoothAbsFuncRange :: 1/2 of interval around zero, for which FORTRAN ABS
723    C                           is to be replace by a smoother function
724    C                           (affects myabs, mymin, mymax)
725    C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
726    C                      (i.e. allows convection at different Rayleigh numbers)
727    C     phiEuler      :: Euler angle, rotation about original z-axis
728    C     thetaEuler    :: Euler angle, rotation about new x-axis
729    C     psiEuler      :: Euler angle, rotation about new z-axis
730          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
731       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
732       & delP, delZ, delR, delX, delY,       & delR, delRc, xgOrigin, ygOrigin,
733       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
734       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & abEps, alph_AB, beta_AB,
735       & fCori, fCoriG,       & rSphere, recip_rSphere, radius_fromHorizGrid,
736       & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,       & f0, beta, fPrime, omega, rotationPeriod,
737       & diffKhT, diffKzT, diffK4T, diffKrT,       & viscFacAdj, viscAh, viscAhW, viscAhMax,
738       & diffKhS, diffKzS, diffK4S, diffKrS,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
739       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & viscC2leith, viscC2leithD,
740         & viscC2smag, viscC4smag,
741         & viscAhD, viscAhZ, viscA4D, viscA4Z,
742         & viscA4, viscA4W, viscA4Max,
743         & viscA4Grid, viscA4GridMax, viscA4GridMin,
744         & viscAhReMax, viscA4ReMax,
745         & viscC4leith, viscC4leithD, viscArNr,
746         & diffKhT, diffK4T, diffKrNrT, diffKr4T,
747         & diffKhS, diffK4S, diffKrNrS, diffKr4S,
748         & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
749         & BL79LatVary,
750         & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
751         & tauCD, rCD, epsAB_CD,
752         & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
753       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
754       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_gravity, gBaro,
755       & recip_rhoConst, rhoConst, tRef, sRef,       & rhoNil, rhoConst, recip_rhoConst,
756       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
757       & diagFreq, taveFreq, monitorFreq,       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
758         & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
759         & baseTime, startTime, endTime,
760         & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
761         & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
762       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
763       & cosPower, cAdjFreq, omega,       & cosPower, cAdjFreq,
764       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
      & tauSaltClimRelax, lambdaSaltClimRelax,  
      & tauTr1ClimRelax, lambdaTr1ClimRelax,  
765       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
766       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
767       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
768       & horiVertRatio, recip_horiVertRatio,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth,
769       & ivdc_kappa, Ro_SeaLevel,       & Ro_SeaLevel, rSigmaBnd,
770       & bottomDragLinear,bottomDragQuadratic       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
771         & smoothAbsFuncRange,
772         & tCylIn, tCylOut,
773         & phiEuler, thetaEuler, psiEuler
774    
775        _RL cg2dTargetResidual        _RL cg2dTargetResidual
776        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
777        _RL cg3dTargetResidual        _RL cg3dTargetResidual
778        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
       _RL delZ(Nr)  
       _RL delP(Nr)  
779        _RL delR(Nr)        _RL delR(Nr)
780        _RL delX(Nx)        _RL delRc(Nr+1)
781        _RL delY(Ny)        _RL xgOrigin
782          _RL ygOrigin
783        _RL deltaT        _RL deltaT
784        _RL deltaTClock        _RL deltaTClock
785        _RL deltaTmom        _RL deltaTmom
786        _RL deltaTtracer        _RL dTtracerLev(Nr)
787        _RL abeps        _RL deltaTfreesurf
788        _RL phiMin        _RL abEps, alph_AB, beta_AB
       _RL thetaMin  
789        _RL rSphere        _RL rSphere
790        _RL recip_RSphere        _RL recip_rSphere
791          _RL radius_fromHorizGrid
792        _RL f0        _RL f0
793          _RL beta
794          _RL fPrime
795          _RL omega
796          _RL rotationPeriod
797        _RL freeSurfFac        _RL freeSurfFac
798        _RL implicSurfPress        _RL implicSurfPress
799        _RL implicDiv2Dflow        _RL implicDiv2Dflow
800          _RL implicitNHPress
801        _RL hFacMin        _RL hFacMin
802        _RL hFacMinDz        _RL hFacMinDz
803        _RL hFacMinDp        _RL hFacMinDp
804        _RL hFacMinDr        _RL hFacMinDr
805        _RL hFacInf        _RL hFacInf
806        _RL hFacSup        _RL hFacSup
807        _RL beta        _RL viscArNr(Nr)
808          _RL viscFacAdj
809        _RL viscAh        _RL viscAh
810        _RL viscAstrain        _RL viscAhW
811        _RL viscAtension        _RL viscAhD
812        _RL viscAz        _RL viscAhZ
813        _RL viscAp        _RL viscAhMax
814        _RL viscAr        _RL viscAhReMax
815        _RL viscA4        _RL viscAhGrid, viscAhGridMax, viscAhGridMin
816        _RL diffKhT        _RL viscC2leith
817        _RL diffKrT        _RL viscC2leithD
818        _RL diffKzT        _RL viscC2smag
819        _RL diffKpT        _RL viscA4
820        _RL diffK4T        _RL viscA4W
821        _RL diffKhS        _RL viscA4D
822        _RL diffKrS        _RL viscA4Z
823        _RL diffKzS        _RL viscA4Max
824        _RL diffKpS        _RL viscA4ReMax
825        _RL diffK4S        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
826        _RL delt        _RL viscC4leith
827        _RL tauCD        _RL viscC4leithD
828        _RL rCD        _RL viscC4smag
829          _RL diffKhT
830          _RL diffK4T
831          _RL diffKrNrT(Nr)
832          _RL diffKr4T(Nr)
833          _RL diffKhS
834          _RL diffK4S
835          _RL diffKrNrS(Nr)
836          _RL diffKr4S(Nr)
837          _RL diffKrBL79surf
838          _RL diffKrBL79deep
839          _RL diffKrBL79scl
840          _RL diffKrBL79Ho
841          _RL BL79LatVary
842          _RL diffKrBLEQsurf
843          _RL diffKrBLEQdeep
844          _RL diffKrBLEQscl
845          _RL diffKrBLEQHo
846          _RL tauCD, rCD, epsAB_CD
847        _RL gravity        _RL gravity
848        _RL recip_gravity        _RL recip_gravity
849        _RL gBaro        _RL gBaro
850        _RL rhonil        _RL rhoNil
851        _RL recip_rhonil        _RL rhoConst,      recip_rhoConst
852        _RL rhoConst        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
853        _RL recip_rhoConst        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
854          _RL rhoConstFresh
855          _RL rho1Ref(Nr)
856        _RL tRef(Nr)        _RL tRef(Nr)
857        _RL sRef(Nr)        _RL sRef(Nr)
858        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL phiRef(2*Nr+1)
859        _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL dBdrRef(Nr)
860          _RL rVel2wUnit(Nr+1), wUnit2rVel(Nr+1)
861          _RL mass2rUnit, rUnit2mass
862          _RL baseTime
863        _RL startTime        _RL startTime
864        _RL endTime        _RL endTime
865        _RL chkPtFreq        _RL chkPtFreq
866        _RL pChkPtFreq        _RL pChkPtFreq
867        _RL dumpFreq        _RL dumpFreq
868          _RL adjDumpFreq
869        _RL diagFreq        _RL diagFreq
870        _RL taveFreq        _RL taveFreq
871          _RL tave_lastIter
872        _RL monitorFreq        _RL monitorFreq
873          _RL adjMonitorFreq
874        _RL afFacMom        _RL afFacMom
875        _RL vfFacMom        _RL vfFacMom
876        _RL pfFacMom        _RL pfFacMom
877        _RL cfFacMom        _RL cfFacMom
878        _RL foFacMom        _RL foFacMom
879        _RL mTFacMom        _RL mtFacMom
880        _RL cosPower        _RL cosPower
881        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
882        _RL tauThetaClimRelax        _RL tauThetaClimRelax
       _RL lambdaThetaClimRelax  
883        _RL tauSaltClimRelax        _RL tauSaltClimRelax
884        _RL lambdaSaltClimRelax        _RL latBandClimRelax
       _RL tauTr1ClimRelax  
       _RL lambdaTr1ClimRelax  
885        _RL externForcingCycle        _RL externForcingCycle
886        _RL externForcingPeriod        _RL externForcingPeriod
887        _RL convertFW2Salt        _RL convertFW2Salt
888        _RL temp_EvPrRn        _RL temp_EvPrRn
889        _RL salt_EvPrRn        _RL salt_EvPrRn
890        _RL trac_EvPrRn        _RL temp_addMass
891        _RL horiVertRatio        _RL salt_addMass
       _RL recip_horiVertRatio  
892        _RL ivdc_kappa        _RL ivdc_kappa
893          _RL hMixCriteria
894          _RL dRhoSmall
895          _RL hMixSmooth
896        _RL Ro_SeaLevel        _RL Ro_SeaLevel
897          _RL rSigmaBnd
898          _RL sideDragFactor
899        _RL bottomDragLinear        _RL bottomDragLinear
900        _RL bottomDragQuadratic        _RL bottomDragQuadratic
901          _RL smoothAbsFuncRange
902          _RL nh_Am2
903          _RL tCylIn
904          _RL tCylOut
905          _RL phiEuler, thetaEuler, psiEuler
906    
907        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,  C--   COMMON /PARM_A/ Thermodynamics constants ?
908       &                Lamba_theta        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
909        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
       _RL Lamba_theta  
910        _RL recip_Cp        _RL recip_Cp
911    
912  C Equation of State (polynomial coeffients)  C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
913        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS  C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
914        _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)  C     atm_Po    :: standard reference pressure
915  C Linear equation of state  C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
916  C     tAlpha    :: Linear EOS thermal expansion coefficient ( 1/degree ).  C     atm_Rd    :: gas constant for dry air
 C     sBeta     :: Linear EOS haline contraction coefficient.  
       COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType  
       _RL tAlpha  
       _RL sBeta  
       character*(6) eosType  
   
 C Atmospheric physical parameters (Ideal Gas EOS, ...)  
 C     atm_po    :: standard reference pressure  
 C     atm_cp    :: specific heat (Cp) of the (dry) air at constant pressure  
917  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
918  C     Integr_GeoPot :: option to select the way we integrate the geopotential  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
919  C                     (still a subject of discussions ...)  C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
920        COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,  C     integr_GeoPot :: option to select the way we integrate the geopotential
921       &                  Integr_GeoPot  C                     (still a subject of discussions ...)
922        _RL atm_cp, atm_kappa, atm_po  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
923        INTEGER Integr_GeoPot  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
924          COMMON /PARM_ATM/
925         &            celsius2K,
926         &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
927         &            integr_GeoPot, selectFindRoSurf
928          _RL celsius2K
929          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
930          INTEGER integr_GeoPot, selectFindRoSurf
931    
932  C Logical flags for selecting packages  C Logical flags for selecting packages
933          LOGICAL useGAD
934          LOGICAL useOBCS
935          LOGICAL useSHAP_FILT
936          LOGICAL useZONAL_FILT
937          LOGICAL useOPPS
938          LOGICAL usePP81
939          LOGICAL useMY82
940          LOGICAL useGGL90
941        LOGICAL useKPP        LOGICAL useKPP
942        LOGICAL useGMRedi        LOGICAL useGMRedi
943        LOGICAL useOBCS        LOGICAL useDOWN_SLOPE
944        LOGICAL useAIM        LOGICAL useBBL
945          LOGICAL useCAL
946          LOGICAL useEXF
947          LOGICAL useBulkForce
948          LOGICAL useEBM
949          LOGICAL useCheapAML
950        LOGICAL useGrdchk        LOGICAL useGrdchk
951          LOGICAL useSMOOTH
952        LOGICAL useECCO        LOGICAL useECCO
953        LOGICAL useSHAP_FILT        LOGICAL useSBO
       LOGICAL useZONAL_FILT  
954        LOGICAL useFLT        LOGICAL useFLT
955          LOGICAL usePTRACERS
956          LOGICAL useGCHEM
957          LOGICAL useRBCS
958          LOGICAL useOffLine
959          LOGICAL useMATRIX
960          LOGICAL useFRAZIL
961          LOGICAL useSEAICE
962          LOGICAL useSALT_PLUME
963          LOGICAL useShelfIce
964          LOGICAL useStreamIce
965          LOGICAL useICEFRONT
966          LOGICAL useThSIce
967          LOGICAL useATM2d
968          LOGICAL useAIM
969          LOGICAL useLand
970          LOGICAL useFizhi
971          LOGICAL useGridAlt
972          LOGICAL useDiagnostics
973          LOGICAL useREGRID
974          LOGICAL useLayers
975          LOGICAL useMNC
976          LOGICAL useRunClock
977          LOGICAL useEMBED_FILES
978          LOGICAL useMYPACKAGE
979        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
980       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
981       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
982         &        useGMRedi, useBBL, useDOWN_SLOPE,
983         &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
984         &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,
985         &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
986         &        useFRAZIL, useSEAICE, useSALT_PLUME, useShelfIce,
987         &        useStreamIce, useICEFRONT, useThSIce,
988         &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
989         &        useDiagnostics, useREGRID, useLayers, useMNC,
990         &        useRunClock, useEMBED_FILES,
991         &        useMYPACKAGE
992    
993    C     Logical flags for turning off parts of the code in adjoint mode
994          LOGICAL useKPPinAdMode, useKPPinFwdMode
995          LOGICAL useGMrediInAdMode, useGMrediInFwdMode
996          LOGICAL useSEAICEinAdMode, useSEAICEinFwdMode
997          COMMON /PARM_PACKAGES_ADJ/
998         &       useKPPinAdMode, useKPPinFwdMode,
999         &       useGMrediInAdMode, useGMrediInFwdMode,
1000         &       useSEAICEinAdMode, useSEAICEinFwdMode
1001    
1002    CEH3 ;;; Local Variables: ***
1003    CEH3 ;;; mode:fortran ***
1004    CEH3 ;;; End: ***

Legend:
Removed from v.1.68  
changed lines
  Added in v.1.261

  ViewVC Help
Powered by ViewVC 1.1.22