/[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.240 by mlosch, Sat Sep 25 23:09:54 2010 UTC revision 1.273 by jmc, Sat Feb 8 17:15:43 2014 UTC
# Line 14  C     here. Notes describing the paramet Line 14  C     here. Notes describing the paramet
14    
15  CEOP  CEOP
16    
 C     Macros for special grid options  
 #include "PARAMS_MACROS.h"  
   
17  C--   Contants  C--   Contants
18  C     Useful physical values  C     Useful physical values
19        Real*8 PI        Real*8 PI
# Line 33  C     pickupSuff      :: force to start Line 30  C     pickupSuff      :: force to start
30  C                        and read pickup files with this suffix (max 10 Char.)  C                        and read pickup files with this suffix (max 10 Char.)
31  C     mdsioLocalDir   :: read-write tiled file from/to this directory name  C     mdsioLocalDir   :: read-write tiled file from/to this directory name
32  C                        (+ 4 digits Processor-Rank) instead of current dir.  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)  C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
39  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
40  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
# Line 47  C     bathyFile       :: File containing Line 49  C     bathyFile       :: File containing
49  C                        is taken from inline function.  C                        is taken from inline function.
50  C     topoFile        :: File containing the topography of the surface (unit=m)  C     topoFile        :: File containing the topography of the surface (unit=m)
51  C                        (mainly used for the atmosphere = ground height).  C                        (mainly used for the atmosphere = ground height).
52    C     addWwallFile    :: File containing 2-D additional Western  cell-edge wall
53    C     addSwallFile    :: File containing 2-D additional Southern cell-edge wall
54    C                        (e.g., to add "thin-wall" where it is =1)
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)
# Line 59  C     viscA4Zfile     :: File containing Line 64  C     viscA4Zfile     :: File containing
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
 C     dQdTfile        :: File containing thermal relaxation coefficient  
74  C     EmPmRfile       :: File containing surface fresh water flux  C     EmPmRfile       :: File containing surface fresh water flux
75  C           NOTE: for backward compatibility EmPmRfile is specified in  C           NOTE: for backward compatibility EmPmRfile is specified in
76  C                 m/s when using external_fields_load.F.  It is converted  C                 m/s when using external_fields_load.F.  It is converted
77  C                 to kg/m2/s by multiplying by rhoConstFresh.  C                 to kg/m2/s by multiplying by rhoConstFresh.
78  C     saltFluxFile    :: File containing surface salt flux  C     saltFluxFile    :: File containing surface salt flux
79  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
80    C     addMassFile     :: File containing source/sink of fluid in the interior
81  C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data  C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data
82  C     eddyPsiYFile    :: File containing meridional Eddy streamfunction 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, hybSigmFile,       &                delRFile, delRcFile, hybSigmFile,
89       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
90       &                bathyFile, topoFile,       &                bathyFile, topoFile, addWwallFile, addSwallFile,
91       &                viscAhDfile, viscAhZfile,       &                viscAhDfile, viscAhZfile,
92       &                viscA4Dfile, viscA4Zfile,       &                viscA4Dfile, viscA4Zfile,
93       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
# Line 92  C     the_run_name    :: string identify Line 97  C     the_run_name    :: string identify
97       &                surfQfile, surfQnetFile, surfQswFile,       &                surfQfile, surfQnetFile, surfQswFile,
98       &                lambdaThetaFile, lambdaSaltFile,       &                lambdaThetaFile, lambdaSaltFile,
99       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
100       &                dQdTfile, ploadFile,       &                pLoadFile, addMassFile,
101       &                eddyPsiXFile, eddyPsiYFile,       &                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
# Line 109  C     the_run_name    :: string identify Line 115  C     the_run_name    :: string identify
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        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
118          CHARACTER*(MAX_LEN_FNAM) addWwallFile, addSwallFile
119        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
120        CHARACTER*(MAX_LEN_FNAM) diffKrFile        CHARACTER*(MAX_LEN_FNAM) diffKrFile
121        CHARACTER*(MAX_LEN_FNAM) viscAhDfile        CHARACTER*(MAX_LEN_FNAM) viscAhDfile
# Line 127  C     the_run_name    :: string identify Line 134  C     the_run_name    :: string identify
134        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
135        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
136        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
137        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) pLoadFile
138        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) addMassFile
139        CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile
140        CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile
141        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
# Line 137  C     the_run_name    :: string identify Line 144  C     the_run_name    :: string identify
144    
145  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
146  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
147  C                           two-dimensional con. grad solver.  C                            two-dimensional con. grad solver.
148  C     cg2dChkResFreq      :: Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
149  C                           in con. grad solver.  C                            in con. grad solver.
150  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
151  C                            (non-linear free-surf.)  C                            (non-linear free-surf.)
152    C     cg2dUseMinResSol    :: =0 : use last-iteration/converged solution
153    C                            =1 : use solver minimum-residual solution
154  C     cg3dMaxIters        :: Maximum number of iterations in the  C     cg3dMaxIters        :: Maximum number of iterations in the
155  C                           three-dimensional con. grad solver.  C                            three-dimensional con. grad solver.
156  C     cg3dChkResFreq      :: Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
157  C                           in con. grad solver.  C                            in con. grad solver.
158    C     printResidualFreq   :: Frequency for printing residual in CG iterations
159  C     nIter0              :: Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
160  C     nTimeSteps          :: Number of timesteps to execute  C     nTimeSteps          :: Number of timesteps to execute
161  C     writeStatePrec      :: Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
162  C     writeBinaryPrec     :: Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
163  C     readBinaryPrec      :: Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
164    C     selectCoriMap       :: select setting of Coriolis parameter map:
165    C                           =0 f-Plane (Constant Coriolis, = f0)
166    C                           =1 Beta-Plane Coriolis (= f0 + beta.y)
167    C                           =2 Spherical Coriolis (= 2.omega.sin(phi))
168    C                           =3 Read Coriolis 2-d fields from files.
169    C     selectSigmaCoord    :: option related to sigma vertical coordinate
170  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
171  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
172  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
173  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
174  C     selectNHfreeSurf    :: option for Non-Hydrostatic (free-)Surface formulation:  C     selectNHfreeSurf    :: option for Non-Hydrostatic (free-)Surface formulation:
175  C                           =0 (default) hydrostatic surf. ; > 0 add NH effects.  C                           =0 (default) hydrostatic surf. ; > 0 add NH effects.
 C     selectSigmaCoord    :: option related to sigma vertical coordinate  
176  C     selectAddFluid      :: option to add mass source/sink of fluid in the interior  C     selectAddFluid      :: option to add mass source/sink of fluid in the interior
177  C                            (3-D generalisation of oceanic real-fresh water flux)  C                            (3-D generalisation of oceanic real-fresh water flux)
178  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
179  C     momForcingOutAB     :: =1: take momentum forcing contribution  C     momForcingOutAB     :: =1: take momentum forcing contribution
180  C                           out of (=0: in) Adams-Bashforth time stepping.  C                            out of (=0: in) Adams-Bashforth time stepping.
181  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
182  C                           out of (=0: in) Adams-Bashforth time stepping.  C                            out of (=0: in) Adams-Bashforth time stepping.
183  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
184  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
185  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
# Line 173  C     selectKEscheme      :: Kinetic Ene Line 188  C     selectKEscheme      :: Kinetic Ene
188  C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)  C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)
189  C     monitorSelect       :: select group of variables to monitor  C     monitorSelect       :: select group of variables to monitor
190  C                            =1 : dynvars ; =2 : + vort ; =3 : + surface  C                            =1 : dynvars ; =2 : + vort ; =3 : + surface
191  C     debugLevel          :: debug level selector: higher -> more writing  C-    debugLevel          :: controls printing of algorithm intermediate results
192    C                            and statistics ; higher -> more writing
193    
194        COMMON /PARM_I/        COMMON /PARM_I/
195       &        cg2dMaxIters,       &        cg2dMaxIters, cg2dChkResFreq,
196       &        cg2dChkResFreq, cg2dPreCondFreq,       &        cg2dPreCondFreq, cg2dUseMinResSol,
197       &        cg3dMaxIters,       &        cg3dMaxIters, cg3dChkResFreq,
198       &        cg3dChkResFreq,       &        printResidualFreq,
199       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
200       &        writeStatePrec,       &        writeStatePrec,
201       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
202         &        selectCoriMap,
203         &        selectSigmaCoord,
204       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
205       &        selectNHfreeSurf,       &        selectNHfreeSurf,
      &        selectSigmaCoord,  
206       &        selectAddFluid,       &        selectAddFluid,
207       &        momForcingOutAB, tracForcingOutAB,       &        momForcingOutAB, tracForcingOutAB,
208       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
# Line 195  C     debugLevel          :: debug level Line 212  C     debugLevel          :: debug level
212        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
213        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
214        INTEGER cg2dPreCondFreq        INTEGER cg2dPreCondFreq
215          INTEGER cg2dUseMinResSol
216        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
217        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
218          INTEGER printResidualFreq
219        INTEGER nIter0        INTEGER nIter0
220        INTEGER nTimeSteps        INTEGER nTimeSteps
221        INTEGER nEndIter        INTEGER nEndIter
222        INTEGER writeStatePrec        INTEGER writeStatePrec
223        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
224        INTEGER readBinaryPrec        INTEGER readBinaryPrec
225          INTEGER selectCoriMap
226          INTEGER selectSigmaCoord
227        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
228        INTEGER select_rStar        INTEGER select_rStar
229        INTEGER selectNHfreeSurf        INTEGER selectNHfreeSurf
       INTEGER selectSigmaCoord  
230        INTEGER selectAddFluid        INTEGER selectAddFluid
231        INTEGER momForcingOutAB, tracForcingOutAB        INTEGER momForcingOutAB, tracForcingOutAB
232        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
# Line 219  C     debugLevel          :: debug level Line 239  C     debugLevel          :: debug level
239  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
240  C- Coordinate + Grid params:  C- Coordinate + Grid params:
241  C     fluidIsAir       :: Set to indicate that the fluid major constituent  C     fluidIsAir       :: Set to indicate that the fluid major constituent
242  C                        is air  C                         is air
243  C     fluidIsWater     :: Set to indicate that the fluid major constituent  C     fluidIsWater     :: Set to indicate that the fluid major constituent
244  C                        is water  C                         is water
245  C     usingPCoords     :: Set to indicate that we are working in a pressure  C     usingPCoords     :: Set to indicate that we are working in a pressure
246  C                        type coordinate (p or p*).  C                         type coordinate (p or p*).
247  C     usingZCoords     :: Set to indicate that we are working in a height  C     usingZCoords     :: Set to indicate that we are working in a height
248  C                        type coordinate (z or z*)  C                         type coordinate (z or z*)
249  C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)  C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
250  C                         this requires specific code for restart & exchange  C                         this requires specific code for restart & exchange
251  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
252  C                          coordinate frame.  C                           coordinate frame.
253  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
254  C                               spherical polar frame.  C                                spherical polar frame.
255  C     rotateGrid      :: rotate grid coordinates to geographical coordinates  C     rotateGrid      :: rotate grid coordinates to geographical coordinates
256  C                        according to Euler angles phiEuler, thetaEuler, psiEuler  C                        according to Euler angles phiEuler, thetaEuler, psiEuler
 C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)  
257  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
258    C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
259    C     hasWetCSCorners :: domain contains CS-type corners where dynamics is solved
260  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
261  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
262  C     setCenterDr    :: set cell-Center depth (put Interface at the middle)  C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
263  C- Momentum params:  C- Momentum params:
264  C     no_slip_sides  :: Impose "no-slip" at lateral boundaries.  C     no_slip_sides  :: Impose "no-slip" at lateral boundaries.
265  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
266    C     useSmag3D      :: Use isotropic 3-D Smagorinsky
267  C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable  C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
268  C                       on irregular grids)  C                       on irregular grids)
269  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
# Line 257  C     metricTerms   :: Flag which turns Line 279  C     metricTerms   :: Flag which turns
279  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
280  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
281  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
 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)  
282  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
283  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
284  C                                (default = F = use mom_fluxform package)  C                                (default = F = use mom_fluxform package)
# Line 270  C     highOrderVorticity :: use 3rd/4th Line 289  C     highOrderVorticity :: use 3rd/4th
289  C     useAbsVorticity :: work with f+zeta in Coriolis terms  C     useAbsVorticity :: work with f+zeta in Coriolis terms
290  C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)  C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
291  C     momStepping    :: Turns momentum equation time-stepping off  C     momStepping    :: Turns momentum equation time-stepping off
292    C     calc_wVelocity :: Turns of vertical velocity calculation off
293  C- Temp. & Salt params:  C- Temp. & Salt params:
294  C     tempStepping   :: Turns temperature equation time-stepping off  C     tempStepping   :: Turns temperature equation time-stepping on/off
295  C     saltStepping   :: Turns salinity equation time-stepping off  C     saltStepping   :: Turns salinity equation time-stepping on/off
296    C     addFrictionHeating :: account for frictional heating
297  C     tempAdvection  :: Flag which turns advection of temperature on and off.  C     tempAdvection  :: Flag which turns advection of temperature on and off.
298    C     tempVertDiff4  :: use vertical bi-harmonic diffusion for temperature
299  C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer  C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
300  C     tempForcing    :: Flag which turns external forcing of temperature on  C     tempForcing    :: Flag which turns external forcing of temperature on/off
 C                       and off.  
301  C     saltAdvection  :: Flag which turns advection of salinity on and off.  C     saltAdvection  :: Flag which turns advection of salinity on and off.
302    C     saltVertDiff4  :: use vertical bi-harmonic diffusion for salinity
303  C     saltIsActiveTr :: Salinity  is a dynamically active tracer  C     saltIsActiveTr :: Salinity  is a dynamically active tracer
304  C     saltForcing    :: Flag which turns external forcing of salinity on  C     saltForcing    :: Flag which turns external forcing of salinity on/off
 C                       and off.  
305  C     maskIniTemp    :: apply mask to initial Pot.Temp.  C     maskIniTemp    :: apply mask to initial Pot.Temp.
306  C     maskIniSalt    :: apply mask to initial salinity  C     maskIniSalt    :: apply mask to initial salinity
307  C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.  C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
308  C     checkIniSalt   :: check for points with identically zero initial salinity  C     checkIniSalt   :: check for points with identically zero initial salinity
 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)  
309  C- Pressure solver related parameters (PARM02)  C- Pressure solver related parameters (PARM02)
310  C     useSRCGSolver  :: Set to true to use conjugate gradient  C     useSRCGSolver  :: Set to true to use conjugate gradient
311  C                       solver with single reduction (only one call of  C                       solver with single reduction (only one call of
312  C                       s/r mpi_allreduce), default is false  C                       s/r mpi_allreduce), default is false
313  C- Time-stepping params:  C- Time-stepping & free-surface params:
314  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
315  C     implicitFreeSurface :: Set to true to use implicit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
316    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
317    C                            linear relation Phi_surf = Bo_surf*eta
318    C     uniformFreeSurfLev  :: TRUE if free-surface level-index is uniform (=1)
319  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
320  C     linFSConserveTr     :: Set to true to correct source/sink of tracer  C     linFSConserveTr     :: Set to true to correct source/sink of tracer
321  C                            at the surface due to Linear Free Surface  C                            at the surface due to Linear Free Surface
322  C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
323  C                            linear relation Phi_surf = Bo_surf*eta  C                         as a real Fresh Water (=> changes the Sea Level)
324    C                         if F, converts P+R-E to salt flux (no SL effect)
325  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
326  C     nonHydrostatic   :: Using non-hydrostatic algorithm  C     nonHydrostatic   :: Using non-hydrostatic algorithm
327  C     use3Dsolver      :: set to true to use 3-D pressure solver  C     use3Dsolver      :: set to true to use 3-D pressure solver
328  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
329  C     staggerTimeStep   :: enable a Stagger time stepping U,V (& W) then T,S  C     staggerTimeStep   :: enable a Stagger time stepping U,V (& W) then T,S
330    C     doResetHFactors   :: Do reset thickness factors @ beginning of each time-step
331  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
332  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
333  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
# Line 324  C     doThetaClimRelax :: Set true if re Line 347  C     doThetaClimRelax :: Set true if re
347  C                        climatology is required.  C                        climatology is required.
348  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
349  C                        climatology is required.  C                        climatology is required.
350    C     balanceThetaClimRelax :: substract global mean effect at every time step
351    C     balanceSaltClimRelax :: substract global mean effect at every time step
352  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
 C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  
353  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
354  C- I/O parameters -  C- I/O parameters -
355  C     globalFiles    :: Selects between "global" and "tiled" files.  C     globalFiles    :: Selects between "global" and "tiled" files.
# Line 345  C     snapshot_mdsio     :: use mdsio fo Line 369  C     snapshot_mdsio     :: use mdsio fo
369  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
370  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
371  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
372    C     printDomain     :: controls printing of domain fields (bathy, hFac ...).
373    
374        COMMON /PARM_L/        COMMON /PARM_L/
375       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
376       & usingPCoords, usingZCoords, useDynP_inEos_Zc,       & usingPCoords, usingZCoords, useDynP_inEos_Zc,
377       & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,       & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
378       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCylindricalGrid, usingCurvilinearGrid, hasWetCSCorners,
379       & deepAtmosphere, setInterFDr, setCenterDr,       & deepAtmosphere, setInterFDr, setCenterDr,
380       & no_slip_sides, no_slip_bottom,       & no_slip_sides, no_slip_bottom, useSmag3D,
381       & useFullLeith, useStrainTensionVisc, useAreaViscLength,       & useFullLeith, useStrainTensionVisc, useAreaViscLength,
382       & momViscosity, momAdvection, momForcing,       & momViscosity, momAdvection, momForcing,
383       & momPressureForcing, metricTerms, useNHMTerms,       & momPressureForcing, metricTerms, useNHMTerms,
384       & useCoriolis, use3dCoriolis,       & useCoriolis, use3dCoriolis,
      & useConstantF, useBetaPlaneF, useSphereF,  
385       & useCDscheme, vectorInvariantMomentum,       & useCDscheme, vectorInvariantMomentum,
386       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
387       & upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
388       & useAbsVorticity, upwindShear,       & useAbsVorticity, upwindShear,
389       & momStepping, tempStepping, saltStepping,       & momStepping, calc_wVelocity, tempStepping, saltStepping,
390       & tempAdvection, tempIsActiveTr, tempForcing,       & addFrictionHeating,
391       & saltAdvection, saltIsActiveTr, saltForcing,       & tempAdvection, tempVertDiff4, tempIsActiveTr, tempForcing,
392         & saltAdvection, saltVertDiff4, saltIsActiveTr, saltForcing,
393       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
394       & useRealFreshWaterFlux,       & useSRCGSolver,
395       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface,
396       & uniformLin_PhiSurf,       & uniformLin_PhiSurf, uniformFreeSurfLev,
397       & quasiHydrostatic, nonHydrostatic,       & exactConserv, linFSConserveTr, useRealFreshWaterFlux,
398       & use3Dsolver, implicitIntGravWave, staggerTimeStep,       & quasiHydrostatic, nonHydrostatic, use3Dsolver,
399         & implicitIntGravWave, staggerTimeStep, doResetHFactors,
400       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
401       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
402       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
403       & momDissip_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
404       & balanceEmPmR, balanceQnet, balancePrintMean,       & balanceEmPmR, balanceQnet, balancePrintMean,
405         & balanceThetaClimRelax, balanceSaltClimRelax,
406       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
407       & allowFreezing, useOldFreezing,       & allowFreezing,
408       & periodicExternalForcing,       & periodicExternalForcing,
409       & globalFiles,       & globalFiles,
410       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
411       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
412       & writePickupAtEnd,       & writePickupAtEnd,
413       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
414       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast,
415       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & printDomain
      & useSRCGSolver  
416    
417        LOGICAL fluidIsAir        LOGICAL fluidIsAir
418        LOGICAL fluidIsWater        LOGICAL fluidIsWater
# Line 396  C                        & Last iteratio Line 422  C                        & Last iteratio
422        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
423        LOGICAL usingSphericalPolarGrid, rotateGrid        LOGICAL usingSphericalPolarGrid, rotateGrid
424        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
425        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid, hasWetCSCorners
426        LOGICAL deepAtmosphere        LOGICAL deepAtmosphere
427        LOGICAL setInterFDr        LOGICAL setInterFDr
428        LOGICAL setCenterDr        LOGICAL setCenterDr
429        LOGICAL useNHMTerms  
430        LOGICAL no_slip_sides        LOGICAL no_slip_sides
431        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
432          LOGICAL useSmag3D
433          LOGICAL useFullLeith
434          LOGICAL useStrainTensionVisc
435          LOGICAL useAreaViscLength
436        LOGICAL momViscosity        LOGICAL momViscosity
437        LOGICAL momAdvection        LOGICAL momAdvection
438        LOGICAL momForcing        LOGICAL momForcing
439        LOGICAL momPressureForcing        LOGICAL momPressureForcing
440          LOGICAL metricTerms
441          LOGICAL useNHMTerms
442    
443        LOGICAL useCoriolis        LOGICAL useCoriolis
444          LOGICAL use3dCoriolis
445          LOGICAL useCDscheme
446        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
447          LOGICAL useEnergyConservingCoriolis
448          LOGICAL useJamartWetPoints
449          LOGICAL useJamartMomAdv
450          LOGICAL upwindVorticity
451          LOGICAL highOrderVorticity
452          LOGICAL useAbsVorticity
453          LOGICAL upwindShear
454          LOGICAL momStepping
455          LOGICAL calc_wVelocity
456          LOGICAL tempStepping
457          LOGICAL saltStepping
458          LOGICAL addFrictionHeating
459        LOGICAL tempAdvection        LOGICAL tempAdvection
460          LOGICAL tempVertDiff4
461        LOGICAL tempIsActiveTr        LOGICAL tempIsActiveTr
462        LOGICAL tempForcing        LOGICAL tempForcing
463        LOGICAL saltAdvection        LOGICAL saltAdvection
464          LOGICAL saltVertDiff4
465        LOGICAL saltIsActiveTr        LOGICAL saltIsActiveTr
466        LOGICAL saltForcing        LOGICAL saltForcing
467        LOGICAL maskIniTemp        LOGICAL maskIniTemp
468        LOGICAL maskIniSalt        LOGICAL maskIniSalt
469        LOGICAL checkIniTemp        LOGICAL checkIniTemp
470        LOGICAL checkIniSalt        LOGICAL checkIniSalt
471        LOGICAL useRealFreshWaterFlux        LOGICAL useSRCGSolver
       LOGICAL useFullLeith  
       LOGICAL useStrainTensionVisc  
       LOGICAL useAreaViscLength  
472        LOGICAL rigidLid        LOGICAL rigidLid
473        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
474          LOGICAL uniformLin_PhiSurf
475          LOGICAL uniformFreeSurfLev
476        LOGICAL exactConserv        LOGICAL exactConserv
477        LOGICAL linFSConserveTr        LOGICAL linFSConserveTr
478        LOGICAL uniformLin_PhiSurf        LOGICAL useRealFreshWaterFlux
479        LOGICAL quasiHydrostatic        LOGICAL quasiHydrostatic
480        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
481        LOGICAL use3Dsolver        LOGICAL use3Dsolver
482        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
483        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
484        LOGICAL momStepping        LOGICAL doResetHFactors
       LOGICAL tempStepping  
       LOGICAL saltStepping  
       LOGICAL metricTerms  
       LOGICAL useConstantF  
       LOGICAL useBetaPlaneF  
       LOGICAL useSphereF  
       LOGICAL use3dCoriolis  
       LOGICAL useCDscheme  
       LOGICAL useEnergyConservingCoriolis  
       LOGICAL useJamartWetPoints  
       LOGICAL useJamartMomAdv  
       LOGICAL upwindVorticity  
       LOGICAL highOrderVorticity  
       LOGICAL useAbsVorticity  
       LOGICAL upwindShear  
485        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
486        LOGICAL implicitViscosity        LOGICAL implicitViscosity
487        LOGICAL tempImplVertAdv        LOGICAL tempImplVertAdv
# Line 463  C                        & Last iteratio Line 496  C                        & Last iteratio
496        LOGICAL balancePrintMean        LOGICAL balancePrintMean
497        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
498        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
499          LOGICAL balanceThetaClimRelax
500          LOGICAL balanceSaltClimRelax
501        LOGICAL allowFreezing        LOGICAL allowFreezing
       LOGICAL useOldFreezing  
502        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
503        LOGICAL globalFiles        LOGICAL globalFiles
504        LOGICAL pickupStrictlyMatch        LOGICAL pickupStrictlyMatch
# Line 475  C                        & Last iteratio Line 509  C                        & Last iteratio
509        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
510        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
511        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
512        LOGICAL debugMode        LOGICAL printDomain
       LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact  
       LOGICAL useSRCGSolver  
513    
514  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
515  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 503  C           defaults to 0.51 but can be Line 535  C           defaults to 0.51 but can be
535  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
536  C     delRc     :: Vertical grid spacing between cell centers (r unit).  C     delRc     :: Vertical grid spacing between cell centers (r unit).
537  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
538  C     delY        on input flags.  C     delY         on input flags. Note: moved to header file SET_GRID.h
539    C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
540    C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
541    C                :: parameter but it makes geographical references simple.)
542    C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
543    C                :: most face (Lat-Lon grid).
544  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
545  C     recip_gravity and its inverse  C     recip_gravity and its inverse
546  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 )
547  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
548  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density (Boussinesq)
549  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
550  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
551  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
# Line 516  C     rho1Ref   :: reference vertical pr Line 553  C     rho1Ref   :: reference vertical pr
553  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
554  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
555  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
556  C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:  C     dBdrRef   :: vertical gradient of reference buoyancy  [(m/s/r)^2]:
557  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
558  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
559  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
# Line 533  C     rUnit2mass :: units conversion fac Line 570  C     rUnit2mass :: units conversion fac
570  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].
571  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
572  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
 C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western  
 C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"  
 C                :: parameter but it makes geographical references simple.)  
 C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern  
 C                :: most face (Lat-Lon grid).  
573  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
574  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
575    C     radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
576  C     f0         :: Reference coriolis parameter ( 1/s )  C     f0         :: Reference coriolis parameter ( 1/s )
577  C                   ( Southern edge f for beta plane )  C                   ( Southern edge f for beta plane )
578  C     beta       :: df/dy ( s^-1.m^-1 )  C     beta       :: df/dy ( s^-1.m^-1 )
579    C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
580    C                   of rotation (reference value = 2.Omega.Cos(Phi))
581  C     omega      :: Angular velocity ( rad/s )  C     omega      :: Angular velocity ( rad/s )
582  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
583  C     viscArNr   :: vertical profile of Eddy viscosity coeff.  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
# Line 551  C     viscAh     :: Eddy viscosity coeff Line 586  C     viscAh     :: Eddy viscosity coeff
586  C                   momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
587  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
588  C                   momentum laterally, no effect for hydrostatic  C                   momentum laterally, no effect for hydrostatic
589  C                   model, defaults to viscAh if unset ( m^2/s )  C                   model, defaults to viscAhD if unset ( m^2/s )
590  C                   Not used if variable horiz. viscosity is used.  C                   Not used if variable horiz. viscosity is used.
591  C     viscA4     :: Biharmonic viscosity coeff. for mixing of  C     viscA4     :: Biharmonic viscosity coeff. for mixing of
592  C                   momentum laterally ( m^4/s )  C                   momentum laterally ( m^4/s )
593  C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical  C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
594  C                   momentum laterally, no effect for hydrostatic  C                   momentum laterally, no effect for hydrostatic
595  C                   model, defaults to viscA4 if unset ( m^2/s )  C                   model, defaults to viscA4D if unset ( m^2/s )
596  C                   Not used if variable horiz. viscosity is used.  C                   Not used if variable horiz. viscosity is used.
597  C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
598  C                   (act on Divergence part) ( m^2/s )  C                   (act on Divergence part) ( m^2/s )
# Line 567  C     viscA4D    :: Biharmonic viscosity Line 602  C     viscA4D    :: Biharmonic viscosity
602  C                   (act on Divergence part) ( m^4/s )  C                   (act on Divergence part) ( m^4/s )
603  C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
604  C                   (act on Vorticity  part) ( m^4/s )  C                   (act on Vorticity  part) ( m^4/s )
605    C     smag3D_coeff :: Isotropic 3-D Smagorinsky coefficient (-)
606  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
607  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
608  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
# Line 589  C     viscA4GridMax:: maximum and minimu Line 625  C     viscA4GridMax:: maximum and minimu
625  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
626  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
627  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 )  
628  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
629  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
630    C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
631    C                 for mixing of heat vertically ( units of r^2/s )
632    C     diffKr4T  :: vertical profile of Biharmonic diffusion coeff.
633    C                 for mixing of heat vertically ( units of r^4/s )
634  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
635  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 ),  
636  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
637  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
638    C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
639    C                 for mixing of salt vertically ( units of r^2/s ),
640    C     diffKr4S  :: vertical profile of Biharmonic diffusion coeff.
641    C                 for mixing of salt vertically ( units of r^4/s )
642  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
643  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
644  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 618  C                    Frequency of checkp Line 658  C                    Frequency of checkp
658  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
659  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
660  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
661  C     deltaTfreesurf :: Timestep for free-surface equation ( s )  C     deltaTFreeSurf :: Timestep for free-surface equation ( s )
662  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freeSurfFac  :: Parameter to turn implicit free surface term on or off
663  C                    freesurfac = 1. uses implicit free surface  C                     freeSurFac = 1. uses implicit free surface
664  C                    freesurfac = 0. uses rigid lid  C                     freeSurFac = 0. uses rigid lid
665  C     abEps        :: Adams-Bashforth-2 stabilizing weight  C     abEps        :: Adams-Bashforth-2 stabilizing weight
666  C     alph_AB      :: Adams-Bashforth-3 primary factor  C     alph_AB      :: Adams-Bashforth-3 primary factor
667  C     beta_AB      :: Adams-Bashforth-3 secondary factor  C     beta_AB      :: Adams-Bashforth-3 secondary factor
# Line 646  C     endTime       :: Ending time for t Line 686  C     endTime       :: Ending time for t
686  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
687  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
688  C     dumpFreq      :: Frequency with which model state is written to  C     dumpFreq      :: Frequency with which model state is written to
689  C                     post-processing files ( s ).  C                      post-processing files ( s ).
690  C     diagFreq      :: Frequency with which model writes diagnostic output  C     diagFreq      :: Frequency with which model writes diagnostic output
691  C                     of intermediate quantities.  C                      of intermediate quantities.
692  C     afFacMom      :: Advection of momentum term tracer parameter  C     afFacMom      :: Advection of momentum term tracer parameter
693  C     vfFacMom      :: Momentum viscosity tracer parameter  C     vfFacMom      :: Momentum viscosity tracer parameter
694  C     pfFacMom      :: Momentum pressure forcing tracer parameter  C     pfFacMom      :: Momentum pressure forcing tracer parameter
# Line 697  C                           is to be rep Line 737  C                           is to be rep
737  C                           (affects myabs, mymin, mymax)  C                           (affects myabs, mymin, mymax)
738  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
739  C                      (i.e. allows convection at different Rayleigh numbers)  C                      (i.e. allows convection at different Rayleigh numbers)
740    C     tCylIn        :: Temperature of the cylinder inner boundary
741    C     tCylOut       :: Temperature of the cylinder outer boundary
742  C     phiEuler      :: Euler angle, rotation about original z-axis  C     phiEuler      :: Euler angle, rotation about original z-axis
743  C     thetaEuler    :: Euler angle, rotation about new x-axis  C     thetaEuler    :: Euler angle, rotation about new x-axis
744  C     psiEuler      :: Euler angle, rotation about new z-axis  C     psiEuler      :: Euler angle, rotation about new z-axis
745        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
746       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
747       & delR, delRc, delX, delY,       & delR, delRc, xgOrigin, ygOrigin,
748       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTMom, dTtracerLev, deltaTFreeSurf, deltaTClock,
749       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
750       & xgOrigin, ygOrigin, rSphere, recip_RSphere, f0, beta,       & rSphere, recip_rSphere, radius_fromHorizGrid,
751       & viscAh, viscAhW, viscAhMax,       & f0, beta, fPrime, omega, rotationPeriod,
752       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscFacAdj, viscAh, viscAhW, smag3D_coeff,
753         & viscAhMax, viscAhGrid, viscAhGridMax, viscAhGridMin,
754       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
755       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
756       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
# Line 715  C     psiEuler      :: Euler angle, rota Line 758  C     psiEuler      :: Euler angle, rota
758       & viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Grid, viscA4GridMax, viscA4GridMin,
759       & viscAhReMax, viscA4ReMax,       & viscAhReMax, viscA4ReMax,
760       & viscC4leith, viscC4leithD, viscArNr,       & viscC4leith, viscC4leithD, viscArNr,
761       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT, diffKr4T,
762       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS, diffKr4S,
763       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
764       & BL79LatVary,       & BL79LatVary,
765       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
# Line 724  C     psiEuler      :: Euler angle, rota Line 767  C     psiEuler      :: Euler angle, rota
767       & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,       & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
768       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
769       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
770       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhoNil, rhoConst, recip_rhoConst,
771       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
772       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
773       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
# Line 732  C     psiEuler      :: Euler angle, rota Line 775  C     psiEuler      :: Euler angle, rota
775       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
776       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
777       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
778       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq,
779       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
780       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
781       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
# Line 750  C     psiEuler      :: Euler angle, rota Line 793  C     psiEuler      :: Euler angle, rota
793        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
794        _RL delR(Nr)        _RL delR(Nr)
795        _RL delRc(Nr+1)        _RL delRc(Nr+1)
796        _RL delX(Nx)        _RL xgOrigin
797        _RL delY(Ny)        _RL ygOrigin
798        _RL deltaT        _RL deltaT
799        _RL deltaTClock        _RL deltaTClock
800        _RL deltaTmom        _RL deltaTMom
801        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
802        _RL deltaTfreesurf        _RL deltaTFreeSurf
803        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
       _RL xgOrigin  
       _RL ygOrigin  
804        _RL rSphere        _RL rSphere
805        _RL recip_rSphere        _RL recip_rSphere
806          _RL radius_fromHorizGrid
807        _RL f0        _RL f0
808          _RL beta
809          _RL fPrime
810          _RL omega
811          _RL rotationPeriod
812        _RL freeSurfFac        _RL freeSurfFac
813        _RL implicSurfPress        _RL implicSurfPress
814        _RL implicDiv2Dflow        _RL implicDiv2Dflow
# Line 773  C     psiEuler      :: Euler angle, rota Line 819  C     psiEuler      :: Euler angle, rota
819        _RL hFacMinDr        _RL hFacMinDr
820        _RL hFacInf        _RL hFacInf
821        _RL hFacSup        _RL hFacSup
       _RL beta  
822        _RL viscArNr(Nr)        _RL viscArNr(Nr)
823          _RL viscFacAdj
824        _RL viscAh        _RL viscAh
825        _RL viscAhW        _RL viscAhW
826        _RL viscAhD        _RL viscAhD
827        _RL viscAhZ        _RL viscAhZ
828          _RL smag3D_coeff
829        _RL viscAhMax        _RL viscAhMax
830        _RL viscAhReMax        _RL viscAhReMax
831        _RL viscAhGrid, viscAhGridMax, viscAhGridMin        _RL viscAhGrid, viscAhGridMax, viscAhGridMin
# Line 796  C     psiEuler      :: Euler angle, rota Line 843  C     psiEuler      :: Euler angle, rota
843        _RL viscC4leithD        _RL viscC4leithD
844        _RL viscC4smag        _RL viscC4smag
845        _RL diffKhT        _RL diffKhT
       _RL diffKrNrT(Nr)  
846        _RL diffK4T        _RL diffK4T
847          _RL diffKrNrT(Nr)
848          _RL diffKr4T(Nr)
849        _RL diffKhS        _RL diffKhS
       _RL diffKrNrS(Nr)  
850        _RL diffK4S        _RL diffK4S
851          _RL diffKrNrS(Nr)
852          _RL diffKr4S(Nr)
853        _RL diffKrBL79surf        _RL diffKrBL79surf
854        _RL diffKrBL79deep        _RL diffKrBL79deep
855        _RL diffKrBL79scl        _RL diffKrBL79scl
# Line 814  C     psiEuler      :: Euler angle, rota Line 863  C     psiEuler      :: Euler angle, rota
863        _RL gravity        _RL gravity
864        _RL recip_gravity        _RL recip_gravity
865        _RL gBaro        _RL gBaro
866        _RL rhonil,        recip_rhonil        _RL rhoNil
867        _RL rhoConst,      recip_rhoConst        _RL rhoConst,      recip_rhoConst
868        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
869        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
# Line 846  C     psiEuler      :: Euler angle, rota Line 895  C     psiEuler      :: Euler angle, rota
895        _RL mtFacMom        _RL mtFacMom
896        _RL cosPower        _RL cosPower
897        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
       _RL rotationPeriod  
898        _RL tauThetaClimRelax        _RL tauThetaClimRelax
899        _RL tauSaltClimRelax        _RL tauSaltClimRelax
900        _RL latBandClimRelax        _RL latBandClimRelax
# Line 869  C     psiEuler      :: Euler angle, rota Line 916  C     psiEuler      :: Euler angle, rota
916        _RL bottomDragQuadratic        _RL bottomDragQuadratic
917        _RL smoothAbsFuncRange        _RL smoothAbsFuncRange
918        _RL nh_Am2        _RL nh_Am2
919        _RL tCylIn        _RL tCylIn, tCylOut
       _RL tCylOut  
920        _RL phiEuler, thetaEuler, psiEuler        _RL phiEuler, thetaEuler, psiEuler
921    
922  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
# Line 910  C Logical flags for selecting packages Line 956  C Logical flags for selecting packages
956        LOGICAL useKPP        LOGICAL useKPP
957        LOGICAL useGMRedi        LOGICAL useGMRedi
958        LOGICAL useDOWN_SLOPE        LOGICAL useDOWN_SLOPE
959          LOGICAL useBBL
960        LOGICAL useCAL        LOGICAL useCAL
961        LOGICAL useEXF        LOGICAL useEXF
962        LOGICAL useBulkForce        LOGICAL useBulkForce
# Line 917  C Logical flags for selecting packages Line 964  C Logical flags for selecting packages
964        LOGICAL useCheapAML        LOGICAL useCheapAML
965        LOGICAL useGrdchk        LOGICAL useGrdchk
966        LOGICAL useSMOOTH        LOGICAL useSMOOTH
967          LOGICAL usePROFILES
968        LOGICAL useECCO        LOGICAL useECCO
969        LOGICAL useSBO        LOGICAL useSBO
970        LOGICAL useFLT        LOGICAL useFLT
# Line 925  C Logical flags for selecting packages Line 973  C Logical flags for selecting packages
973        LOGICAL useRBCS        LOGICAL useRBCS
974        LOGICAL useOffLine        LOGICAL useOffLine
975        LOGICAL useMATRIX        LOGICAL useMATRIX
976          LOGICAL useFRAZIL
977        LOGICAL useSEAICE        LOGICAL useSEAICE
978        LOGICAL useSALT_PLUME        LOGICAL useSALT_PLUME
979        LOGICAL useShelfIce        LOGICAL useShelfIce
980          LOGICAL useStreamIce
981        LOGICAL useICEFRONT        LOGICAL useICEFRONT
982        LOGICAL useThSIce        LOGICAL useThSIce
983          LOGICAL useLand
984        LOGICAL useATM2d        LOGICAL useATM2d
985        LOGICAL useAIM        LOGICAL useAIM
986        LOGICAL useLand        LOGICAL useAtm_Phys
987        LOGICAL useFizhi        LOGICAL useFizhi
988        LOGICAL useGridAlt        LOGICAL useGridAlt
989        LOGICAL useDiagnostics        LOGICAL useDiagnostics
# Line 941  C Logical flags for selecting packages Line 992  C Logical flags for selecting packages
992        LOGICAL useMNC        LOGICAL useMNC
993        LOGICAL useRunClock        LOGICAL useRunClock
994        LOGICAL useEMBED_FILES        LOGICAL useEMBED_FILES
       LOGICAL useOASIS  
995        LOGICAL useMYPACKAGE        LOGICAL useMYPACKAGE
996        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
997       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
998       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
999       &        useGMRedi, useDOWN_SLOPE,       &        useGMRedi, useBBL, useDOWN_SLOPE,
1000       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
1001       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,       &        useGrdchk,useSMOOTH,usePROFILES,useECCO,useSBO, useFLT,
1002       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
1003       &        useSEAICE, useSALT_PLUME, useShelfIce,       &        useFRAZIL, useSEAICE, useSALT_PLUME, useShelfIce,
1004       &        useICEFRONT, useThSIce,       &        useStreamIce, useICEFRONT, useThSIce, useLand,
1005       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,       &        useATM2D, useAIM, useAtm_Phys, useFizhi, useGridAlt,
1006       &        useDiagnostics, useREGRID, useLayers, useMNC,       &        useDiagnostics, useREGRID, useLayers, useMNC,
1007       &        useRunClock, useEMBED_FILES,       &        useRunClock, useEMBED_FILES,
      &        useOASIS,  
1008       &        useMYPACKAGE       &        useMYPACKAGE
1009    
1010  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
1011  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
1012  CEH3 ;;; End: ***  CEH3 ;;; End: ***
Legend:
Removed from v.1.240  
changed lines
  Added in v.1.273
  ViewVC Help
Powered by ViewVC 1.1.22