/[MITgcm]/MITgcm/model/inc/PARAMS.h
ViewVC logotype

Diff of /MITgcm/model/inc/PARAMS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.240 by mlosch, Sat Sep 25 23:09:54 2010 UTC revision 1.260 by jmc, Wed Apr 11 03:52:43 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)
# Line 59  C     viscA4Zfile     :: File containing Line 64  C     viscA4Zfile     :: File containing
64  C     zonalWindFile   :: File containing zonal wind data  C     zonalWindFile   :: File containing zonal wind data
65  C     meridWindFile   :: File containing meridional wind data  C     meridWindFile   :: File containing meridional wind data
66  C     thetaClimFile   :: File containing surface theta climataology used  C     thetaClimFile   :: File containing surface theta climataology used
67  C                       in relaxation term -lambda(theta-theta*)  C                        in relaxation term -lambda(theta-theta*)
68  C     saltClimFile    :: File containing surface salt climataology used  C     saltClimFile    :: File containing surface salt climataology used
69  C                       in relaxation term -lambda(salt-salt*)  C                        in relaxation term -lambda(salt-salt*)
70  C     surfQfile       :: File containing surface heat flux, excluding SW  C     surfQfile       :: File containing surface heat flux, excluding SW
71  C                        (old version, kept for backward compatibility)  C                        (old version, kept for backward compatibility)
72  C     surfQnetFile    :: File containing surface net heat flux  C     surfQnetFile    :: File containing surface net heat flux
# Line 78  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, hybSigmFile,       &                delRFile, delRcFile, hybSigmFile,
89       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
# Line 99  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
# Line 137  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:  C     selectNHfreeSurf    :: option for Non-Hydrostatic (free-)Surface formulation:
172  C                           =0 (default) hydrostatic surf. ; > 0 add NH effects.  C                           =0 (default) hydrostatic surf. ; > 0 add NH effects.
 C     selectSigmaCoord    :: option related to sigma vertical coordinate  
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 173  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,       &        selectNHfreeSurf,
      &        selectSigmaCoord,  
202       &        selectAddFluid,       &        selectAddFluid,
203       &        momForcingOutAB, tracForcingOutAB,       &        momForcingOutAB, tracForcingOutAB,
204       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
# Line 197  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        INTEGER selectNHfreeSurf
       INTEGER selectSigmaCoord  
225        INTEGER selectAddFluid        INTEGER selectAddFluid
226        INTEGER momForcingOutAB, tracForcingOutAB        INTEGER momForcingOutAB, tracForcingOutAB
227        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
# Line 219  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
252  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
# Line 257  C     metricTerms   :: Flag which turns Line 272  C     metricTerms   :: Flag which turns
272  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
273  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
274  C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off  C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
 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)  
275  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
276  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
277  C                                (default = F = use mom_fluxform package)  C                                (default = F = use mom_fluxform package)
# Line 270  C     highOrderVorticity :: use 3rd/4th Line 282  C     highOrderVorticity :: use 3rd/4th
282  C     useAbsVorticity :: work with f+zeta in Coriolis terms  C     useAbsVorticity :: work with f+zeta in Coriolis terms
283  C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)  C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
284  C     momStepping    :: Turns momentum equation time-stepping off  C     momStepping    :: Turns momentum equation time-stepping off
285    C     calc_wVelocity :: Turns of vertical velocity calculation off
286  C- Temp. & Salt params:  C- Temp. & Salt params:
287  C     tempStepping   :: Turns temperature equation time-stepping off  C     tempStepping   :: Turns temperature equation time-stepping off
288  C     saltStepping   :: Turns salinity equation time-stepping off  C     saltStepping   :: Turns salinity equation time-stepping off
# Line 285  C     maskIniTemp    :: apply mask to in Line 298  C     maskIniTemp    :: apply mask to in
298  C     maskIniSalt    :: apply mask to initial salinity  C     maskIniSalt    :: apply mask to initial salinity
299  C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.  C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
300  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)  
301  C- Pressure solver related parameters (PARM02)  C- Pressure solver related parameters (PARM02)
302  C     useSRCGSolver  :: Set to true to use conjugate gradient  C     useSRCGSolver  :: Set to true to use conjugate gradient
303  C                       solver with single reduction (only one call of  C                       solver with single reduction (only one call of
304  C                       s/r mpi_allreduce), default is false  C                       s/r mpi_allreduce), default is false
305  C- Time-stepping params:  C- Time-stepping & free-surface params:
306  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
307  C     implicitFreeSurface :: Set to true to use implicit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
308    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
309    C                            linear relation Phi_surf = Bo_surf*eta
310    C     uniformFreeSurfLev  :: TRUE if free-surface level-index is uniform (=1)
311  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
312  C     linFSConserveTr     :: Set to true to correct source/sink of tracer  C     linFSConserveTr     :: Set to true to correct source/sink of tracer
313  C                            at the surface due to Linear Free Surface  C                            at the surface due to Linear Free Surface
314  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
315  C                            linear relation Phi_surf = Bo_surf*eta  C                         as a real Fresh Water (=> changes the Sea Level)
316    C                         if F, converts P+R-E to salt flux (no SL effect)
317  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
318  C     nonHydrostatic   :: Using non-hydrostatic algorithm  C     nonHydrostatic   :: Using non-hydrostatic algorithm
319  C     use3Dsolver      :: set to true to use 3-D pressure solver  C     use3Dsolver      :: set to true to use 3-D pressure solver
320  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
321  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
322    C     doResetHFactors   :: Do reset thickness factors @ beginning of each time-step
323  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
324  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
325  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
# Line 345  C     snapshot_mdsio     :: use mdsio fo Line 360  C     snapshot_mdsio     :: use mdsio fo
360  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
361  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
362  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
363    C     printDomain     :: controls printing of domain fields (bathy, hFac ...).
364    
365        COMMON /PARM_L/        COMMON /PARM_L/
366       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
# Line 357  C                        & Last iteratio Line 373  C                        & Last iteratio
373       & momViscosity, momAdvection, momForcing,       & momViscosity, momAdvection, momForcing,
374       & momPressureForcing, metricTerms, useNHMTerms,       & momPressureForcing, metricTerms, useNHMTerms,
375       & useCoriolis, use3dCoriolis,       & useCoriolis, use3dCoriolis,
      & useConstantF, useBetaPlaneF, useSphereF,  
376       & useCDscheme, vectorInvariantMomentum,       & useCDscheme, vectorInvariantMomentum,
377       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
378       & upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
379       & useAbsVorticity, upwindShear,       & useAbsVorticity, upwindShear,
380       & momStepping, tempStepping, saltStepping,       & momStepping, calc_wVelocity, tempStepping, saltStepping,
381       & tempAdvection, tempIsActiveTr, tempForcing,       & tempAdvection, tempIsActiveTr, tempForcing,
382       & saltAdvection, saltIsActiveTr, saltForcing,       & saltAdvection, saltIsActiveTr, saltForcing,
383       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
384       & useRealFreshWaterFlux,       & useSRCGSolver,
385       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface,
386       & uniformLin_PhiSurf,       & uniformLin_PhiSurf, uniformFreeSurfLev,
387       & quasiHydrostatic, nonHydrostatic,       & exactConserv, linFSConserveTr, useRealFreshWaterFlux,
388       & use3Dsolver, implicitIntGravWave, staggerTimeStep,       & quasiHydrostatic, nonHydrostatic, use3Dsolver,
389         & implicitIntGravWave, staggerTimeStep, doResetHFactors,
390       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
391       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
392       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
# Line 384  C                        & Last iteratio Line 400  C                        & Last iteratio
400       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
401       & writePickupAtEnd,       & writePickupAtEnd,
402       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
403       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast,
404       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & printDomain,
405       & useSRCGSolver       & inAdMode, inAdTrue, inAdFalse, inAdExact
406    
407        LOGICAL fluidIsAir        LOGICAL fluidIsAir
408        LOGICAL fluidIsWater        LOGICAL fluidIsWater
# Line 403  C                        & Last iteratio Line 419  C                        & Last iteratio
419        LOGICAL useNHMTerms        LOGICAL useNHMTerms
420        LOGICAL no_slip_sides        LOGICAL no_slip_sides
421        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
422          LOGICAL useFullLeith
423          LOGICAL useStrainTensionVisc
424          LOGICAL useAreaViscLength
425        LOGICAL momViscosity        LOGICAL momViscosity
426        LOGICAL momAdvection        LOGICAL momAdvection
427        LOGICAL momForcing        LOGICAL momForcing
# Line 419  C                        & Last iteratio Line 438  C                        & Last iteratio
438        LOGICAL maskIniSalt        LOGICAL maskIniSalt
439        LOGICAL checkIniTemp        LOGICAL checkIniTemp
440        LOGICAL checkIniSalt        LOGICAL checkIniSalt
441        LOGICAL useRealFreshWaterFlux        LOGICAL useSRCGSolver
       LOGICAL useFullLeith  
       LOGICAL useStrainTensionVisc  
       LOGICAL useAreaViscLength  
442        LOGICAL rigidLid        LOGICAL rigidLid
443        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
444          LOGICAL uniformLin_PhiSurf
445          LOGICAL uniformFreeSurfLev
446        LOGICAL exactConserv        LOGICAL exactConserv
447        LOGICAL linFSConserveTr        LOGICAL linFSConserveTr
448        LOGICAL uniformLin_PhiSurf        LOGICAL useRealFreshWaterFlux
449        LOGICAL quasiHydrostatic        LOGICAL quasiHydrostatic
450        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
451        LOGICAL use3Dsolver        LOGICAL use3Dsolver
452        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
453        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
454          LOGICAL doResetHFactors
455        LOGICAL momStepping        LOGICAL momStepping
456          LOGICAL calc_wVelocity
457        LOGICAL tempStepping        LOGICAL tempStepping
458        LOGICAL saltStepping        LOGICAL saltStepping
459        LOGICAL metricTerms        LOGICAL metricTerms
       LOGICAL useConstantF  
       LOGICAL useBetaPlaneF  
       LOGICAL useSphereF  
460        LOGICAL use3dCoriolis        LOGICAL use3dCoriolis
461        LOGICAL useCDscheme        LOGICAL useCDscheme
462        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
# Line 475  C                        & Last iteratio Line 492  C                        & Last iteratio
492        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
493        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
494        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
495        LOGICAL debugMode        LOGICAL printDomain
496        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
       LOGICAL useSRCGSolver  
497    
498  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
499  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 503  C           defaults to 0.51 but can be Line 519  C           defaults to 0.51 but can be
519  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
520  C     delRc     :: Vertical grid spacing between cell centers (r unit).  C     delRc     :: Vertical grid spacing between cell centers (r unit).
521  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
522  C     delY        on input flags.  C     delY         on input flags. Note: moved to header file SET_GRID.h
523    C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
524    C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
525    C                :: parameter but it makes geographical references simple.)
526    C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
527    C                :: most face (Lat-Lon grid).
528  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
529  C     recip_gravity and its inverse  C     recip_gravity and its inverse
530  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 )
531  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
532  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density (Boussinesq)
533  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
534  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
535  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
# Line 516  C     rho1Ref   :: reference vertical pr Line 537  C     rho1Ref   :: reference vertical pr
537  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
538  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
539  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
540  C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:  C     dBdrRef   :: vertical gradient of reference buoyancy  [(m/s/r)^2]:
541  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
542  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
543  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
# Line 533  C     rUnit2mass :: units conversion fac Line 554  C     rUnit2mass :: units conversion fac
554  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].
555  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
556  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).  
557  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
558  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
559    C     radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
560  C     f0         :: Reference coriolis parameter ( 1/s )  C     f0         :: Reference coriolis parameter ( 1/s )
561  C                   ( Southern edge f for beta plane )  C                   ( Southern edge f for beta plane )
562  C     beta       :: df/dy ( s^-1.m^-1 )  C     beta       :: df/dy ( s^-1.m^-1 )
563    C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
564    C                   of rotation (reference value = 2.Omega.Cos(Phi))
565  C     omega      :: Angular velocity ( rad/s )  C     omega      :: Angular velocity ( rad/s )
566  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
567  C     viscArNr   :: vertical profile of Eddy viscosity coeff.  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
# Line 619  C                    are referenced to t Line 638  C                    are referenced to t
638  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
639  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
640  C     deltaTfreesurf :: Timestep for free-surface equation ( s )  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
641  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freeSurfFac  :: Parameter to turn implicit free surface term on or off
642  C                    freesurfac = 1. uses implicit free surface  C                     freeSurFac = 1. uses implicit free surface
643  C                    freesurfac = 0. uses rigid lid  C                     freeSurFac = 0. uses rigid lid
644  C     abEps        :: Adams-Bashforth-2 stabilizing weight  C     abEps        :: Adams-Bashforth-2 stabilizing weight
645  C     alph_AB      :: Adams-Bashforth-3 primary factor  C     alph_AB      :: Adams-Bashforth-3 primary factor
646  C     beta_AB      :: Adams-Bashforth-3 secondary factor  C     beta_AB      :: Adams-Bashforth-3 secondary factor
# Line 646  C     endTime       :: Ending time for t Line 665  C     endTime       :: Ending time for t
665  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
666  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
667  C     dumpFreq      :: Frequency with which model state is written to  C     dumpFreq      :: Frequency with which model state is written to
668  C                     post-processing files ( s ).  C                      post-processing files ( s ).
669  C     diagFreq      :: Frequency with which model writes diagnostic output  C     diagFreq      :: Frequency with which model writes diagnostic output
670  C                     of intermediate quantities.  C                      of intermediate quantities.
671  C     afFacMom      :: Advection of momentum term tracer parameter  C     afFacMom      :: Advection of momentum term tracer parameter
672  C     vfFacMom      :: Momentum viscosity tracer parameter  C     vfFacMom      :: Momentum viscosity tracer parameter
673  C     pfFacMom      :: Momentum pressure forcing tracer parameter  C     pfFacMom      :: Momentum pressure forcing tracer parameter
# Line 702  C     thetaEuler    :: Euler angle, rota Line 721  C     thetaEuler    :: Euler angle, rota
721  C     psiEuler      :: Euler angle, rotation about new z-axis  C     psiEuler      :: Euler angle, rotation about new z-axis
722        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
723       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
724       & delR, delRc, delX, delY,       & delR, delRc, xgOrigin, ygOrigin,
725       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
726       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
727       & xgOrigin, ygOrigin, rSphere, recip_RSphere, f0, beta,       & rSphere, recip_rSphere, radius_fromHorizGrid,
728       & viscAh, viscAhW, viscAhMax,       & f0, beta, fPrime, omega, rotationPeriod,
729         & viscFacAdj, viscAh, viscAhW, viscAhMax,
730       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
731       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
732       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
# Line 724  C     psiEuler      :: Euler angle, rota Line 744  C     psiEuler      :: Euler angle, rota
744       & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,       & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
745       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
746       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
747       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhoNil, rhoConst, recip_rhoConst,
748       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
749       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
750       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
# Line 732  C     psiEuler      :: Euler angle, rota Line 752  C     psiEuler      :: Euler angle, rota
752       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
753       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
754       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
755       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq,
756       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
757       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
758       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
# Line 750  C     psiEuler      :: Euler angle, rota Line 770  C     psiEuler      :: Euler angle, rota
770        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
771        _RL delR(Nr)        _RL delR(Nr)
772        _RL delRc(Nr+1)        _RL delRc(Nr+1)
773        _RL delX(Nx)        _RL xgOrigin
774        _RL delY(Ny)        _RL ygOrigin
775        _RL deltaT        _RL deltaT
776        _RL deltaTClock        _RL deltaTClock
777        _RL deltaTmom        _RL deltaTmom
778        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
779        _RL deltaTfreesurf        _RL deltaTfreesurf
780        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
       _RL xgOrigin  
       _RL ygOrigin  
781        _RL rSphere        _RL rSphere
782        _RL recip_rSphere        _RL recip_rSphere
783          _RL radius_fromHorizGrid
784        _RL f0        _RL f0
785          _RL beta
786          _RL fPrime
787          _RL omega
788          _RL rotationPeriod
789        _RL freeSurfFac        _RL freeSurfFac
790        _RL implicSurfPress        _RL implicSurfPress
791        _RL implicDiv2Dflow        _RL implicDiv2Dflow
# Line 773  C     psiEuler      :: Euler angle, rota Line 796  C     psiEuler      :: Euler angle, rota
796        _RL hFacMinDr        _RL hFacMinDr
797        _RL hFacInf        _RL hFacInf
798        _RL hFacSup        _RL hFacSup
       _RL beta  
799        _RL viscArNr(Nr)        _RL viscArNr(Nr)
800          _RL viscFacAdj
801        _RL viscAh        _RL viscAh
802        _RL viscAhW        _RL viscAhW
803        _RL viscAhD        _RL viscAhD
# Line 814  C     psiEuler      :: Euler angle, rota Line 837  C     psiEuler      :: Euler angle, rota
837        _RL gravity        _RL gravity
838        _RL recip_gravity        _RL recip_gravity
839        _RL gBaro        _RL gBaro
840        _RL rhonil,        recip_rhonil        _RL rhoNil
841        _RL rhoConst,      recip_rhoConst        _RL rhoConst,      recip_rhoConst
842        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
843        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
# Line 846  C     psiEuler      :: Euler angle, rota Line 869  C     psiEuler      :: Euler angle, rota
869        _RL mtFacMom        _RL mtFacMom
870        _RL cosPower        _RL cosPower
871        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
       _RL rotationPeriod  
872        _RL tauThetaClimRelax        _RL tauThetaClimRelax
873        _RL tauSaltClimRelax        _RL tauSaltClimRelax
874        _RL latBandClimRelax        _RL latBandClimRelax
# Line 910  C Logical flags for selecting packages Line 931  C Logical flags for selecting packages
931        LOGICAL useKPP        LOGICAL useKPP
932        LOGICAL useGMRedi        LOGICAL useGMRedi
933        LOGICAL useDOWN_SLOPE        LOGICAL useDOWN_SLOPE
934          LOGICAL useBBL
935        LOGICAL useCAL        LOGICAL useCAL
936        LOGICAL useEXF        LOGICAL useEXF
937        LOGICAL useBulkForce        LOGICAL useBulkForce
# Line 925  C Logical flags for selecting packages Line 947  C Logical flags for selecting packages
947        LOGICAL useRBCS        LOGICAL useRBCS
948        LOGICAL useOffLine        LOGICAL useOffLine
949        LOGICAL useMATRIX        LOGICAL useMATRIX
950          LOGICAL useFRAZIL
951        LOGICAL useSEAICE        LOGICAL useSEAICE
952        LOGICAL useSALT_PLUME        LOGICAL useSALT_PLUME
953        LOGICAL useShelfIce        LOGICAL useShelfIce
954          LOGICAL useStreamIce
955        LOGICAL useICEFRONT        LOGICAL useICEFRONT
956        LOGICAL useThSIce        LOGICAL useThSIce
957        LOGICAL useATM2d        LOGICAL useATM2d
# Line 941  C Logical flags for selecting packages Line 965  C Logical flags for selecting packages
965        LOGICAL useMNC        LOGICAL useMNC
966        LOGICAL useRunClock        LOGICAL useRunClock
967        LOGICAL useEMBED_FILES        LOGICAL useEMBED_FILES
       LOGICAL useOASIS  
968        LOGICAL useMYPACKAGE        LOGICAL useMYPACKAGE
969        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
970       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
971       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
972       &        useGMRedi, useDOWN_SLOPE,       &        useGMRedi, useBBL, useDOWN_SLOPE,
973       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
974       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,
975       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
976       &        useSEAICE, useSALT_PLUME, useShelfIce,       &        useFRAZIL, useSEAICE, useSALT_PLUME, useShelfIce,
977       &        useICEFRONT, useThSIce,       &        useStreamIce, useICEFRONT, useThSIce,
978       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
979       &        useDiagnostics, useREGRID, useLayers, useMNC,       &        useDiagnostics, useREGRID, useLayers, useMNC,
980       &        useRunClock, useEMBED_FILES,       &        useRunClock, useEMBED_FILES,
      &        useOASIS,  
981       &        useMYPACKAGE       &        useMYPACKAGE
982    
983    C     Logical flags for turning off parts of the code in adjoint mode
984          LOGICAL useKPPinAdMode, useKPPinFwdMode
985          LOGICAL useGMrediInAdMode, useGMrediInFwdMode
986          LOGICAL useSEAICEinAdMode, useSEAICEinFwdMode
987          COMMON /PARM_PACKAGES_ADJ/
988         &       useKPPinAdMode, useKPPinFwdMode,
989         &       useGMrediInAdMode, useGMrediInFwdMode,
990         &       useSEAICEinAdMode, useSEAICEinFwdMode
991    
992  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
993  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
994  CEH3 ;;; End: ***  CEH3 ;;; End: ***
Legend:
Removed from v.1.240  
changed lines
  Added in v.1.260
  ViewVC Help
Powered by ViewVC 1.1.22