/[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.235 by dimitri, Wed Jan 20 23:33:45 2010 UTC revision 1.267 by jmc, Fri Dec 21 22:58:23 2012 UTC
# Line 33  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 51  C                        for potential t Line 57  C                        for potential t
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
# Line 68  C                 m/s when using externa Line 78  C                 m/s when using externa
78  C                 to kg/m2/s by multiplying by rhoConstFresh.  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     addMassFile     :: File containing source/sink of fluid in the interior
82  C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data  C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data
83  C     eddyPsiYFile    :: File containing meridional Eddy streamfunction data  C     eddyPsiYFile    :: File containing meridional Eddy streamfunction data
84  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
85        COMMON /PARM_C/        COMMON /PARM_C/
86       &                buoyancyRelation, eosType,       &                buoyancyRelation, eosType,
87       &                pickupSuff, mdsioLocalDir,       &                pickupSuff, mdsioLocalDir, adTapeDir,
88       &                tRefFile, sRefFile, rhoRefFile,       &                tRefFile, sRefFile, rhoRefFile,
89       &                delRFile, delRcFile,       &                delRFile, delRcFile, hybSigmFile,
90       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
91       &                bathyFile, topoFile,       &                bathyFile, topoFile,
92         &                viscAhDfile, viscAhZfile,
93         &                viscA4Dfile, viscA4Zfile,
94       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
95       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
96       &                saltClimFile,       &                saltClimFile,
# Line 85  C     the_run_name    :: string identify Line 98  C     the_run_name    :: string identify
98       &                surfQfile, surfQnetFile, surfQswFile,       &                surfQfile, surfQnetFile, surfQswFile,
99       &                lambdaThetaFile, lambdaSaltFile,       &                lambdaThetaFile, lambdaSaltFile,
100       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
101       &                dQdTfile, ploadFile,       &                dQdTfile, pLoadFile, addMassFile,
102       &                eddyPsiXFile, eddyPsiYFile,       &                eddyPsiXFile, eddyPsiYFile,
103       &                the_run_name       &                the_run_name
104        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
105        CHARACTER*(6)  eosType        CHARACTER*(6)  eosType
106        CHARACTER*(10) pickupSuff        CHARACTER*(10) pickupSuff
107        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
108          CHARACTER*(MAX_LEN_FNAM) adTapeDir
109        CHARACTER*(MAX_LEN_FNAM) tRefFile        CHARACTER*(MAX_LEN_FNAM) tRefFile
110        CHARACTER*(MAX_LEN_FNAM) sRefFile        CHARACTER*(MAX_LEN_FNAM) sRefFile
111        CHARACTER*(MAX_LEN_FNAM) rhoRefFile        CHARACTER*(MAX_LEN_FNAM) rhoRefFile
112        CHARACTER*(MAX_LEN_FNAM) delRFile        CHARACTER*(MAX_LEN_FNAM) delRFile
113        CHARACTER*(MAX_LEN_FNAM) delRcFile        CHARACTER*(MAX_LEN_FNAM) delRcFile
114          CHARACTER*(MAX_LEN_FNAM) hybSigmFile
115        CHARACTER*(MAX_LEN_FNAM) delXFile        CHARACTER*(MAX_LEN_FNAM) delXFile
116        CHARACTER*(MAX_LEN_FNAM) delYFile        CHARACTER*(MAX_LEN_FNAM) delYFile
117        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
118        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
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
122          CHARACTER*(MAX_LEN_FNAM) viscAhZfile
123          CHARACTER*(MAX_LEN_FNAM) viscA4Dfile
124          CHARACTER*(MAX_LEN_FNAM) viscA4Zfile
125        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
126        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
127        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
# Line 116  C     the_run_name    :: string identify Line 135  C     the_run_name    :: string identify
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) dQdTfile
138        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) pLoadFile
139          CHARACTER*(MAX_LEN_FNAM) addMassFile
140        CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile
141        CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile
142        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
# Line 125  C     the_run_name    :: string identify Line 145  C     the_run_name    :: string identify
145    
146  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
147  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
148  C                           two-dimensional con. grad solver.  C                            two-dimensional con. grad solver.
149  C     cg2dChkResFreq      :: Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
150  C                           in con. grad solver.  C                            in con. grad solver.
151  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
152  C                            (non-linear free-surf.)  C                            (non-linear free-surf.)
153    C     cg2dUseMinResSol    :: =0 : use last-iteration/converged solution
154    C                            =1 : use solver minimum-residual solution
155  C     cg3dMaxIters        :: Maximum number of iterations in the  C     cg3dMaxIters        :: Maximum number of iterations in the
156  C                           three-dimensional con. grad solver.  C                            three-dimensional con. grad solver.
157  C     cg3dChkResFreq      :: Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
158  C                           in con. grad solver.  C                            in con. grad solver.
159    C     printResidualFreq   :: Frequency for printing residual in CG iterations
160  C     nIter0              :: Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
161  C     nTimeSteps          :: Number of timesteps to execute  C     nTimeSteps          :: Number of timesteps to execute
162  C     writeStatePrec      :: Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
163  C     writeBinaryPrec     :: Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
164  C     readBinaryPrec      :: Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
165    C     selectCoriMap       :: select setting of Coriolis parameter map:
166    C                           =0 f-Plane (Constant Coriolis, = f0)
167    C                           =1 Beta-Plane Coriolis (= f0 + beta.y)
168    C                           =2 Spherical Coriolis (= 2.omega.sin(phi))
169    C                           =3 Read Coriolis 2-d fields from files.
170    C     selectSigmaCoord    :: option related to sigma vertical coordinate
171  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
172  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
173  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
# Line 149  C     selectAddFluid      :: option to a Line 178  C     selectAddFluid      :: option to a
178  C                            (3-D generalisation of oceanic real-fresh water flux)  C                            (3-D generalisation of oceanic real-fresh water flux)
179  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
180  C     momForcingOutAB     :: =1: take momentum forcing contribution  C     momForcingOutAB     :: =1: take momentum forcing contribution
181  C                           out of (=0: in) Adams-Bashforth time stepping.  C                            out of (=0: in) Adams-Bashforth time stepping.
182  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
183  C                           out of (=0: in) Adams-Bashforth time stepping.  C                            out of (=0: in) Adams-Bashforth time stepping.
184  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
185  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
186  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
# Line 160  C     selectKEscheme      :: Kinetic Ene Line 189  C     selectKEscheme      :: Kinetic Ene
189  C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)  C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)
190  C     monitorSelect       :: select group of variables to monitor  C     monitorSelect       :: select group of variables to monitor
191  C                            =1 : dynvars ; =2 : + vort ; =3 : + surface  C                            =1 : dynvars ; =2 : + vort ; =3 : + surface
192  C     debugLevel          :: debug level selector: higher -> more writing  C-    debugLevel          :: controls printing of algorithm intermediate results
193    C                            and statistics ; higher -> more writing
194    
195        COMMON /PARM_I/        COMMON /PARM_I/
196       &        cg2dMaxIters,       &        cg2dMaxIters, cg2dChkResFreq,
197       &        cg2dChkResFreq, cg2dPreCondFreq,       &        cg2dPreCondFreq, cg2dUseMinResSol,
198       &        cg3dMaxIters,       &        cg3dMaxIters, cg3dChkResFreq,
199       &        cg3dChkResFreq,       &        printResidualFreq,
200       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
201       &        writeStatePrec,       &        writeStatePrec,
202       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
203         &        selectCoriMap,
204         &        selectSigmaCoord,
205       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
206       &        selectNHfreeSurf,       &        selectNHfreeSurf,
207       &        selectAddFluid,       &        selectAddFluid,
# Line 181  C     debugLevel          :: debug level Line 213  C     debugLevel          :: debug level
213        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
214        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
215        INTEGER cg2dPreCondFreq        INTEGER cg2dPreCondFreq
216          INTEGER cg2dUseMinResSol
217        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
218        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
219          INTEGER printResidualFreq
220        INTEGER nIter0        INTEGER nIter0
221        INTEGER nTimeSteps        INTEGER nTimeSteps
222        INTEGER nEndIter        INTEGER nEndIter
223        INTEGER writeStatePrec        INTEGER writeStatePrec
224        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
225        INTEGER readBinaryPrec        INTEGER readBinaryPrec
226          INTEGER selectCoriMap
227          INTEGER selectSigmaCoord
228        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
229        INTEGER select_rStar        INTEGER select_rStar
230        INTEGER selectNHfreeSurf        INTEGER selectNHfreeSurf
# Line 204  C     debugLevel          :: debug level Line 240  C     debugLevel          :: debug level
240  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
241  C- Coordinate + Grid params:  C- Coordinate + Grid params:
242  C     fluidIsAir       :: Set to indicate that the fluid major constituent  C     fluidIsAir       :: Set to indicate that the fluid major constituent
243  C                        is air  C                         is air
244  C     fluidIsWater     :: Set to indicate that the fluid major constituent  C     fluidIsWater     :: Set to indicate that the fluid major constituent
245  C                        is water  C                         is water
246  C     usingPCoords     :: Set to indicate that we are working in a pressure  C     usingPCoords     :: Set to indicate that we are working in a pressure
247  C                        type coordinate (p or p*).  C                         type coordinate (p or p*).
248  C     usingZCoords     :: Set to indicate that we are working in a height  C     usingZCoords     :: Set to indicate that we are working in a height
249  C                        type coordinate (z or z*)  C                         type coordinate (z or z*)
250  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.)
251  C                         this requires specific code for restart & exchange  C                         this requires specific code for restart & exchange
252  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
253  C                          coordinate frame.  C                           coordinate frame.
254  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
255  C                               spherical polar frame.  C                                spherical polar frame.
256  C     rotateGrid      :: rotate grid coordinates to geographical coordinates  C     rotateGrid      :: rotate grid coordinates to geographical coordinates
257  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)  
258  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
259    C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
260    C     hasWetCSCorners :: domain contains CS-type corners where dynamics is solved
261  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
262  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
263  C     setCenterDr    :: set cell-Center depth (put Interface at the middle)  C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
# Line 242  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 255  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 309  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
353  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
354  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
355  C- I/O parameters -  C- I/O parameters -
356  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files.
357  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  C                       On some platforms with MPI, option globalFiles is either
358  C                       slow (f77) or does not work (f90).  When  C                       slow or does not work. Use useSingleCpuIO instead.
359  C                       useSingleCpuIO is set, mdsio_writefield.F  C     useSingleCpuIO :: moved to EEPARAMS.h
 C                       outputs from master mpi process only.  
360  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
361  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
362  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
# Line 331  C     snapshot_mdsio     :: use mdsio fo Line 370  C     snapshot_mdsio     :: use mdsio fo
370  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
371  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
372  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
373    C     printDomain     :: controls printing of domain fields (bathy, hFac ...).
374    
375        COMMON /PARM_L/        COMMON /PARM_L/
376       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
377       & usingPCoords, usingZCoords, useDynP_inEos_Zc,       & usingPCoords, usingZCoords, useDynP_inEos_Zc,
378       & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,       & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
379       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCylindricalGrid, usingCurvilinearGrid, hasWetCSCorners,
380       & deepAtmosphere, setInterFDr, setCenterDr,       & deepAtmosphere, setInterFDr, setCenterDr,
381       & no_slip_sides, no_slip_bottom,       & no_slip_sides, no_slip_bottom,
382       & useFullLeith, useStrainTensionVisc, useAreaViscLength,       & useFullLeith, useStrainTensionVisc, useAreaViscLength,
383       & momViscosity, momAdvection, momForcing,       & momViscosity, momAdvection, momForcing,
384       & momPressureForcing, metricTerms, useNHMTerms,       & momPressureForcing, metricTerms, useNHMTerms,
385       & useCoriolis, use3dCoriolis,       & useCoriolis, use3dCoriolis,
      & useConstantF, useBetaPlaneF, useSphereF,  
386       & useCDscheme, vectorInvariantMomentum,       & useCDscheme, vectorInvariantMomentum,
387       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
388       & upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
389       & useAbsVorticity, upwindShear,       & useAbsVorticity, upwindShear,
390       & momStepping, tempStepping, saltStepping,       & momStepping, calc_wVelocity, tempStepping, saltStepping,
391       & tempAdvection, tempIsActiveTr, tempForcing,       & addFrictionHeating,
392       & saltAdvection, saltIsActiveTr, saltForcing,       & tempAdvection, tempVertDiff4, tempIsActiveTr, tempForcing,
393         & saltAdvection, saltVertDiff4, saltIsActiveTr, saltForcing,
394       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
395       & useRealFreshWaterFlux,       & useSRCGSolver,
396       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface,
397       & uniformLin_PhiSurf,       & uniformLin_PhiSurf, uniformFreeSurfLev,
398       & quasiHydrostatic, nonHydrostatic,       & exactConserv, linFSConserveTr, useRealFreshWaterFlux,
399       & use3Dsolver, implicitIntGravWave, staggerTimeStep,       & quasiHydrostatic, nonHydrostatic, use3Dsolver,
400         & implicitIntGravWave, staggerTimeStep, doResetHFactors,
401       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
402       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
403       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
404       & momDissip_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
405       & balanceEmPmR, balanceQnet, balancePrintMean,       & balanceEmPmR, balanceQnet, balancePrintMean,
406         & balanceThetaClimRelax, balanceSaltClimRelax,
407       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
408       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
409       & periodicExternalForcing,       & periodicExternalForcing,
410       & globalFiles, useSingleCpuIO,       & globalFiles,
411       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
412       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
413       & writePickupAtEnd,       & writePickupAtEnd,
414       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
415       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast,
416       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & printDomain
      & useSRCGSolver  
417    
418        LOGICAL fluidIsAir        LOGICAL fluidIsAir
419        LOGICAL fluidIsWater        LOGICAL fluidIsWater
# Line 382  C                        & Last iteratio Line 423  C                        & Last iteratio
423        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
424        LOGICAL usingSphericalPolarGrid, rotateGrid        LOGICAL usingSphericalPolarGrid, rotateGrid
425        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
426        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid, hasWetCSCorners
427        LOGICAL deepAtmosphere        LOGICAL deepAtmosphere
428        LOGICAL setInterFDr        LOGICAL setInterFDr
429        LOGICAL setCenterDr        LOGICAL setCenterDr
430        LOGICAL useNHMTerms  
431        LOGICAL no_slip_sides        LOGICAL no_slip_sides
432        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
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 449  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
502        LOGICAL useOldFreezing        LOGICAL useOldFreezing
503        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
504        LOGICAL globalFiles        LOGICAL globalFiles
       LOGICAL useSingleCpuIO  
505        LOGICAL pickupStrictlyMatch        LOGICAL pickupStrictlyMatch
506        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
507        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
# Line 462  C                        & Last iteratio Line 510  C                        & Last iteratio
510        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
511        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
512        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
513        LOGICAL debugMode        LOGICAL printDomain
       LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact  
       LOGICAL useSRCGSolver  
514    
515  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
516  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 490  C           defaults to 0.51 but can be Line 536  C           defaults to 0.51 but can be
536  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
537  C     delRc     :: Vertical grid spacing between cell centers (r unit).  C     delRc     :: Vertical grid spacing between cell centers (r unit).
538  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
539  C     delY        on input flags.  C     delY         on input flags. Note: moved to header file SET_GRID.h
540    C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
541    C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
542    C                :: parameter but it makes geographical references simple.)
543    C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
544    C                :: most face (Lat-Lon grid).
545  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
546  C     recip_gravity and its inverse  C     recip_gravity and its inverse
547  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 )
548  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
549  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density (Boussinesq)
550  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
551  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
552  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
# Line 503  C     rho1Ref   :: reference vertical pr Line 554  C     rho1Ref   :: reference vertical pr
554  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
555  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
556  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
557  C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:  C     dBdrRef   :: vertical gradient of reference buoyancy  [(m/s/r)^2]:
558  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
559  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
560  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
# Line 520  C     rUnit2mass :: units conversion fac Line 571  C     rUnit2mass :: units conversion fac
571  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].
572  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
573  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).  
574  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
575  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
576    C     radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
577  C     f0         :: Reference coriolis parameter ( 1/s )  C     f0         :: Reference coriolis parameter ( 1/s )
578  C                   ( Southern edge f for beta plane )  C                   ( Southern edge f for beta plane )
579  C     beta       :: df/dy ( s^-1.m^-1 )  C     beta       :: df/dy ( s^-1.m^-1 )
580    C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
581    C                   of rotation (reference value = 2.Omega.Cos(Phi))
582  C     omega      :: Angular velocity ( rad/s )  C     omega      :: Angular velocity ( rad/s )
583  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
584  C     viscArNr   :: vertical profile of Eddy viscosity coeff.  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
# Line 576  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 605  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 633  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 662  C     convertFW2Salt :: salinity, used t Line 715  C     convertFW2Salt :: salinity, used t
715  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
716  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
717  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
718    C     temp_addMass :: temperature of addMass array
719    C     salt_addMass :: salinity of addMass array
720  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
721  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
722  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
# Line 671  C     hMixSmooth  :: Smoothing parameter Line 726  C     hMixSmooth  :: Smoothing parameter
726  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
727  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
728  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
729    C     rSigmaBnd   :: vertical position (in r-unit) of r/sigma transition (Hybrid-Sigma)
730  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
731  C                           (default=2: full drag ; =1: gives half-slip BC)  C                           (default=2: full drag ; =1: gives half-slip BC)
732  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
# Line 681  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         & viscFacAdj, viscAh, viscAhW, viscAhMax,
753       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
754       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
755       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
# Line 699  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 708  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 716  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,
782       & hFacMinDr, hFacMinDp,       & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
783       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, Ro_SeaLevel,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth,
784         & Ro_SeaLevel, rSigmaBnd,
785       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
786       & smoothAbsFuncRange,       & smoothAbsFuncRange,
787       & tCylIn, tCylOut,       & tCylIn, tCylOut,
# Line 733  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 756  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
# Line 779  C     psiEuler      :: Euler angle, rota Line 842  C     psiEuler      :: Euler angle, rota
842        _RL viscC4leithD        _RL viscC4leithD
843        _RL viscC4smag        _RL viscC4smag
844        _RL diffKhT        _RL diffKhT
       _RL diffKrNrT(Nr)  
845        _RL diffK4T        _RL diffK4T
846          _RL diffKrNrT(Nr)
847          _RL diffKr4T(Nr)
848        _RL diffKhS        _RL diffKhS
       _RL diffKrNrS(Nr)  
849        _RL diffK4S        _RL diffK4S
850          _RL diffKrNrS(Nr)
851          _RL diffKr4S(Nr)
852        _RL diffKrBL79surf        _RL diffKrBL79surf
853        _RL diffKrBL79deep        _RL diffKrBL79deep
854        _RL diffKrBL79scl        _RL diffKrBL79scl
# Line 797  C     psiEuler      :: Euler angle, rota Line 862  C     psiEuler      :: Euler angle, rota
862        _RL gravity        _RL gravity
863        _RL recip_gravity        _RL recip_gravity
864        _RL gBaro        _RL gBaro
865        _RL rhonil,        recip_rhonil        _RL rhoNil
866        _RL rhoConst,      recip_rhoConst        _RL rhoConst,      recip_rhoConst
867        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
868        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
# Line 829  C     psiEuler      :: Euler angle, rota Line 894  C     psiEuler      :: Euler angle, rota
894        _RL mtFacMom        _RL mtFacMom
895        _RL cosPower        _RL cosPower
896        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
       _RL rotationPeriod  
897        _RL tauThetaClimRelax        _RL tauThetaClimRelax
898        _RL tauSaltClimRelax        _RL tauSaltClimRelax
899        _RL latBandClimRelax        _RL latBandClimRelax
# Line 839  C     psiEuler      :: Euler angle, rota Line 902  C     psiEuler      :: Euler angle, rota
902        _RL convertFW2Salt        _RL convertFW2Salt
903        _RL temp_EvPrRn        _RL temp_EvPrRn
904        _RL salt_EvPrRn        _RL salt_EvPrRn
905          _RL temp_addMass
906          _RL salt_addMass
907        _RL ivdc_kappa        _RL ivdc_kappa
908        _RL hMixCriteria        _RL hMixCriteria
909        _RL dRhoSmall        _RL dRhoSmall
910        _RL hMixSmooth        _RL hMixSmooth
911        _RL Ro_SeaLevel        _RL Ro_SeaLevel
912          _RL rSigmaBnd
913        _RL sideDragFactor        _RL sideDragFactor
914        _RL bottomDragLinear        _RL bottomDragLinear
915        _RL bottomDragQuadratic        _RL bottomDragQuadratic
916        _RL smoothAbsFuncRange        _RL smoothAbsFuncRange
917        _RL nh_Am2        _RL nh_Am2
918        _RL tCylIn        _RL tCylIn, tCylOut
       _RL tCylOut  
919        _RL phiEuler, thetaEuler, psiEuler        _RL phiEuler, thetaEuler, psiEuler
920    
921  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
# Line 890  C Logical flags for selecting packages Line 955  C Logical flags for selecting packages
955        LOGICAL useKPP        LOGICAL useKPP
956        LOGICAL useGMRedi        LOGICAL useGMRedi
957        LOGICAL useDOWN_SLOPE        LOGICAL useDOWN_SLOPE
958          LOGICAL useBBL
959        LOGICAL useCAL        LOGICAL useCAL
960        LOGICAL useEXF        LOGICAL useEXF
961        LOGICAL useBulkForce        LOGICAL useBulkForce
# Line 897  C Logical flags for selecting packages Line 963  C Logical flags for selecting packages
963        LOGICAL useCheapAML        LOGICAL useCheapAML
964        LOGICAL useGrdchk        LOGICAL useGrdchk
965        LOGICAL useSMOOTH        LOGICAL useSMOOTH
966          LOGICAL usePROFILES
967        LOGICAL useECCO        LOGICAL useECCO
968        LOGICAL useSBO        LOGICAL useSBO
969        LOGICAL useFLT        LOGICAL useFLT
# Line 905  C Logical flags for selecting packages Line 972  C Logical flags for selecting packages
972        LOGICAL useRBCS        LOGICAL useRBCS
973        LOGICAL useOffLine        LOGICAL useOffLine
974        LOGICAL useMATRIX        LOGICAL useMATRIX
975          LOGICAL useFRAZIL
976        LOGICAL useSEAICE        LOGICAL useSEAICE
977        LOGICAL useSALT_PLUME        LOGICAL useSALT_PLUME
978        LOGICAL useShelfIce        LOGICAL useShelfIce
979          LOGICAL useStreamIce
980        LOGICAL useICEFRONT        LOGICAL useICEFRONT
981        LOGICAL useThSIce        LOGICAL useThSIce
982        LOGICAL useATM2d        LOGICAL useATM2d
# Line 925  C Logical flags for selecting packages Line 994  C Logical flags for selecting packages
994        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
995       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
996       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
997       &        useGMRedi, useDOWN_SLOPE,       &        useGMRedi, useBBL, useDOWN_SLOPE,
998       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
999       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,       &        useGrdchk,useSMOOTH,usePROFILES,useECCO,useSBO, useFLT,
1000       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
1001       &        useSEAICE, useSALT_PLUME, useShelfIce,       &        useFRAZIL, useSEAICE, useSALT_PLUME, useShelfIce,
1002       &        useICEFRONT, useThSIce,       &        useStreamIce, useICEFRONT, useThSIce,
1003       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
1004       &        useDiagnostics, useREGRID, useLayers, useMNC,       &        useDiagnostics, useREGRID, useLayers, useMNC,
1005       &        useRunClock, useEMBED_FILES,       &        useRunClock, useEMBED_FILES,
1006       &        useMYPACKAGE       &        useMYPACKAGE
1007    
1008  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
1009  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
1010  CEH3 ;;; End: ***  CEH3 ;;; End: ***
Legend:
Removed from v.1.235  
changed lines
  Added in v.1.267
  ViewVC Help
Powered by ViewVC 1.1.22