/[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.209 by dimitri, Wed Nov 28 09:26:16 2007 UTC revision 1.263 by gforget, Sat Jun 30 01:23:05 2012 UTC
# Line 24  C     Useful physical values Line 24  C     Useful physical values
24        Real*8 deg2rad        Real*8 deg2rad
25        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
26    
 C     Symbolic values  
 C     precXXXX :: Used to indicate what precision to use for  
 C                dumping model state.  
       INTEGER precFloat32  
       PARAMETER ( precFloat32 = 32 )  
       INTEGER precFloat64  
       PARAMETER ( precFloat64 = 64 )  
 C     UNSET_xxx :: Used to indicate variables that have not been given a value  
       Real*8 UNSET_FLOAT8  
       PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )  
       Real*4 UNSET_FLOAT4  
       PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )  
       _RL    UNSET_RL  
       PARAMETER ( UNSET_RL     = 1.234567D5 )  
       _RS    UNSET_RS  
       PARAMETER ( UNSET_RS     = 1.234567E5 )  
       INTEGER UNSET_I  
       PARAMETER ( UNSET_I      = 123456789  )  
   
27  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
28  C     buoyancyRelation :: Flag used to indicate which relation to use to  C     buoyancyRelation :: Flag used to indicate which relation to use to
29  C                         get buoyancy.  C                         get buoyancy.
# Line 52  C     pickupSuff      :: force to start Line 33  C     pickupSuff      :: force to start
33  C                        and read pickup files with this suffix (max 10 Char.)  C                        and read pickup files with this suffix (max 10 Char.)
34  C     mdsioLocalDir   :: read-write tiled file from/to this directory name  C     mdsioLocalDir   :: read-write tiled file from/to this directory name
35  C                        (+ 4 digits Processor-Rank) instead of current dir.  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)  C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
42  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
43  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
44  C     delRFile      :: File containing vertical grid spacing delR  (1.D array)  C     delRFile      :: File containing vertical grid spacing delR  (1.D array)
45  C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)  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)  C     delXFile      :: File containing X-spacing grid definition (1.D array)
48  C     delYFile      :: File containing Y-spacing grid definition (1.D array)  C     delYFile      :: File containing Y-spacing grid definition (1.D array)
49  C     horizGridFile :: File containing horizontal-grid definition  C     horizGridFile :: File containing horizontal-grid definition
# Line 65  C     bathyFile       :: File containing Line 52  C     bathyFile       :: File containing
52  C                        is taken from inline function.  C                        is taken from inline function.
53  C     topoFile        :: File containing the topography of the surface (unit=m)  C     topoFile        :: File containing the topography of the surface (unit=m)
54  C                        (mainly used for the atmosphere = ground height).  C                        (mainly used for the atmosphere = ground height).
 C     shelfIceFile    :: File containing the topography of the shelfice draught  
 C                        (unit=m)  
55  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
56  C                        for potential temperature.  C                        for potential temperature.
57  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
58  C                        for salinity.  C                        for salinity.
59  C     diffKrFile      :: File containing 3D specification of vertical diffusivity  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 surface 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 surface 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, excluding SW  C     surfQfile       :: File containing surface heat flux, excluding SW
71  C                        (old version, kept for backward compatibility)  C                        (old version, kept for backward compatibility)
72  C     surfQnetFile    :: File containing surface net heat flux  C     surfQnetFile    :: File containing surface net heat flux
73  C     surfQswFile     :: File containing surface shortwave radiation  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           NOTE: for backward compatibility EmPmRfile is specified in
77    C                 m/s when using external_fields_load.F.  It is converted
78    C                 to kg/m2/s by multiplying by rhoConstFresh.
79  C     saltFluxFile    :: File containing surface salt flux  C     saltFluxFile    :: File containing surface salt flux
80  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
81  C     eddyTauxFile    :: File containing zonal Eddy stress data  C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data
82  C     eddyTauyFile    :: File containing meridional Eddy stress data  C     eddyPsiYFile    :: File containing meridional Eddy streamfunction data
83  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
84        COMMON /PARM_C/        COMMON /PARM_C/
85       &                buoyancyRelation, eosType,       &                buoyancyRelation, eosType,
86       &                pickupSuff, mdsioLocalDir,       &                pickupSuff, mdsioLocalDir, adTapeDir,
87       &                tRefFile, sRefFile, rhoRefFile,       &                tRefFile, sRefFile, rhoRefFile,
88       &                delRFile, delRcFile,       &                delRFile, delRcFile, hybSigmFile,
89       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
90       &                bathyFile, topoFile, shelfIceFile,       &                bathyFile, topoFile,
91         &                viscAhDfile, viscAhZfile,
92         &                viscA4Dfile, viscA4Zfile,
93       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
94       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
95       &                saltClimFile,       &                saltClimFile,
# Line 104  C     the_run_name    :: string identify Line 98  C     the_run_name    :: string identify
98       &                lambdaThetaFile, lambdaSaltFile,       &                lambdaThetaFile, lambdaSaltFile,
99       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
100       &                dQdTfile, ploadFile,       &                dQdTfile, ploadFile,
101       &                eddyTauxFile, eddyTauyFile,       &                eddyPsiXFile, eddyPsiYFile,
102       &                the_run_name       &                the_run_name
103        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
104        CHARACTER*(6)  eosType        CHARACTER*(6)  eosType
105        CHARACTER*(10) pickupSuff        CHARACTER*(10) pickupSuff
106        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
107          CHARACTER*(MAX_LEN_FNAM) adTapeDir
108        CHARACTER*(MAX_LEN_FNAM) tRefFile        CHARACTER*(MAX_LEN_FNAM) tRefFile
109        CHARACTER*(MAX_LEN_FNAM) sRefFile        CHARACTER*(MAX_LEN_FNAM) sRefFile
110        CHARACTER*(MAX_LEN_FNAM) rhoRefFile        CHARACTER*(MAX_LEN_FNAM) rhoRefFile
111        CHARACTER*(MAX_LEN_FNAM) delRFile        CHARACTER*(MAX_LEN_FNAM) delRFile
112        CHARACTER*(MAX_LEN_FNAM) delRcFile        CHARACTER*(MAX_LEN_FNAM) delRcFile
113          CHARACTER*(MAX_LEN_FNAM) hybSigmFile
114        CHARACTER*(MAX_LEN_FNAM) delXFile        CHARACTER*(MAX_LEN_FNAM) delXFile
115        CHARACTER*(MAX_LEN_FNAM) delYFile        CHARACTER*(MAX_LEN_FNAM) delYFile
116        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
117        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
118        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
119        CHARACTER*(MAX_LEN_FNAM) diffKrFile        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
# Line 135  C     the_run_name    :: string identify Line 135  C     the_run_name    :: string identify
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        CHARACTER*(MAX_LEN_FNAM) ploadFile
138        CHARACTER*(MAX_LEN_FNAM) eddyTauxFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile
139        CHARACTER*(MAX_LEN_FNAM) eddyTauyFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile
140        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
141        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
142        CHARACTER*(MAX_LEN_PREC/2) the_run_name        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  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
150  C                            (non-linear free-surf.)  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
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     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  C     select_rStar        :: option related to r* vertical coordinate
170  C                           =0 (default) use r coord. ; > 0 use r*  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  C     momForcingOutAB     :: =1: take momentum forcing contribution
177  C                           out of (=0: in) Adams-Bashforth time stepping.  C                            out of (=0: in) Adams-Bashforth time stepping.
178  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
179  C                           out of (=0: in) Adams-Bashforth time stepping.  C                            out of (=0: in) Adams-Bashforth time stepping.
180  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
181  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
182  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
183  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
184  C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)  C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)
185  C     debugLevel          :: debug level selector: higher -> more writing  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, cg2dPreCondFreq,       &        cg3dMaxIters, cg3dChkResFreq,
194       &        cg3dMaxIters,       &        printResidualFreq,
      &        cg3dChkResFreq,  
195       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
196       &        writeStatePrec,       &        writeStatePrec,
197       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
198         &        selectCoriMap,
199         &        selectSigmaCoord,
200       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
201         &        selectNHfreeSurf,
202         &        selectAddFluid,
203       &        momForcingOutAB, tracForcingOutAB,       &        momForcingOutAB, tracForcingOutAB,
204       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
205       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
206       &        selectKEscheme,       &        selectKEscheme, selectVortScheme,
207       &        debugLevel       &        monitorSelect, debugLevel
208        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
209        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
210        INTEGER cg2dPreCondFreq        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
217        INTEGER writeStatePrec        INTEGER writeStatePrec
218        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
219        INTEGER readBinaryPrec        INTEGER readBinaryPrec
220          INTEGER selectCoriMap
221          INTEGER selectSigmaCoord
222        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
223        INTEGER select_rStar        INTEGER select_rStar
224          INTEGER selectNHfreeSurf
225          INTEGER selectAddFluid
226        INTEGER momForcingOutAB, tracForcingOutAB        INTEGER momForcingOutAB, tracForcingOutAB
227        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
228        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
229        INTEGER selectKEscheme        INTEGER selectKEscheme
230          INTEGER selectVortScheme
231          INTEGER monitorSelect
232        INTEGER debugLevel        INTEGER debugLevel
233    
 C  
       INTEGER debLevZero  
       PARAMETER(debLevZero=0)  
       INTEGER debLevA  
       PARAMETER(debLevA=1)  
       INTEGER debLevB  
       PARAMETER(debLevB=2)  
   
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     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  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)  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)  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
255  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  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     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     useNHMTerms   :: If TRUE use non-hydrostatic 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.
 C     tempAdvection :: Flag which turns advection of temperature on  
 C                     and off.  
 C     tempForcing   :: Flag which turns external forcing of temperature on  
 C                     and off.  
 C     saltAdvection :: Flag which turns advection of salinity on  
 C                     and off.  
 C     saltForcing   :: Flag which turns external forcing of salinity on  
 C                     and off.  
 C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  
 C                         as a real Fresh Water (=> changes the Sea Level)  
 C                         if F, converts P+R-E to salt flux (no SL effect)  
 C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable  
 C                       on irregular grids)  
 C     useAreaViscLength :: Set to true to use old scaling for viscous  
 C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.  
 C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms  
 C     rigidLid            :: Set to true to use rigid lid  
 C     implicitFreeSurface :: Set to true to use implicit free surface  
 C     exactConserv        :: Set to true to conserve exactly the total Volume  
 C     linFSConserveTr     :: Set to true to correct source/sink of tracer  
 C                            at the surface due to Linear Free Surface  
 C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the  
 C                           linear relation Phi_surf = Bo_surf*eta  
 C     use3Dsolver   :: set to true to use 3-D pressure solver  
 C     implicitIntGravWave :: treat Internal Gravity Wave implicitly  
 C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V  
 C     momStepping   :: Turns momentum equation time-stepping off  
 C     tempStepping  :: Turns temperature equation time-stepping off  
 C     saltStepping  :: Turns salinity equation time-stepping off  
 C     useConstantF  :: Coriolis parameter set to f0  
 C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  
 C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  
274  C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off  C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
275  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
276  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
277    C                                (default = F = use mom_fluxform package)
278    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986)
279  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
 C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny  
280  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
281  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
 C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)  
282  C     useAbsVorticity :: work with f+zeta in Coriolis terms  C     useAbsVorticity :: work with f+zeta in Coriolis terms
283    C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
284    C     momStepping    :: Turns momentum equation time-stepping off
285    C     calc_wVelocity :: Turns of vertical velocity calculation off
286    C- Temp. & Salt params:
287    C     tempStepping   :: Turns temperature equation time-stepping off
288    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
309    C     implicitFreeSurface :: Set to true to use implicit free surface
310    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
311    C                            linear relation Phi_surf = Bo_surf*eta
312    C     uniformFreeSurfLev  :: TRUE if free-surface level-index is uniform (=1)
313    C     exactConserv        :: Set to true to conserve exactly the total Volume
314    C     linFSConserveTr     :: Set to true to correct source/sink of tracer
315    C                            at the surface due to Linear Free Surface
316    C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
317    C                         as a real Fresh Water (=> changes the Sea Level)
318    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  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
# Line 284  C     momDissip_In_AB   :: if False, put Line 333  C     momDissip_In_AB   :: if False, put
333  C                          out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
334  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
335  C                          apply AB on tracer tendencies (rather than on Tracer)  C                          apply AB on tracer tendencies (rather than on Tracer)
336  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match  C- Other forcing params -
337  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     balanceEmPmR    :: substract global mean of EmPmR at every time step
338  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from  C     balanceQnet     :: substract global mean of Qnet at every time step
339  C                           before checkpoint-54a, Jul 06, 2004.  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     periodicExternalForcing :: Set true if forcing is time-dependant  C     balanceThetaClimRelax :: substract global mean effect at every time step
345  C     usingPCoords     :: Set to indicate that we are working in a pressure  C     balanceSaltClimRelax :: substract global mean effect at every time step
 C                        type coordinate (p or p*).  
 C     usingZCoords     :: Set to indicate that we are working in a height  
 C                        type coordinate (z or z*)  
 C     fluidIsAir       :: Set to indicate that the fluid major constituent  
 C                        is air  
 C     fluidIsWater     :: Set to indicate that the fluid major constituent  
 C                        is water  
 C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)  
 C                         this requires specific code for restart & exchange  
 C     setInterFDr    :: set Interface depth (put cell-Center at the middle)  
 C     setCenterDr    :: set cell-Center depth (put Interface at the middle)  
 C     nonHydrostatic :: Using non-hydrostatic terms  
 C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm  
 C     globalFiles    :: Selects between "global" and "tiled" files  
 C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  
 C                       slow (f77) or does not work (f90).  When  
 C                       useSingleCpuIO is set, mdsio_writefield.F  
 C                       outputs from master mpi process only.  
346  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
347  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
348    C     periodicExternalForcing :: Set true if forcing is time-dependant
349    C- I/O parameters -
350    C     globalFiles    :: Selects between "global" and "tiled" files.
351    C                       On some platforms with MPI, option globalFiles is either
352    C                       slow or does not work. Use useSingleCpuIO instead.
353    C     useSingleCpuIO :: moved to EEPARAMS.h
354    C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
355    C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
356    C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
357    C                           before checkpoint-54a, Jul 06, 2004.
358  C     pickup_write_mdsio :: use mdsio to write pickups  C     pickup_write_mdsio :: use mdsio to write pickups
359  C     pickup_read_mdsio  :: use mdsio to read  pickups  C     pickup_read_mdsio  :: use mdsio to read  pickups
360  C     pickup_write_immed :: echo the pickup immediately (for conversion)  C     pickup_write_immed :: echo the pickup immediately (for conversion)
361    C     writePickupAtEnd   :: write pickup at the last timestep
362  C     timeave_mdsio      :: use mdsio for timeave output  C     timeave_mdsio      :: use mdsio for timeave output
363  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
364  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
365  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
366  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
367  C     balanceEmPmR    :: substract global mean of EmPmR at every time step  C     printDomain     :: controls printing of domain fields (bathy, hFac ...).
 C     balanceQnet     :: substract global mean of Qnet at every time step  
 C     balancePrintMean:: print substracted global means to STDOUT  
368    
369        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/
370         & fluidIsAir, fluidIsWater,
371         & usingPCoords, usingZCoords, useDynP_inEos_Zc,
372         & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
373       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
374       & deepAtmosphere, setInterFDr, setCenterDr,       & deepAtmosphere, setInterFDr, setCenterDr,
375       & no_slip_sides,no_slip_bottom,       & no_slip_sides, no_slip_bottom,
376       & momViscosity, momAdvection, momForcing, useCoriolis,       & useFullLeith, useStrainTensionVisc, useAreaViscLength,
377       & momPressureForcing, vectorInvariantMomentum,       & momViscosity, momAdvection, momForcing,
378       & tempAdvection, tempForcing,       & momPressureForcing, metricTerms, useNHMTerms,
379       & saltAdvection, saltForcing,       & useCoriolis, use3dCoriolis,
380       & useRealFreshWaterFlux,       & useCDscheme, vectorInvariantMomentum,
      & useFullLeith, useStrainTensionVisc,  
      & useAreaViscLength,  
      & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,  
      & uniformLin_PhiSurf,  
      & use3Dsolver, implicitIntGravWave, staggerTimeStep,  
      & momStepping, tempStepping, saltStepping,  
      & metricTerms, useNHMTerms,  
      & useConstantF, useBetaPlaneF, useSphereF, use3dCoriolis,  
      & useCDscheme,  
381       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
382       & SadournyCoriolis, upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
383       & useAbsVorticity, upwindShear,       & useAbsVorticity, upwindShear,
384         & momStepping, calc_wVelocity, tempStepping, saltStepping,
385         & tempAdvection, tempVertDiff4, tempIsActiveTr, tempForcing,
386         & saltAdvection, saltVertDiff4, saltIsActiveTr, saltForcing,
387         & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
388         & useSRCGSolver,
389         & rigidLid, implicitFreeSurface,
390         & uniformLin_PhiSurf, uniformFreeSurfLev,
391         & exactConserv, linFSConserveTr, useRealFreshWaterFlux,
392         & quasiHydrostatic, nonHydrostatic, use3Dsolver,
393         & implicitIntGravWave, staggerTimeStep, doResetHFactors,
394       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
395       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
396       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
397       & momDissip_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
398       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & balanceEmPmR, balanceQnet, balancePrintMean,
399       & periodicExternalForcing,       & balanceThetaClimRelax, balanceSaltClimRelax,
400       & fluidIsAir, fluidIsWater,       & doThetaClimRelax, doSaltClimRelax,
      & usingPCoords, usingZCoords, useDynP_inEos_Zc,  
      & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,  
401       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
402         & periodicExternalForcing,
403         & globalFiles,
404       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
405       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
406         & writePickupAtEnd,
407       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
408       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast,
409       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & printDomain,
410       & balanceEmPmR, balanceQnet, balancePrintMean       & inAdMode, inAdTrue, inAdFalse, inAdExact
411    
412          LOGICAL fluidIsAir
413          LOGICAL fluidIsWater
414          LOGICAL usingPCoords
415          LOGICAL usingZCoords
416          LOGICAL useDynP_inEos_Zc
417        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
418        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid, rotateGrid
419        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
420        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
421        LOGICAL deepAtmosphere        LOGICAL deepAtmosphere
# Line 374  C     balancePrintMean:: print substract Line 424  C     balancePrintMean:: print substract
424        LOGICAL useNHMTerms        LOGICAL useNHMTerms
425        LOGICAL no_slip_sides        LOGICAL no_slip_sides
426        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
427          LOGICAL useFullLeith
428          LOGICAL useStrainTensionVisc
429          LOGICAL useAreaViscLength
430        LOGICAL momViscosity        LOGICAL momViscosity
431        LOGICAL momAdvection        LOGICAL momAdvection
432        LOGICAL momForcing        LOGICAL momForcing
# Line 381  C     balancePrintMean:: print substract Line 434  C     balancePrintMean:: print substract
434        LOGICAL useCoriolis        LOGICAL useCoriolis
435        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
436        LOGICAL tempAdvection        LOGICAL tempAdvection
437          LOGICAL tempVertDiff4
438          LOGICAL tempIsActiveTr
439        LOGICAL tempForcing        LOGICAL tempForcing
440        LOGICAL saltAdvection        LOGICAL saltAdvection
441          LOGICAL saltVertDiff4
442          LOGICAL saltIsActiveTr
443        LOGICAL saltForcing        LOGICAL saltForcing
444        LOGICAL useRealFreshWaterFlux        LOGICAL maskIniTemp
445        LOGICAL useFullLeith        LOGICAL maskIniSalt
446        LOGICAL useStrainTensionVisc        LOGICAL checkIniTemp
447        LOGICAL useAreaViscLength        LOGICAL checkIniSalt
448          LOGICAL useSRCGSolver
449        LOGICAL rigidLid        LOGICAL rigidLid
450        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
451          LOGICAL uniformLin_PhiSurf
452          LOGICAL uniformFreeSurfLev
453        LOGICAL exactConserv        LOGICAL exactConserv
454        LOGICAL linFSConserveTr        LOGICAL linFSConserveTr
455        LOGICAL uniformLin_PhiSurf        LOGICAL useRealFreshWaterFlux
456          LOGICAL quasiHydrostatic
457          LOGICAL nonHydrostatic
458        LOGICAL use3Dsolver        LOGICAL use3Dsolver
459        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
460        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
461          LOGICAL doResetHFactors
462        LOGICAL momStepping        LOGICAL momStepping
463          LOGICAL calc_wVelocity
464        LOGICAL tempStepping        LOGICAL tempStepping
465        LOGICAL saltStepping        LOGICAL saltStepping
466        LOGICAL metricTerms        LOGICAL metricTerms
       LOGICAL useConstantF  
       LOGICAL useBetaPlaneF  
       LOGICAL useSphereF  
467        LOGICAL use3dCoriolis        LOGICAL use3dCoriolis
468        LOGICAL useCDscheme        LOGICAL useCDscheme
469        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
470        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
471        LOGICAL useJamartMomAdv        LOGICAL useJamartMomAdv
       LOGICAL SadournyCoriolis  
472        LOGICAL upwindVorticity        LOGICAL upwindVorticity
473        LOGICAL highOrderVorticity        LOGICAL highOrderVorticity
474        LOGICAL useAbsVorticity        LOGICAL useAbsVorticity
# Line 422  C     balancePrintMean:: print substract Line 482  C     balancePrintMean:: print substract
482        LOGICAL useMultiDimAdvec        LOGICAL useMultiDimAdvec
483        LOGICAL momDissip_In_AB        LOGICAL momDissip_In_AB
484        LOGICAL doAB_onGtGs        LOGICAL doAB_onGtGs
485          LOGICAL balanceEmPmR
486          LOGICAL balanceQnet
487          LOGICAL balancePrintMean
488        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
489        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
490        LOGICAL doTr1ClimRelax        LOGICAL balanceThetaClimRelax
491        LOGICAL periodicExternalForcing        LOGICAL balanceSaltClimRelax
       LOGICAL fluidIsAir  
       LOGICAL fluidIsWater  
       LOGICAL usingPCoords  
       LOGICAL usingZCoords  
       LOGICAL useDynP_inEos_Zc  
       LOGICAL nonHydrostatic  
       LOGICAL quasiHydrostatic  
       LOGICAL globalFiles  
       LOGICAL useSingleCpuIO  
492        LOGICAL allowFreezing        LOGICAL allowFreezing
493        LOGICAL useOldFreezing        LOGICAL useOldFreezing
494          LOGICAL periodicExternalForcing
495          LOGICAL globalFiles
496        LOGICAL pickupStrictlyMatch        LOGICAL pickupStrictlyMatch
497        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
498        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
       LOGICAL dumpInitAndLast  
       LOGICAL debugMode  
499        LOGICAL pickup_read_mdsio, pickup_write_mdsio        LOGICAL pickup_read_mdsio, pickup_write_mdsio
500        LOGICAL pickup_write_immed        LOGICAL pickup_write_immed, writePickupAtEnd
501        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
502        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
503          LOGICAL dumpInitAndLast
504          LOGICAL printDomain
505        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
506    
       LOGICAL balanceEmPmR  
       LOGICAL balanceQnet  
       LOGICAL balancePrintMean  
   
507  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
508  C     cg2dTargetResidual  C     cg2dTargetResidual
509  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
# Line 476  C           defaults to 0.51 but can be Line 528  C           defaults to 0.51 but can be
528  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
529  C     delRc     :: Vertical grid spacing between cell centers (r unit).  C     delRc     :: Vertical grid spacing between cell centers (r unit).
530  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
531  C     delY        on input flags.  C     delY         on input flags. Note: moved to header file SET_GRID.h
532    C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
533    C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
534    C                :: parameter but it makes geographical references simple.)
535    C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
536    C                :: most face (Lat-Lon grid).
537  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
538  C     recip_gravity and its inverse  C     recip_gravity and its inverse
539  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 )
540  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
541  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density (Boussinesq)
542  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
543  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
544  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
545    C     rho1Ref   :: reference vertical profile for density
546  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
547  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
548  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
549  C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:  C     dBdrRef   :: vertical gradient of reference buoyancy  [(m/s/r)^2]:
550  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
551  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
552  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
# Line 505  C     rUnit2mass :: units conversion fac Line 563  C     rUnit2mass :: units conversion fac
563  C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].  C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
564  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
565  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
566  C     phiMin    :: Latitude of southern most cell face.  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
 C     thetaMin  :: Longitude of western most cell face (this  
 C                 is an "inert" parameter but it is included  
 C                 to make geographical references simple.)  
 C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).  
567  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
568  C     f0        :: Reference coriolis parameter ( 1/s )  C     radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
569  C                 ( Southern edge f for beta plane )  C     f0         :: Reference coriolis parameter ( 1/s )
570  C     beta      :: df/dy ( s^-1.m^-1 )  C                   ( Southern edge f for beta plane )
571  C     omega     :: Angular velocity ( rad/s )  C     beta       :: df/dy ( s^-1.m^-1 )
572    C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
573    C                   of rotation (reference value = 2.Omega.Cos(Phi))
574    C     omega      :: Angular velocity ( rad/s )
575  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
576  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
577  C                 momentum laterally ( m^2/s )  C                   for vertical mixing of momentum ( units of r^2/s )
578  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical  C     viscAh     :: Eddy viscosity coeff. for mixing of
 C                 momentum laterally, no effect for hydrostatic  
 C                 model, defaults to viscAh if unset ( m^2/s )  
 C                 Not used if variable horiz. viscosity is used.  
 C     viscAr    :: Eddy viscosity coeff. for mixing of  
 C                 momentum vertically ( units of r^2/s )  
 C     viscA4    :: Biharmonic viscosity coeff. for mixing of  
 C                 momentum laterally ( m^4/s )  
 C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical  
 C                 momentum laterally, no effect for hydrostatic  
 C                 model, defaults to viscA4 if unset ( m^2/s )  
 C                 Not used if variable horiz. viscosity is used.  
 C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally  
 C                  (act on Divergence part) ( m^2/s )  
 C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally  
 C                  (act on Vorticity  part) ( m^2/s )  
 C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally  
 C                  (act on Divergence part) ( m^4/s )  
 C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  
 C                  (act on Vorticity  part) ( m^4/s )  
 C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))  
 C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))  
 C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor (harmonic)  
 C     viscC4smag  :: Smagorinsky non-dimensional viscosity factor (biharmonic)  
 C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  
579  C                   momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
580  C     viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
581  C                   coeff. for mixing of momentum laterally (non-dim)  C                   momentum laterally, no effect for hydrostatic
582    C                   model, defaults to viscAh if unset ( m^2/s )
583    C                   Not used if variable horiz. viscosity is used.
584    C     viscA4     :: Biharmonic viscosity coeff. for mixing of
585    C                   momentum laterally ( m^4/s )
586    C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
587    C                   momentum laterally, no effect for hydrostatic
588    C                   model, defaults to viscA4 if unset ( m^2/s )
589    C                   Not used if variable horiz. viscosity is used.
590    C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
591    C                   (act on Divergence part) ( m^2/s )
592    C     viscAhZ    :: Eddy viscosity coeff. for mixing of momentum laterally
593    C                   (act on Vorticity  part) ( m^2/s )
594    C     viscA4D    :: Biharmonic viscosity coeff. for mixing of momentum laterally
595    C                   (act on Divergence part) ( m^4/s )
596    C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
597    C                   (act on Vorticity  part) ( m^4/s )
598    C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
599    C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
600    C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
601    C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
602    C     viscC2smag   :: Smagorinsky non-dimensional viscosity factor (harmonic)
603    C     viscC4smag   :: Smagorinsky non-dimensional viscosity factor (biharmonic)
604    C     viscAhMax    :: Maximum eddy viscosity coeff. for mixing of
605    C                    momentum laterally ( m^2/s )
606    C     viscAhReMax  :: Maximum gridscale Reynolds number for eddy viscosity
607    C                     coeff. for mixing of momentum laterally (non-dim)
608    C     viscAhGrid   :: non-dimensional grid-size dependent viscosity
609  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
610  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
611  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max    :: Maximum biharmonic viscosity coeff. for mixing of
612  C                 momentum laterally ( m^4/s )  C                     momentum laterally ( m^4/s )
613  C     viscA4ReMax :: Maximum Gridscale Reynolds number for  C     viscA4ReMax  :: Maximum Gridscale Reynolds number for
614  C                  biharmonic viscosity coeff. momentum laterally (non-dim)  C                     biharmonic viscosity coeff. momentum laterally (non-dim)
615  C     viscAhGrid:: non-dimensional grid-size dependent viscosity  C     viscA4Grid   :: non-dimensional grid-size dependent bi-harmonic viscosity
 C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity  
616  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
617  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
 C     viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))  
 C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))  
618  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
619  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
 C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.  
 C                 for mixing of heat vertically ( units of r^2/s )  
620  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
621  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
622    C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
623    C                 for mixing of heat vertically ( units of r^2/s )
624    C     diffKr4T  :: vertical profile of Biharmonic diffusion coeff.
625    C                 for mixing of heat vertically ( units of r^4/s )
626  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
627  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
 C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.  
 C                 for mixing of salt vertically ( units of r^2/s ),  
628  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
629  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
630    C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
631    C                 for mixing of salt vertically ( units of r^2/s ),
632    C     diffKr4S  :: vertical profile of Biharmonic diffusion coeff.
633    C                 for mixing of salt vertically ( units of r^4/s )
634  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
635  C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979  C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
636  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
# Line 590  C                    are referenced to t Line 651  C                    are referenced to t
651  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
652  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
653  C     deltaTfreesurf :: Timestep for free-surface equation ( s )  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
654  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freeSurfFac  :: Parameter to turn implicit free surface term on or off
655  C                    freesurfac = 1. uses implicit free surface  C                     freeSurFac = 1. uses implicit free surface
656  C                    freesurfac = 0. uses rigid lid  C                     freeSurFac = 0. uses rigid lid
657  C     abEps        :: Adams-Bashforth-2 stabilizing weight  C     abEps        :: Adams-Bashforth-2 stabilizing weight
658  C     alph_AB      :: Adams-Bashforth-3 primary factor  C     alph_AB      :: Adams-Bashforth-3 primary factor
659  C     beta_AB      :: Adams-Bashforth-3 secondary factor  C     beta_AB      :: Adams-Bashforth-3 secondary factor
# Line 600  C     implicSurfPress :: parameter of th Line 661  C     implicSurfPress :: parameter of th
661  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
662  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
663  C                     Implicit part of barotropic flow Divergence ( 0-1 )  C                     Implicit part of barotropic flow Divergence ( 0-1 )
664    C     implicitNHPress :: parameter of the Crank-Nickelson time stepping :
665    C                     Implicit part of Non-Hydrostatic Pressure Gradient ( 0-1 )
666  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
667  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    :: Minimum dimensional size of a cell (affects hFacC etc..., m)
668  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    :: Minimum dimensional size of a cell (affects hFacC etc..., Pa)
669  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)
670  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
671  C     hFacSup        that control vanishing and creating levels  C     hFacSup          that control vanishing and creating levels
672  C     tauCD        :: CD scheme coupling timescale ( 1/s )  C     tauCD         :: CD scheme coupling timescale ( s )
673  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )  C     rCD           :: CD scheme normalised coupling parameter (= 1 - deltaT/tauCD)
674    C     epsAB_CD      :: Adams-Bashforth-2 stabilizing weight used in CD scheme
675  C     baseTime      :: model base time (time origin) = time @ iteration zero  C     baseTime      :: model base time (time origin) = time @ iteration zero
676  C     startTime     :: Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
677  C     endTime       :: Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
678  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
679  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
680  C     dumpFreq      :: Frequency with which model state is written to  C     dumpFreq      :: Frequency with which model state is written to
681  C                     post-processing files ( s ).  C                      post-processing files ( s ).
682  C     diagFreq      :: Frequency with which model writes diagnostic output  C     diagFreq      :: Frequency with which model writes diagnostic output
683  C                     of intermediate quantities.  C                      of intermediate quantities.
684  C     afFacMom      :: Advection of momentum term tracer parameter  C     afFacMom      :: Advection of momentum term tracer parameter
685  C     vfFacMom      :: Momentum viscosity tracer parameter  C     vfFacMom      :: Momentum viscosity tracer parameter
686  C     pfFacMom      :: Momentum pressure forcing tracer parameter  C     pfFacMom      :: Momentum pressure forcing tracer parameter
# Line 626  C     mtFacMom      :: Metric terms trac Line 690  C     mtFacMom      :: Metric terms trac
690  C     cosPower      :: Power of cosine of latitude to multiply viscosity  C     cosPower      :: Power of cosine of latitude to multiply viscosity
691  C     cAdjFreq      :: Frequency of convective adjustment  C     cAdjFreq      :: Frequency of convective adjustment
692  C  C
693  C     taveFreq      :: Frequency with which time-averaged model state  C     taveFreq      :: Frequency with which time-averaged model state
694  C                      is written to post-processing files ( s ).  C                      is written to post-processing files ( s ).
695  C     tave_lastIter :: (for state variable only) fraction of the last time  C     tave_lastIter :: (for state variable only) fraction of the last time
696  C                      step (of each taveFreq period) put in the time average.  C                      step (of each taveFreq period) put in the time average.
697  C                      (fraction for 1rst iter = 1 - tave_lastIter)  C                      (fraction for 1rst iter = 1 - tave_lastIter)
698  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
699  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
# Line 641  C                          (note: extern Line 705  C                          (note: extern
705  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
706  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
707  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
708  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
709  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
710  C        (notes: a) tracer content of Rain/Evap only used if both  C     temp_addMass :: temperature of addMass array
711    C     salt_addMass :: salinity of addMass array
712    C        (notes: a) tracer content of Rain/Evap only used if both
713  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
714  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
715  C     hMixCrit    :: criteria for mixed-layer diagnostic  C     hMixCriteria:: criteria for mixed-layer diagnostic
716    C     dRhoSmall   :: parameter for mixed-layer diagnostic
717    C     hMixSmooth  :: Smoothing parameter for mixed-layer diag (default=0=no smoothing)
718  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
719  C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as  C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
720  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
721  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)  C     rSigmaBnd   :: vertical position (in r-unit) of r/sigma transition (Hybrid-Sigma)
722    C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
723  C                           (default=2: full drag ; =1: gives half-slip BC)  C                           (default=2: full drag ; =1: gives half-slip BC)
724  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
725  C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)  C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
# Line 660  C                           is to be rep Line 729  C                           is to be rep
729  C                           (affects myabs, mymin, mymax)  C                           (affects myabs, mymin, mymax)
730  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
731  C                      (i.e. allows convection at different Rayleigh numbers)  C                      (i.e. allows convection at different Rayleigh numbers)
732    C     phiEuler      :: Euler angle, rotation about original z-axis
733    C     thetaEuler    :: Euler angle, rotation about new x-axis
734    C     psiEuler      :: Euler angle, rotation about new z-axis
735        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
736       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
737       & delR, delRc, delX, delY,       & delR, delRc, xgOrigin, ygOrigin,
738       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
739       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
740       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & rSphere, recip_rSphere, radius_fromHorizGrid,
741       & viscAh, viscAhW, viscAhMax,       & f0, beta, fPrime, omega, rotationPeriod,
742         & viscFacAdj, viscAh, viscAhW, viscAhMax,
743       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
744       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
745       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
746       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
747       & viscA4, viscA4W,       & viscA4, viscA4W, viscA4Max,
748       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Grid, viscA4GridMax, viscA4GridMin,
749       & viscAhRemax, viscA4Remax,       & viscAhReMax, viscA4ReMax,
750       & viscC4leith, viscC4leithD, viscAr,       & viscC4leith, viscC4leithD, viscArNr,
751       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT, diffKr4T,
752       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS, diffKr4S,
753       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
754       & BL79LatVary,       & BL79LatVary,
755       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
756       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & tauCD, rCD, epsAB_CD,
757         & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
758       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
759       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
760       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhoNil, rhoConst, recip_rhoConst,
761       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
762       & rhoConstFresh, tRef, sRef, phiRef, dBdrRef,       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
763       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
764       & baseTime, startTime, endTime,       & baseTime, startTime, endTime,
765       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
766       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
767       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
768       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq,
769       & tauThetaClimRelax, tauSaltClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
      & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,  
770       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
771       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
772       & hFacMinDr, hFacMinDp,       & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
773       & ivdc_kappa, hMixCriteria, Ro_SeaLevel,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth,
774         & Ro_SeaLevel, rSigmaBnd,
775       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
776       & smoothAbsFuncRange,       & smoothAbsFuncRange,
777       & tCylIn, tCylOut       & tCylIn, tCylOut,
778         & phiEuler, thetaEuler, psiEuler
779    
780        _RL cg2dTargetResidual        _RL cg2dTargetResidual
781        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
# Line 708  C                      (i.e. allows conv Line 783  C                      (i.e. allows conv
783        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
784        _RL delR(Nr)        _RL delR(Nr)
785        _RL delRc(Nr+1)        _RL delRc(Nr+1)
786        _RL delX(Nx)        _RL xgOrigin
787        _RL delY(Ny)        _RL ygOrigin
788        _RL deltaT        _RL deltaT
789        _RL deltaTClock        _RL deltaTClock
790        _RL deltaTmom        _RL deltaTmom
791        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
792        _RL deltaTfreesurf        _RL deltaTfreesurf
793        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
       _RL phiMin  
       _RL thetaMin  
794        _RL rSphere        _RL rSphere
795        _RL recip_rSphere        _RL recip_rSphere
796          _RL radius_fromHorizGrid
797        _RL f0        _RL f0
798          _RL beta
799          _RL fPrime
800          _RL omega
801          _RL rotationPeriod
802        _RL freeSurfFac        _RL freeSurfFac
803        _RL implicSurfPress        _RL implicSurfPress
804        _RL implicDiv2Dflow        _RL implicDiv2Dflow
805          _RL implicitNHPress
806        _RL hFacMin        _RL hFacMin
807        _RL hFacMinDz        _RL hFacMinDz
808        _RL hFacMinDp        _RL hFacMinDp
809        _RL hFacMinDr        _RL hFacMinDr
810        _RL hFacInf        _RL hFacInf
811        _RL hFacSup        _RL hFacSup
812        _RL beta        _RL viscArNr(Nr)
813          _RL viscFacAdj
814        _RL viscAh        _RL viscAh
815        _RL viscAhW        _RL viscAhW
816        _RL viscAhD        _RL viscAhD
817        _RL viscAhZ        _RL viscAhZ
818        _RL viscAhMax        _RL viscAhMax
819        _RL viscAhReMax        _RL viscAhReMax
820        _RL viscAhGrid        _RL viscAhGrid, viscAhGridMax, viscAhGridMin
       _RL viscAhGridMax  
       _RL viscAhGridMin  
821        _RL viscC2leith        _RL viscC2leith
822        _RL viscC2leithD        _RL viscC2leithD
823        _RL viscC2smag        _RL viscC2smag
       _RL viscC4smag  
       _RL viscAr  
824        _RL viscA4        _RL viscA4
825        _RL viscA4W        _RL viscA4W
826        _RL viscA4D        _RL viscA4D
# Line 754  C                      (i.e. allows conv Line 830  C                      (i.e. allows conv
830        _RL viscA4Grid, viscA4GridMax, viscA4GridMin        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
831        _RL viscC4leith        _RL viscC4leith
832        _RL viscC4leithD        _RL viscC4leithD
833          _RL viscC4smag
834        _RL diffKhT        _RL diffKhT
       _RL diffKrNrT(Nr)  
835        _RL diffK4T        _RL diffK4T
836          _RL diffKrNrT(Nr)
837          _RL diffKr4T(Nr)
838        _RL diffKhS        _RL diffKhS
       _RL diffKrNrS(Nr)  
839        _RL diffK4S        _RL diffK4S
840          _RL diffKrNrS(Nr)
841          _RL diffKr4S(Nr)
842        _RL diffKrBL79surf        _RL diffKrBL79surf
843        _RL diffKrBL79deep        _RL diffKrBL79deep
844        _RL diffKrBL79scl        _RL diffKrBL79scl
# Line 769  C                      (i.e. allows conv Line 848  C                      (i.e. allows conv
848        _RL diffKrBLEQdeep        _RL diffKrBLEQdeep
849        _RL diffKrBLEQscl        _RL diffKrBLEQscl
850        _RL diffKrBLEQHo        _RL diffKrBLEQHo
851        _RL delt        _RL tauCD, rCD, epsAB_CD
       _RL tauCD  
       _RL rCD  
852        _RL gravity        _RL gravity
853        _RL recip_gravity        _RL recip_gravity
854        _RL gBaro        _RL gBaro
855        _RL rhonil,        recip_rhonil        _RL rhoNil
856        _RL rhoConst,      recip_rhoConst        _RL rhoConst,      recip_rhoConst
857        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
858        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
859        _RL rhoConstFresh        _RL rhoConstFresh
860          _RL rho1Ref(Nr)
861        _RL tRef(Nr)        _RL tRef(Nr)
862        _RL sRef(Nr)        _RL sRef(Nr)
863        _RL phiRef(2*Nr+1)        _RL phiRef(2*Nr+1)
# Line 806  C                      (i.e. allows conv Line 884  C                      (i.e. allows conv
884        _RL mtFacMom        _RL mtFacMom
885        _RL cosPower        _RL cosPower
886        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
       _RL rotationPeriod  
887        _RL tauThetaClimRelax        _RL tauThetaClimRelax
888        _RL tauSaltClimRelax        _RL tauSaltClimRelax
       _RL tauTr1ClimRelax  
       _RL lambdaTr1ClimRelax  
889        _RL latBandClimRelax        _RL latBandClimRelax
890        _RL externForcingCycle        _RL externForcingCycle
891        _RL externForcingPeriod        _RL externForcingPeriod
892        _RL convertFW2Salt        _RL convertFW2Salt
893        _RL temp_EvPrRn        _RL temp_EvPrRn
894        _RL salt_EvPrRn        _RL salt_EvPrRn
895          _RL temp_addMass
896          _RL salt_addMass
897        _RL ivdc_kappa        _RL ivdc_kappa
898        _RL hMixCriteria        _RL hMixCriteria
899          _RL dRhoSmall
900          _RL hMixSmooth
901        _RL Ro_SeaLevel        _RL Ro_SeaLevel
902          _RL rSigmaBnd
903        _RL sideDragFactor        _RL sideDragFactor
904        _RL bottomDragLinear        _RL bottomDragLinear
905        _RL bottomDragQuadratic        _RL bottomDragQuadratic
# Line 828  C                      (i.e. allows conv Line 907  C                      (i.e. allows conv
907        _RL nh_Am2        _RL nh_Am2
908        _RL tCylIn        _RL tCylIn
909        _RL tCylOut        _RL tCylOut
910          _RL phiEuler, thetaEuler, psiEuler
911    
912  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
913        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
# Line 843  C     atm_kappa :: kappa = R/Cp (R: cons Line 923  C     atm_kappa :: kappa = R/Cp (R: cons
923  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
924  C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])  C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
925  C     integr_GeoPot :: option to select the way we integrate the geopotential  C     integr_GeoPot :: option to select the way we integrate the geopotential
926  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
927  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
928  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
929        COMMON /PARM_ATM/        COMMON /PARM_ATM/
# Line 855  C             derived from the orography Line 935  C             derived from the orography
935        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
936    
937  C Logical flags for selecting packages  C Logical flags for selecting packages
938          LOGICAL useGAD
939          LOGICAL useOBCS
940          LOGICAL useSHAP_FILT
941          LOGICAL useZONAL_FILT
942        LOGICAL useOPPS        LOGICAL useOPPS
943        LOGICAL usePP81        LOGICAL usePP81
944        LOGICAL useMY82        LOGICAL useMY82
945        LOGICAL useGGL90        LOGICAL useGGL90
946        LOGICAL useKPP        LOGICAL useKPP
       LOGICAL useGAD  
947        LOGICAL useGMRedi        LOGICAL useGMRedi
948        LOGICAL useOBCS        LOGICAL useDOWN_SLOPE
949        LOGICAL useAIM        LOGICAL useBBL
       LOGICAL useLand  
950        LOGICAL useCAL        LOGICAL useCAL
951        LOGICAL useEXF        LOGICAL useEXF
952          LOGICAL useBulkForce
953        LOGICAL useEBM        LOGICAL useEBM
954          LOGICAL useCheapAML
955        LOGICAL useGrdchk        LOGICAL useGrdchk
956          LOGICAL useSMOOTH
957          LOGICAL usePROFILES
958        LOGICAL useECCO        LOGICAL useECCO
959        LOGICAL useSHAP_FILT        LOGICAL useSBO
       LOGICAL useZONAL_FILT  
960        LOGICAL useFLT        LOGICAL useFLT
961        LOGICAL usePTRACERS        LOGICAL usePTRACERS
962        LOGICAL useGCHEM        LOGICAL useGCHEM
963        LOGICAL useRBCS        LOGICAL useRBCS
964        LOGICAL useOffLine        LOGICAL useOffLine
965        LOGICAL useMATRIX        LOGICAL useMATRIX
966        LOGICAL useSBO        LOGICAL useFRAZIL
967        LOGICAL useSEAICE        LOGICAL useSEAICE
968          LOGICAL useSALT_PLUME
969        LOGICAL useShelfIce        LOGICAL useShelfIce
970          LOGICAL useStreamIce
971          LOGICAL useICEFRONT
972        LOGICAL useThSIce        LOGICAL useThSIce
973        LOGICAL useATM2d        LOGICAL useATM2d
974        LOGICAL useBulkForce        LOGICAL useAIM
975        LOGICAL usefizhi        LOGICAL useLand
976        LOGICAL usegridalt        LOGICAL useFizhi
977          LOGICAL useGridAlt
978        LOGICAL useDiagnostics        LOGICAL useDiagnostics
       LOGICAL useMNC  
979        LOGICAL useREGRID        LOGICAL useREGRID
980          LOGICAL useLayers
981          LOGICAL useMNC
982        LOGICAL useRunClock        LOGICAL useRunClock
983        LOGICAL useEMBED_FILES        LOGICAL useEMBED_FILES
984        LOGICAL useMYPACKAGE        LOGICAL useMYPACKAGE
       LOGICAL useSALT_PLUME  
985        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
986         &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
987       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
988       &        useGAD, useGMRedi, useOBCS, useAIM, useLand,       &        useGMRedi, useBBL, useDOWN_SLOPE,
989       &        useCAL, useEXF, useEBM, useGrdchk, useECCO,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
990       &        useSHAP_FILT, useZONAL_FILT, useFLT,       &        useGrdchk,useSMOOTH,usePROFILES,useECCO,useSBO, useFLT,
991       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
992       &        useSBO, useSEAICE, useShelfIce,       &        useFRAZIL, useSEAICE, useSALT_PLUME, useShelfIce,
993       &        useThSIce, useATM2D, useBulkForce,       &        useStreamIce, useICEFRONT, useThSIce,
994       &        usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
995       &        useRunClock, useEMBED_FILES, useMYPACKAGE, useSALT_PLUME       &        useDiagnostics, useREGRID, useLayers, useMNC,
996         &        useRunClock, useEMBED_FILES,
997         &        useMYPACKAGE
998    
999    C     Logical flags for turning off parts of the code in adjoint mode
1000          LOGICAL useKPPinAdMode, useKPPinFwdMode
1001          LOGICAL useGMrediInAdMode, useGMrediInFwdMode
1002          LOGICAL useSEAICEinAdMode, useSEAICEinFwdMode
1003          COMMON /PARM_PACKAGES_ADJ/
1004         &       useKPPinAdMode, useKPPinFwdMode,
1005         &       useGMrediInAdMode, useGMrediInFwdMode,
1006         &       useSEAICEinAdMode, useSEAICEinFwdMode
1007    
1008  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
1009  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
Legend:
Removed from v.1.209  
changed lines
  Added in v.1.263
  ViewVC Help
Powered by ViewVC 1.1.22