/[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.223 by jmc, Fri Sep 5 19:55:56 2008 UTC revision 1.265 by jmc, Fri Jul 13 20:34:31 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 46  C     bathyFile       :: File containing Line 52  C     bathyFile       :: File containing
52  C                        is taken from inline function.  C                        is taken from inline function.
53  C     topoFile        :: File containing the topography of the surface (unit=m)  C     topoFile        :: File containing the topography of the surface (unit=m)
54  C                        (mainly used for the atmosphere = ground height).  C                        (mainly used for the atmosphere = ground height).
 C     shelfIceFile    :: File containing the topography of the shelfice draught  
 C                        (unit=m)  
55  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
56  C                        for potential temperature.  C                        for potential temperature.
57  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
58  C                        for salinity.  C                        for salinity.
59  C     diffKrFile      :: File containing 3D specification of vertical diffusivity  C     diffKrFile      :: File containing 3D specification of vertical diffusivity
60    C     viscAhDfile     :: File containing 3D specification of horizontal viscosity
61    C     viscAhZfile     :: File containing 3D specification of horizontal viscosity
62    C     viscA4Dfile     :: File containing 3D specification of horizontal viscosity
63    C     viscA4Zfile     :: File containing 3D specification of horizontal viscosity
64  C     zonalWindFile   :: File containing zonal wind data  C     zonalWindFile   :: File containing zonal wind data
65  C     meridWindFile   :: File containing meridional wind data  C     meridWindFile   :: File containing meridional wind data
66  C     thetaClimFile   :: File containing surface theta climataology used  C     thetaClimFile   :: File containing surface theta climataology used
67  C                       in relaxation term -lambda(theta-theta*)  C                        in relaxation term -lambda(theta-theta*)
68  C     saltClimFile    :: File containing surface salt climataology used  C     saltClimFile    :: File containing surface salt climataology used
69  C                       in relaxation term -lambda(salt-salt*)  C                        in relaxation term -lambda(salt-salt*)
70  C     surfQfile       :: File containing surface heat flux, excluding SW  C     surfQfile       :: File containing surface heat flux, excluding SW
71  C                        (old version, kept for backward compatibility)  C                        (old version, kept for backward compatibility)
72  C     surfQnetFile    :: File containing surface net heat flux  C     surfQnetFile    :: File containing surface net heat flux
# Line 75  C     eddyPsiYFile    :: File containing Line 83  C     eddyPsiYFile    :: File containing
83  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
84        COMMON /PARM_C/        COMMON /PARM_C/
85       &                buoyancyRelation, eosType,       &                buoyancyRelation, eosType,
86       &                pickupSuff, mdsioLocalDir,       &                pickupSuff, mdsioLocalDir, adTapeDir,
87       &                tRefFile, sRefFile, rhoRefFile,       &                tRefFile, sRefFile, rhoRefFile,
88       &                delRFile, delRcFile,       &                delRFile, delRcFile, hybSigmFile,
89       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
90       &                bathyFile, topoFile, shelfIceFile,       &                bathyFile, topoFile,
91         &                viscAhDfile, viscAhZfile,
92         &                viscA4Dfile, viscA4Zfile,
93       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
94       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
95       &                saltClimFile,       &                saltClimFile,
# Line 94  C     the_run_name    :: string identify Line 104  C     the_run_name    :: string identify
104        CHARACTER*(6)  eosType        CHARACTER*(6)  eosType
105        CHARACTER*(10) pickupSuff        CHARACTER*(10) pickupSuff
106        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
107          CHARACTER*(MAX_LEN_FNAM) adTapeDir
108        CHARACTER*(MAX_LEN_FNAM) tRefFile        CHARACTER*(MAX_LEN_FNAM) tRefFile
109        CHARACTER*(MAX_LEN_FNAM) sRefFile        CHARACTER*(MAX_LEN_FNAM) sRefFile
110        CHARACTER*(MAX_LEN_FNAM) rhoRefFile        CHARACTER*(MAX_LEN_FNAM) rhoRefFile
111        CHARACTER*(MAX_LEN_FNAM) delRFile        CHARACTER*(MAX_LEN_FNAM) delRFile
112        CHARACTER*(MAX_LEN_FNAM) delRcFile        CHARACTER*(MAX_LEN_FNAM) delRcFile
113          CHARACTER*(MAX_LEN_FNAM) hybSigmFile
114        CHARACTER*(MAX_LEN_FNAM) delXFile        CHARACTER*(MAX_LEN_FNAM) delXFile
115        CHARACTER*(MAX_LEN_FNAM) delYFile        CHARACTER*(MAX_LEN_FNAM) delYFile
116        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
117        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
118        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
119        CHARACTER*(MAX_LEN_FNAM) diffKrFile        CHARACTER*(MAX_LEN_FNAM) diffKrFile
120          CHARACTER*(MAX_LEN_FNAM) viscAhDfile
121          CHARACTER*(MAX_LEN_FNAM) viscAhZfile
122          CHARACTER*(MAX_LEN_FNAM) viscA4Dfile
123          CHARACTER*(MAX_LEN_FNAM) viscA4Zfile
124        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
125        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
126        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
# Line 127  C     the_run_name    :: string identify Line 143  C     the_run_name    :: string identify
143    
144  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
145  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
146  C                           two-dimensional con. grad solver.  C                            two-dimensional con. grad solver.
147  C     cg2dChkResFreq      :: Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
148  C                           in con. grad solver.  C                            in con. grad solver.
149  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
150  C                            (non-linear free-surf.)  C                            (non-linear free-surf.)
151  C     cg3dMaxIters        :: Maximum number of iterations in the  C     cg3dMaxIters        :: Maximum number of iterations in the
152  C                           three-dimensional con. grad solver.  C                            three-dimensional con. grad solver.
153  C     cg3dChkResFreq      :: Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
154  C                           in con. grad solver.  C                            in con. grad solver.
155    C     printResidualFreq   :: Frequency for printing residual in CG iterations
156  C     nIter0              :: Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
157  C     nTimeSteps          :: Number of timesteps to execute  C     nTimeSteps          :: Number of timesteps to execute
158  C     writeStatePrec      :: Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
159  C     writeBinaryPrec     :: Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
160  C     readBinaryPrec      :: Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
161    C     selectCoriMap       :: select setting of Coriolis parameter map:
162    C                           =0 f-Plane (Constant Coriolis, = f0)
163    C                           =1 Beta-Plane Coriolis (= f0 + beta.y)
164    C                           =2 Spherical Coriolis (= 2.omega.sin(phi))
165    C                           =3 Read Coriolis 2-d fields from files.
166    C     selectSigmaCoord    :: option related to sigma vertical coordinate
167  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
168  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
169  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
170  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
171    C     selectNHfreeSurf    :: option for Non-Hydrostatic (free-)Surface formulation:
172    C                           =0 (default) hydrostatic surf. ; > 0 add NH effects.
173  C     selectAddFluid      :: option to add mass source/sink of fluid in the interior  C     selectAddFluid      :: option to add mass source/sink of fluid in the interior
174  C                            (3-D generalisation of oceanic real-fresh water flux)  C                            (3-D generalisation of oceanic real-fresh water flux)
175  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
176  C     momForcingOutAB     :: =1: take momentum forcing contribution  C     momForcingOutAB     :: =1: take momentum forcing contribution
177  C                           out of (=0: in) Adams-Bashforth time stepping.  C                            out of (=0: in) Adams-Bashforth time stepping.
178  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
179  C                           out of (=0: in) Adams-Bashforth time stepping.  C                            out of (=0: in) Adams-Bashforth time stepping.
180  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
181  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
182  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
# Line 160  C     selectKEscheme      :: Kinetic Ene Line 185  C     selectKEscheme      :: Kinetic Ene
185  C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)  C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)
186  C     monitorSelect       :: select group of variables to monitor  C     monitorSelect       :: select group of variables to monitor
187  C                            =1 : dynvars ; =2 : + vort ; =3 : + surface  C                            =1 : dynvars ; =2 : + vort ; =3 : + surface
188  C     debugLevel          :: debug level selector: higher -> more writing  C-    debugLevel          :: controls printing of algorithm intermediate results
189    C                            and statistics ; higher -> more writing
190    
191        COMMON /PARM_I/        COMMON /PARM_I/
192       &        cg2dMaxIters,       &        cg2dMaxIters, cg2dChkResFreq, cg2dPreCondFreq,
193       &        cg2dChkResFreq, cg2dPreCondFreq,       &        cg3dMaxIters, cg3dChkResFreq,
194       &        cg3dMaxIters,       &        printResidualFreq,
      &        cg3dChkResFreq,  
195       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
196       &        writeStatePrec,       &        writeStatePrec,
197       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
198         &        selectCoriMap,
199         &        selectSigmaCoord,
200       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
201         &        selectNHfreeSurf,
202       &        selectAddFluid,       &        selectAddFluid,
203       &        momForcingOutAB, tracForcingOutAB,       &        momForcingOutAB, tracForcingOutAB,
204       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
# Line 182  C     debugLevel          :: debug level Line 210  C     debugLevel          :: debug level
210        INTEGER cg2dPreCondFreq        INTEGER cg2dPreCondFreq
211        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
212        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
213          INTEGER printResidualFreq
214        INTEGER nIter0        INTEGER nIter0
215        INTEGER nTimeSteps        INTEGER nTimeSteps
216        INTEGER nEndIter        INTEGER nEndIter
217        INTEGER writeStatePrec        INTEGER writeStatePrec
218        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
219        INTEGER readBinaryPrec        INTEGER readBinaryPrec
220          INTEGER selectCoriMap
221          INTEGER selectSigmaCoord
222        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
223        INTEGER select_rStar        INTEGER select_rStar
224          INTEGER selectNHfreeSurf
225        INTEGER selectAddFluid        INTEGER selectAddFluid
226        INTEGER momForcingOutAB, tracForcingOutAB        INTEGER momForcingOutAB, tracForcingOutAB
227        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
# Line 202  C     debugLevel          :: debug level Line 234  C     debugLevel          :: debug level
234  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
235  C- Coordinate + Grid params:  C- Coordinate + Grid params:
236  C     fluidIsAir       :: Set to indicate that the fluid major constituent  C     fluidIsAir       :: Set to indicate that the fluid major constituent
237  C                        is air  C                         is air
238  C     fluidIsWater     :: Set to indicate that the fluid major constituent  C     fluidIsWater     :: Set to indicate that the fluid major constituent
239  C                        is water  C                         is water
240  C     usingPCoords     :: Set to indicate that we are working in a pressure  C     usingPCoords     :: Set to indicate that we are working in a pressure
241  C                        type coordinate (p or p*).  C                         type coordinate (p or p*).
242  C     usingZCoords     :: Set to indicate that we are working in a height  C     usingZCoords     :: Set to indicate that we are working in a height
243  C                        type coordinate (z or z*)  C                         type coordinate (z or z*)
244  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.)
245  C                         this requires specific code for restart & exchange  C                         this requires specific code for restart & exchange
246  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
247  C                          coordinate frame.  C                           coordinate frame.
248  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
249  C                               spherical polar frame.  C                                spherical polar frame.
250  C     rotateGrid      :: rotate grid coordinates to geographical coordinates  C     rotateGrid      :: rotate grid coordinates to geographical coordinates
251  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)  
252  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
253    C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
254    C     hasWetCSCorners :: domain contains CS-type corners where dynamics is solved
255  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
256  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
257  C     setCenterDr    :: set cell-Center depth (put Interface at the middle)  C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
# Line 240  C     metricTerms   :: Flag which turns Line 273  C     metricTerms   :: Flag which turns
273  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
274  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
275  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)  
276  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
277  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
278  C                                (default = F = use mom_fluxform package)  C                                (default = F = use mom_fluxform package)
# Line 253  C     highOrderVorticity :: use 3rd/4th Line 283  C     highOrderVorticity :: use 3rd/4th
283  C     useAbsVorticity :: work with f+zeta in Coriolis terms  C     useAbsVorticity :: work with f+zeta in Coriolis terms
284  C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)  C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
285  C     momStepping    :: Turns momentum equation time-stepping off  C     momStepping    :: Turns momentum equation time-stepping off
286    C     calc_wVelocity :: Turns of vertical velocity calculation off
287  C- Temp. & Salt params:  C- Temp. & Salt params:
288  C     tempStepping   :: Turns temperature equation time-stepping off  C     tempStepping   :: Turns temperature equation time-stepping off
289  C     saltStepping   :: Turns salinity equation time-stepping off  C     saltStepping   :: Turns salinity equation time-stepping off
290  C     tempAdvection  :: Flag which turns advection of temperature on and off.  C     tempAdvection  :: Flag which turns advection of temperature on and off.
291    C     tempVertDiff4  :: use vertical bi-harmonic diffusion for temperature
292  C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer  C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
293  C     tempForcing    :: Flag which turns external forcing of temperature on  C     tempForcing    :: Flag which turns external forcing of temperature on
294  C                       and off.  C                       and off.
295  C     saltAdvection  :: Flag which turns advection of salinity on and off.  C     saltAdvection  :: Flag which turns advection of salinity on and off.
296    C     saltVertDiff4  :: use vertical bi-harmonic diffusion for salinity
297  C     saltIsActiveTr :: Salinity  is a dynamically active tracer  C     saltIsActiveTr :: Salinity  is a dynamically active tracer
298  C     saltForcing    :: Flag which turns external forcing of salinity on  C     saltForcing    :: Flag which turns external forcing of salinity on
299  C                       and off.  C                       and off.
300  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     maskIniTemp    :: apply mask to initial Pot.Temp.
301  C                         as a real Fresh Water (=> changes the Sea Level)  C     maskIniSalt    :: apply mask to initial salinity
302  C                         if F, converts P+R-E to salt flux (no SL effect)  C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
303  C- Time-stepping params:  C     checkIniSalt   :: check for points with identically zero initial salinity
304    C- Pressure solver related parameters (PARM02)
305    C     useSRCGSolver  :: Set to true to use conjugate gradient
306    C                       solver with single reduction (only one call of
307    C                       s/r mpi_allreduce), default is false
308    C- Time-stepping & free-surface params:
309  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
310  C     implicitFreeSurface :: Set to true to use implicit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
311    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
312    C                            linear relation Phi_surf = Bo_surf*eta
313    C     uniformFreeSurfLev  :: TRUE if free-surface level-index is uniform (=1)
314  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
315  C     linFSConserveTr     :: Set to true to correct source/sink of tracer  C     linFSConserveTr     :: Set to true to correct source/sink of tracer
316  C                            at the surface due to Linear Free Surface  C                            at the surface due to Linear Free Surface
317  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
318  C                            linear relation Phi_surf = Bo_surf*eta  C                         as a real Fresh Water (=> changes the Sea Level)
319    C                         if F, converts P+R-E to salt flux (no SL effect)
320  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
321  C     nonHydrostatic   :: Using non-hydrostatic algorithm  C     nonHydrostatic   :: Using non-hydrostatic algorithm
322  C     use3Dsolver      :: set to true to use 3-D pressure solver  C     use3Dsolver      :: set to true to use 3-D pressure solver
323  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
324  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
325    C     doResetHFactors   :: Do reset thickness factors @ beginning of each time-step
326  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
327  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
328  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
# Line 299  C     doThetaClimRelax :: Set true if re Line 342  C     doThetaClimRelax :: Set true if re
342  C                        climatology is required.  C                        climatology is required.
343  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
344  C                        climatology is required.  C                        climatology is required.
345    C     balanceThetaClimRelax :: substract global mean effect at every time step
346    C     balanceSaltClimRelax :: substract global mean effect at every time step
347  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
348  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
349  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
350  C- I/O parameters -  C- I/O parameters -
351  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files.
352  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  C                       On some platforms with MPI, option globalFiles is either
353  C                       slow (f77) or does not work (f90).  When  C                       slow or does not work. Use useSingleCpuIO instead.
354  C                       useSingleCpuIO is set, mdsio_writefield.F  C     useSingleCpuIO :: moved to EEPARAMS.h
 C                       outputs from master mpi process only.  
355  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
356  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
357  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
# Line 321  C     snapshot_mdsio     :: use mdsio fo Line 365  C     snapshot_mdsio     :: use mdsio fo
365  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
366  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
367  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
368    C     printDomain     :: controls printing of domain fields (bathy, hFac ...).
369    
370        COMMON /PARM_L/        COMMON /PARM_L/
371       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
372       & usingPCoords, usingZCoords, useDynP_inEos_Zc,       & usingPCoords, usingZCoords, useDynP_inEos_Zc,
373       & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,       & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
374       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCylindricalGrid, usingCurvilinearGrid, hasWetCSCorners,
375       & deepAtmosphere, setInterFDr, setCenterDr,       & deepAtmosphere, setInterFDr, setCenterDr,
376       & no_slip_sides, no_slip_bottom,       & no_slip_sides, no_slip_bottom,
377       & useFullLeith, useStrainTensionVisc, useAreaViscLength,       & useFullLeith, useStrainTensionVisc, useAreaViscLength,
378       & momViscosity, momAdvection, momForcing,       & momViscosity, momAdvection, momForcing,
379       & momPressureForcing, metricTerms, useNHMTerms,       & momPressureForcing, metricTerms, useNHMTerms,
380       & useCoriolis, use3dCoriolis,       & useCoriolis, use3dCoriolis,
      & useConstantF, useBetaPlaneF, useSphereF,  
381       & useCDscheme, vectorInvariantMomentum,       & useCDscheme, vectorInvariantMomentum,
382       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
383       & upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
384       & useAbsVorticity, upwindShear,       & useAbsVorticity, upwindShear,
385       & momStepping, tempStepping, saltStepping,       & momStepping, calc_wVelocity, tempStepping, saltStepping,
386       & tempAdvection, tempIsActiveTr, tempForcing,       & tempAdvection, tempVertDiff4, tempIsActiveTr, tempForcing,
387       & saltAdvection, saltIsActiveTr, saltForcing,       & saltAdvection, saltVertDiff4, saltIsActiveTr, saltForcing,
388       & useRealFreshWaterFlux,       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
389       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & useSRCGSolver,
390       & uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface,
391       & quasiHydrostatic, nonHydrostatic,       & uniformLin_PhiSurf, uniformFreeSurfLev,
392       & use3Dsolver, implicitIntGravWave, staggerTimeStep,       & exactConserv, linFSConserveTr, useRealFreshWaterFlux,
393         & quasiHydrostatic, nonHydrostatic, use3Dsolver,
394         & implicitIntGravWave, staggerTimeStep, doResetHFactors,
395       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
396       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
397       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
398       & momDissip_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
399       & balanceEmPmR, balanceQnet, balancePrintMean,       & balanceEmPmR, balanceQnet, balancePrintMean,
400         & balanceThetaClimRelax, balanceSaltClimRelax,
401       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
402       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
403       & periodicExternalForcing,       & periodicExternalForcing,
404       & globalFiles, useSingleCpuIO,       & globalFiles,
405       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
406       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
407       & writePickupAtEnd,       & writePickupAtEnd,
408       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
409       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast,
410       & inAdMode, inAdTrue, inAdFalse, inAdExact       & printDomain
411    
412        LOGICAL fluidIsAir        LOGICAL fluidIsAir
413        LOGICAL fluidIsWater        LOGICAL fluidIsWater
# Line 370  C                        & Last iteratio Line 417  C                        & Last iteratio
417        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
418        LOGICAL usingSphericalPolarGrid, rotateGrid        LOGICAL usingSphericalPolarGrid, rotateGrid
419        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
420        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid, hasWetCSCorners
421        LOGICAL deepAtmosphere        LOGICAL deepAtmosphere
422        LOGICAL setInterFDr        LOGICAL setInterFDr
423        LOGICAL setCenterDr        LOGICAL setCenterDr
424        LOGICAL useNHMTerms        LOGICAL useNHMTerms
425        LOGICAL no_slip_sides        LOGICAL no_slip_sides
426        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
427          LOGICAL useFullLeith
428          LOGICAL useStrainTensionVisc
429          LOGICAL useAreaViscLength
430        LOGICAL momViscosity        LOGICAL momViscosity
431        LOGICAL momAdvection        LOGICAL momAdvection
432        LOGICAL momForcing        LOGICAL momForcing
# Line 384  C                        & Last iteratio Line 434  C                        & Last iteratio
434        LOGICAL useCoriolis        LOGICAL useCoriolis
435        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
436        LOGICAL tempAdvection        LOGICAL tempAdvection
437          LOGICAL tempVertDiff4
438        LOGICAL tempIsActiveTr        LOGICAL tempIsActiveTr
439        LOGICAL tempForcing        LOGICAL tempForcing
440        LOGICAL saltAdvection        LOGICAL saltAdvection
441          LOGICAL saltVertDiff4
442        LOGICAL saltIsActiveTr        LOGICAL saltIsActiveTr
443        LOGICAL saltForcing        LOGICAL saltForcing
444        LOGICAL useRealFreshWaterFlux        LOGICAL maskIniTemp
445        LOGICAL useFullLeith        LOGICAL maskIniSalt
446        LOGICAL useStrainTensionVisc        LOGICAL checkIniTemp
447        LOGICAL useAreaViscLength        LOGICAL checkIniSalt
448          LOGICAL useSRCGSolver
449        LOGICAL rigidLid        LOGICAL rigidLid
450        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
451          LOGICAL uniformLin_PhiSurf
452          LOGICAL uniformFreeSurfLev
453        LOGICAL exactConserv        LOGICAL exactConserv
454        LOGICAL linFSConserveTr        LOGICAL linFSConserveTr
455        LOGICAL uniformLin_PhiSurf        LOGICAL useRealFreshWaterFlux
456        LOGICAL quasiHydrostatic        LOGICAL quasiHydrostatic
457        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
458        LOGICAL use3Dsolver        LOGICAL use3Dsolver
459        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
460        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
461          LOGICAL doResetHFactors
462        LOGICAL momStepping        LOGICAL momStepping
463          LOGICAL calc_wVelocity
464        LOGICAL tempStepping        LOGICAL tempStepping
465        LOGICAL saltStepping        LOGICAL saltStepping
466        LOGICAL metricTerms        LOGICAL metricTerms
       LOGICAL useConstantF  
       LOGICAL useBetaPlaneF  
       LOGICAL useSphereF  
467        LOGICAL use3dCoriolis        LOGICAL use3dCoriolis
468        LOGICAL useCDscheme        LOGICAL useCDscheme
469        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
# Line 433  C                        & Last iteratio Line 487  C                        & Last iteratio
487        LOGICAL balancePrintMean        LOGICAL balancePrintMean
488        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
489        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
490          LOGICAL balanceThetaClimRelax
491          LOGICAL balanceSaltClimRelax
492        LOGICAL allowFreezing        LOGICAL allowFreezing
493        LOGICAL useOldFreezing        LOGICAL useOldFreezing
494        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
495        LOGICAL globalFiles        LOGICAL globalFiles
       LOGICAL useSingleCpuIO  
496        LOGICAL pickupStrictlyMatch        LOGICAL pickupStrictlyMatch
497        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
498        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
# Line 446  C                        & Last iteratio Line 501  C                        & Last iteratio
501        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
502        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
503        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
504        LOGICAL debugMode        LOGICAL printDomain
       LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact  
505    
506  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
507  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 473  C           defaults to 0.51 but can be Line 527  C           defaults to 0.51 but can be
527  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
528  C     delRc     :: Vertical grid spacing between cell centers (r unit).  C     delRc     :: Vertical grid spacing between cell centers (r unit).
529  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
530  C     delY        on input flags.  C     delY         on input flags. Note: moved to header file SET_GRID.h
531    C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
532    C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
533    C                :: parameter but it makes geographical references simple.)
534    C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
535    C                :: most face (Lat-Lon grid).
536  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
537  C     recip_gravity and its inverse  C     recip_gravity and its inverse
538  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 )
539  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
540  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density (Boussinesq)
541  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
542  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
543  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
# Line 486  C     rho1Ref   :: reference vertical pr Line 545  C     rho1Ref   :: reference vertical pr
545  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
546  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
547  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
548  C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:  C     dBdrRef   :: vertical gradient of reference buoyancy  [(m/s/r)^2]:
549  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
550  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
551  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
# Line 503  C     rUnit2mass :: units conversion fac Line 562  C     rUnit2mass :: units conversion fac
562  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].
563  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
564  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
565  C     phiMin    :: Latitude of southern most cell face.  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
 C     thetaMin  :: Longitude of western most cell face (this  
 C                 is an "inert" parameter but it is included  
 C                 to make geographical references simple.)  
 C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).  
566  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
567  C     f0        :: Reference coriolis parameter ( 1/s )  C     radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
568  C                 ( Southern edge f for beta plane )  C     f0         :: Reference coriolis parameter ( 1/s )
569  C     beta      :: df/dy ( s^-1.m^-1 )  C                   ( Southern edge f for beta plane )
570  C     omega     :: Angular velocity ( rad/s )  C     beta       :: df/dy ( s^-1.m^-1 )
571    C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
572    C                   of rotation (reference value = 2.Omega.Cos(Phi))
573    C     omega      :: Angular velocity ( rad/s )
574  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
575  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
576  C                 momentum vertically ( units of r^2/s )  C                   for vertical mixing of momentum ( units of r^2/s )
577  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh     :: Eddy viscosity coeff. for mixing of
578  C                 momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
579  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
580  C                 momentum laterally, no effect for hydrostatic  C                   momentum laterally, no effect for hydrostatic
581  C                 model, defaults to viscAh if unset ( m^2/s )  C                   model, defaults to viscAh if unset ( m^2/s )
582  C                 Not used if variable horiz. viscosity is used.  C                   Not used if variable horiz. viscosity is used.
583  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4     :: Biharmonic viscosity coeff. for mixing of
584  C                 momentum laterally ( m^4/s )  C                   momentum laterally ( m^4/s )
585  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical  C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
586  C                 momentum laterally, no effect for hydrostatic  C                   momentum laterally, no effect for hydrostatic
587  C                 model, defaults to viscA4 if unset ( m^2/s )  C                   model, defaults to viscA4 if unset ( m^2/s )
588  C                 Not used if variable horiz. viscosity is used.  C                   Not used if variable horiz. viscosity is used.
589  C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
590  C                  (act on Divergence part) ( m^2/s )  C                   (act on Divergence part) ( m^2/s )
591  C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhZ    :: Eddy viscosity coeff. for mixing of momentum laterally
592  C                  (act on Vorticity  part) ( m^2/s )  C                   (act on Vorticity  part) ( m^2/s )
593  C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4D    :: Biharmonic viscosity coeff. for mixing of momentum laterally
594  C                  (act on Divergence part) ( m^4/s )  C                   (act on Divergence part) ( m^4/s )
595  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
596  C                  (act on Vorticity  part) ( m^4/s )  C                   (act on Vorticity  part) ( m^4/s )
597  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
598  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
599  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
# Line 558  C     viscA4GridMax:: maximum and minimu Line 616  C     viscA4GridMax:: maximum and minimu
616  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
617  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
618  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 )  
619  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
620  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
621    C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
622    C                 for mixing of heat vertically ( units of r^2/s )
623    C     diffKr4T  :: vertical profile of Biharmonic diffusion coeff.
624    C                 for mixing of heat vertically ( units of r^4/s )
625  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
626  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 ),  
627  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
628  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
629    C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
630    C                 for mixing of salt vertically ( units of r^2/s ),
631    C     diffKr4S  :: vertical profile of Biharmonic diffusion coeff.
632    C                 for mixing of salt vertically ( units of r^4/s )
633  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
634  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
635  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 588  C                    are referenced to t Line 650  C                    are referenced to t
650  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
651  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
652  C     deltaTfreesurf :: Timestep for free-surface equation ( s )  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
653  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freeSurfFac  :: Parameter to turn implicit free surface term on or off
654  C                    freesurfac = 1. uses implicit free surface  C                     freeSurFac = 1. uses implicit free surface
655  C                    freesurfac = 0. uses rigid lid  C                     freeSurFac = 0. uses rigid lid
656  C     abEps        :: Adams-Bashforth-2 stabilizing weight  C     abEps        :: Adams-Bashforth-2 stabilizing weight
657  C     alph_AB      :: Adams-Bashforth-3 primary factor  C     alph_AB      :: Adams-Bashforth-3 primary factor
658  C     beta_AB      :: Adams-Bashforth-3 secondary factor  C     beta_AB      :: Adams-Bashforth-3 secondary factor
# Line 598  C     implicSurfPress :: parameter of th Line 660  C     implicSurfPress :: parameter of th
660  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
661  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
662  C                     Implicit part of barotropic flow Divergence ( 0-1 )  C                     Implicit part of barotropic flow Divergence ( 0-1 )
663    C     implicitNHPress :: parameter of the Crank-Nickelson time stepping :
664    C                     Implicit part of Non-Hydrostatic Pressure Gradient ( 0-1 )
665  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
666  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    :: Minimum dimensional size of a cell (affects hFacC etc..., m)
667  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    :: Minimum dimensional size of a cell (affects hFacC etc..., Pa)
668  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)  C     hFacMinDr    :: Minimum dimensional size of a cell (-> hFacC etc..., r units)
669  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
670  C     hFacSup        that control vanishing and creating levels  C     hFacSup          that control vanishing and creating levels
671  C     tauCD        :: CD scheme coupling timescale ( 1/s )  C     tauCD         :: CD scheme coupling timescale ( s )
672  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )  C     rCD           :: CD scheme normalised coupling parameter (= 1 - deltaT/tauCD)
673    C     epsAB_CD      :: Adams-Bashforth-2 stabilizing weight used in CD scheme
674  C     baseTime      :: model base time (time origin) = time @ iteration zero  C     baseTime      :: model base time (time origin) = time @ iteration zero
675  C     startTime     :: Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
676  C     endTime       :: Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
677  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
678  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
679  C     dumpFreq      :: Frequency with which model state is written to  C     dumpFreq      :: Frequency with which model state is written to
680  C                     post-processing files ( s ).  C                      post-processing files ( s ).
681  C     diagFreq      :: Frequency with which model writes diagnostic output  C     diagFreq      :: Frequency with which model writes diagnostic output
682  C                     of intermediate quantities.  C                      of intermediate quantities.
683  C     afFacMom      :: Advection of momentum term tracer parameter  C     afFacMom      :: Advection of momentum term tracer parameter
684  C     vfFacMom      :: Momentum viscosity tracer parameter  C     vfFacMom      :: Momentum viscosity tracer parameter
685  C     pfFacMom      :: Momentum pressure forcing tracer parameter  C     pfFacMom      :: Momentum pressure forcing tracer parameter
# Line 641  C     convertFW2Salt :: salinity, used t Line 706  C     convertFW2Salt :: salinity, used t
706  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
707  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
708  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
709    C     temp_addMass :: temperature of addMass array
710    C     salt_addMass :: salinity of addMass array
711  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
712  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
713  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
714  C     hMixCrit    :: criteria for mixed-layer diagnostic  C     hMixCriteria:: criteria for mixed-layer diagnostic
715    C     dRhoSmall   :: parameter for mixed-layer diagnostic
716    C     hMixSmooth  :: Smoothing parameter for mixed-layer diag (default=0=no smoothing)
717  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
718  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
719  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
720    C     rSigmaBnd   :: vertical position (in r-unit) of r/sigma transition (Hybrid-Sigma)
721  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
722  C                           (default=2: full drag ; =1: gives half-slip BC)  C                           (default=2: full drag ; =1: gives half-slip BC)
723  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
# Line 663  C     thetaEuler    :: Euler angle, rota Line 733  C     thetaEuler    :: Euler angle, rota
733  C     psiEuler      :: Euler angle, rotation about new z-axis  C     psiEuler      :: Euler angle, rotation about new z-axis
734        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
735       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
736       & delR, delRc, delX, delY,       & delR, delRc, xgOrigin, ygOrigin,
737       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
738       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
739       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & rSphere, recip_rSphere, radius_fromHorizGrid,
740       & viscAh, viscAhW, viscAhMax,       & f0, beta, fPrime, omega, rotationPeriod,
741         & viscFacAdj, viscAh, viscAhW, viscAhMax,
742       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
743       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
744       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
# Line 675  C     psiEuler      :: Euler angle, rota Line 746  C     psiEuler      :: Euler angle, rota
746       & viscA4, viscA4W, viscA4Max,       & viscA4, viscA4W, viscA4Max,
747       & viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Grid, viscA4GridMax, viscA4GridMin,
748       & viscAhReMax, viscA4ReMax,       & viscAhReMax, viscA4ReMax,
749       & viscC4leith, viscC4leithD, viscAr,       & viscC4leith, viscC4leithD, viscArNr,
750       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT, diffKr4T,
751       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS, diffKr4S,
752       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
753       & BL79LatVary,       & BL79LatVary,
754       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
755       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & tauCD, rCD, epsAB_CD,
756         & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
757       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
758       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
759       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhoNil, rhoConst, recip_rhoConst,
760       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
761       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
762       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
# Line 692  C     psiEuler      :: Euler angle, rota Line 764  C     psiEuler      :: Euler angle, rota
764       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
765       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
766       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
767       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq,
768       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
769       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
770       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
771       & hFacMinDr, hFacMinDp,       & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
772       & ivdc_kappa, hMixCriteria, Ro_SeaLevel,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth,
773         & Ro_SeaLevel, rSigmaBnd,
774       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
775       & smoothAbsFuncRange,       & smoothAbsFuncRange,
776       & tCylIn, tCylOut,       & tCylIn, tCylOut,
# Line 709  C     psiEuler      :: Euler angle, rota Line 782  C     psiEuler      :: Euler angle, rota
782        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
783        _RL delR(Nr)        _RL delR(Nr)
784        _RL delRc(Nr+1)        _RL delRc(Nr+1)
785        _RL delX(Nx)        _RL xgOrigin
786        _RL delY(Ny)        _RL ygOrigin
787        _RL deltaT        _RL deltaT
788        _RL deltaTClock        _RL deltaTClock
789        _RL deltaTmom        _RL deltaTmom
790        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
791        _RL deltaTfreesurf        _RL deltaTfreesurf
792        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
       _RL phiMin  
       _RL thetaMin  
793        _RL rSphere        _RL rSphere
794        _RL recip_rSphere        _RL recip_rSphere
795          _RL radius_fromHorizGrid
796        _RL f0        _RL f0
797          _RL beta
798          _RL fPrime
799          _RL omega
800          _RL rotationPeriod
801        _RL freeSurfFac        _RL freeSurfFac
802        _RL implicSurfPress        _RL implicSurfPress
803        _RL implicDiv2Dflow        _RL implicDiv2Dflow
804          _RL implicitNHPress
805        _RL hFacMin        _RL hFacMin
806        _RL hFacMinDz        _RL hFacMinDz
807        _RL hFacMinDp        _RL hFacMinDp
808        _RL hFacMinDr        _RL hFacMinDr
809        _RL hFacInf        _RL hFacInf
810        _RL hFacSup        _RL hFacSup
811        _RL beta        _RL viscArNr(Nr)
812        _RL viscAr        _RL viscFacAdj
813        _RL viscAh        _RL viscAh
814        _RL viscAhW        _RL viscAhW
815        _RL viscAhD        _RL viscAhD
# Line 754  C     psiEuler      :: Euler angle, rota Line 831  C     psiEuler      :: Euler angle, rota
831        _RL viscC4leithD        _RL viscC4leithD
832        _RL viscC4smag        _RL viscC4smag
833        _RL diffKhT        _RL diffKhT
       _RL diffKrNrT(Nr)  
834        _RL diffK4T        _RL diffK4T
835          _RL diffKrNrT(Nr)
836          _RL diffKr4T(Nr)
837        _RL diffKhS        _RL diffKhS
       _RL diffKrNrS(Nr)  
838        _RL diffK4S        _RL diffK4S
839          _RL diffKrNrS(Nr)
840          _RL diffKr4S(Nr)
841        _RL diffKrBL79surf        _RL diffKrBL79surf
842        _RL diffKrBL79deep        _RL diffKrBL79deep
843        _RL diffKrBL79scl        _RL diffKrBL79scl
# Line 768  C     psiEuler      :: Euler angle, rota Line 847  C     psiEuler      :: Euler angle, rota
847        _RL diffKrBLEQdeep        _RL diffKrBLEQdeep
848        _RL diffKrBLEQscl        _RL diffKrBLEQscl
849        _RL diffKrBLEQHo        _RL diffKrBLEQHo
850        _RL delt        _RL tauCD, rCD, epsAB_CD
       _RL tauCD  
       _RL rCD  
851        _RL gravity        _RL gravity
852        _RL recip_gravity        _RL recip_gravity
853        _RL gBaro        _RL gBaro
854        _RL rhonil,        recip_rhonil        _RL rhoNil
855        _RL rhoConst,      recip_rhoConst        _RL rhoConst,      recip_rhoConst
856        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
857        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
# Line 806  C     psiEuler      :: Euler angle, rota Line 883  C     psiEuler      :: Euler angle, rota
883        _RL mtFacMom        _RL mtFacMom
884        _RL cosPower        _RL cosPower
885        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
       _RL rotationPeriod  
886        _RL tauThetaClimRelax        _RL tauThetaClimRelax
887        _RL tauSaltClimRelax        _RL tauSaltClimRelax
888        _RL latBandClimRelax        _RL latBandClimRelax
# Line 816  C     psiEuler      :: Euler angle, rota Line 891  C     psiEuler      :: Euler angle, rota
891        _RL convertFW2Salt        _RL convertFW2Salt
892        _RL temp_EvPrRn        _RL temp_EvPrRn
893        _RL salt_EvPrRn        _RL salt_EvPrRn
894          _RL temp_addMass
895          _RL salt_addMass
896        _RL ivdc_kappa        _RL ivdc_kappa
897        _RL hMixCriteria        _RL hMixCriteria
898          _RL dRhoSmall
899          _RL hMixSmooth
900        _RL Ro_SeaLevel        _RL Ro_SeaLevel
901          _RL rSigmaBnd
902        _RL sideDragFactor        _RL sideDragFactor
903        _RL bottomDragLinear        _RL bottomDragLinear
904        _RL bottomDragQuadratic        _RL bottomDragQuadratic
# Line 865  C Logical flags for selecting packages Line 945  C Logical flags for selecting packages
945        LOGICAL useKPP        LOGICAL useKPP
946        LOGICAL useGMRedi        LOGICAL useGMRedi
947        LOGICAL useDOWN_SLOPE        LOGICAL useDOWN_SLOPE
948          LOGICAL useBBL
949        LOGICAL useCAL        LOGICAL useCAL
950        LOGICAL useEXF        LOGICAL useEXF
951        LOGICAL useBulkForce        LOGICAL useBulkForce
952        LOGICAL useEBM        LOGICAL useEBM
953        LOGICAL useCheapAML        LOGICAL useCheapAML
954        LOGICAL useGrdchk        LOGICAL useGrdchk
955          LOGICAL useSMOOTH
956          LOGICAL usePROFILES
957        LOGICAL useECCO        LOGICAL useECCO
958        LOGICAL useSBO        LOGICAL useSBO
959        LOGICAL useFLT        LOGICAL useFLT
# Line 879  C Logical flags for selecting packages Line 962  C Logical flags for selecting packages
962        LOGICAL useRBCS        LOGICAL useRBCS
963        LOGICAL useOffLine        LOGICAL useOffLine
964        LOGICAL useMATRIX        LOGICAL useMATRIX
965          LOGICAL useFRAZIL
966        LOGICAL useSEAICE        LOGICAL useSEAICE
967        LOGICAL useSALT_PLUME        LOGICAL useSALT_PLUME
968        LOGICAL useShelfIce        LOGICAL useShelfIce
969          LOGICAL useStreamIce
970          LOGICAL useICEFRONT
971        LOGICAL useThSIce        LOGICAL useThSIce
972        LOGICAL useATM2d        LOGICAL useATM2d
973        LOGICAL useAIM        LOGICAL useAIM
# Line 890  C Logical flags for selecting packages Line 976  C Logical flags for selecting packages
976        LOGICAL useGridAlt        LOGICAL useGridAlt
977        LOGICAL useDiagnostics        LOGICAL useDiagnostics
978        LOGICAL useREGRID        LOGICAL useREGRID
979          LOGICAL useLayers
980        LOGICAL useMNC        LOGICAL useMNC
981        LOGICAL useRunClock        LOGICAL useRunClock
982        LOGICAL useEMBED_FILES        LOGICAL useEMBED_FILES
# Line 897  C Logical flags for selecting packages Line 984  C Logical flags for selecting packages
984        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
985       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
986       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
987       &        useGMRedi, useDOWN_SLOPE,       &        useGMRedi, useBBL, useDOWN_SLOPE,
988       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
989       &        useGrdchk, useECCO, useSBO, useFLT,       &        useGrdchk,useSMOOTH,usePROFILES,useECCO,useSBO, useFLT,
990       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
991       &        useSEAICE, useSALT_PLUME, useShelfIce, useThSIce,       &        useFRAZIL, useSEAICE, useSALT_PLUME, useShelfIce,
992         &        useStreamIce, useICEFRONT, useThSIce,
993       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
994       &        useDiagnostics, useREGRID, useMNC,       &        useDiagnostics, useREGRID, useLayers, useMNC,
995       &        useRunClock, useEMBED_FILES,       &        useRunClock, useEMBED_FILES,
996       &        useMYPACKAGE       &        useMYPACKAGE
997    
998  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
999  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
1000  CEH3 ;;; End: ***  CEH3 ;;; End: ***
Legend:
Removed from v.1.223  
changed lines
  Added in v.1.265
  ViewVC Help
Powered by ViewVC 1.1.22