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