/[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.234 by jmc, Tue Dec 8 00:29:32 2009 UTC revision 1.257 by jmc, Sat Jan 21 18:46:27 2012 UTC
# Line 33  C     pickupSuff      :: force to start Line 33  C     pickupSuff      :: force to start
33  C                        and read pickup files with this suffix (max 10 Char.)  C                        and read pickup files with this suffix (max 10 Char.)
34  C     mdsioLocalDir   :: read-write tiled file from/to this directory name  C     mdsioLocalDir   :: read-write tiled file from/to this directory name
35  C                        (+ 4 digits Processor-Rank) instead of current dir.  C                        (+ 4 digits Processor-Rank) instead of current dir.
36    C     adTapeDir       :: read-write checkpointing tape files from/to this
37    C                        directory name instead of current dir. Conflicts
38    C                        mdsioLocalDir, so only one of the two can be set.
39    C                        In contrast to mdsioLocalDir, if specified adTapeDir
40    C                        must exist before the model starts.
41  C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)  C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
42  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
43  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
44  C     delRFile      :: File containing vertical grid spacing delR  (1.D array)  C     delRFile      :: File containing vertical grid spacing delR  (1.D array)
45  C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)  C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)
46    C     hybSigmFile   :: File containing hybrid-sigma vertical coord. coeff. (2x 1.D)
47  C     delXFile      :: File containing X-spacing grid definition (1.D array)  C     delXFile      :: File containing X-spacing grid definition (1.D array)
48  C     delYFile      :: File containing Y-spacing grid definition (1.D array)  C     delYFile      :: File containing Y-spacing grid definition (1.D array)
49  C     horizGridFile :: File containing horizontal-grid definition  C     horizGridFile :: File containing horizontal-grid definition
# Line 51  C                        for potential t Line 57  C                        for potential t
57  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
58  C                        for salinity.  C                        for salinity.
59  C     diffKrFile      :: File containing 3D specification of vertical diffusivity  C     diffKrFile      :: File containing 3D specification of vertical diffusivity
60    C     viscAhDfile     :: File containing 3D specification of horizontal viscosity
61    C     viscAhZfile     :: File containing 3D specification of horizontal viscosity
62    C     viscA4Dfile     :: File containing 3D specification of horizontal viscosity
63    C     viscA4Zfile     :: File containing 3D specification of horizontal viscosity
64  C     zonalWindFile   :: File containing zonal wind data  C     zonalWindFile   :: File containing zonal wind data
65  C     meridWindFile   :: File containing meridional wind data  C     meridWindFile   :: File containing meridional wind data
66  C     thetaClimFile   :: File containing surface theta climataology used  C     thetaClimFile   :: File containing surface theta climataology used
# Line 73  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,       &                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 92  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        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 134  C     cg3dMaxIters        :: Maximum num Line 152  C     cg3dMaxIters        :: Maximum num
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
# 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,       &        selectNHfreeSurf,
202       &        selectAddFluid,       &        selectAddFluid,
# Line 183  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
# Line 242  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 255  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 290  C     nonHydrostatic   :: Using non-hydr Line 318  C     nonHydrostatic   :: Using non-hydr
318  C     use3Dsolver      :: set to true to use 3-D pressure solver  C     use3Dsolver      :: set to true to use 3-D pressure solver
319  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
320  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
321    C     doResetHFactors   :: Do reset thickness factors @ beginning of each time-step
322  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
323  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
324  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
# Line 310  C                        climatology is Line 339  C                        climatology is
339  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
340  C                        climatology is required.  C                        climatology is required.
341  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
342    C     allowInteriorFreezing :: Allow water at depth to freeze and rise to the surface
343  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
344  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
345  C- I/O parameters -  C- I/O parameters -
346  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files.
347  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  C                       On some platforms with MPI, option globalFiles is either
348  C                       slow (f77) or does not work (f90).  When  C                       slow or does not work. Use useSingleCpuIO instead.
349  C                       useSingleCpuIO is set, mdsio_writefield.F  C     useSingleCpuIO :: moved to EEPARAMS.h
 C                       outputs from master mpi process only.  
350  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
351  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
352  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
# Line 331  C     snapshot_mdsio     :: use mdsio fo Line 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 343  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,       & useRealFreshWaterFlux, useSRCGSolver,
385       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
386       & uniformLin_PhiSurf,       & uniformLin_PhiSurf,
387       & quasiHydrostatic, nonHydrostatic,       & quasiHydrostatic, nonHydrostatic, use3Dsolver,
388       & use3Dsolver, implicitIntGravWave, staggerTimeStep,       & implicitIntGravWave, staggerTimeStep, doResetHFactors,
389       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
390       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
391       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
392       & momDissip_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
393       & balanceEmPmR, balanceQnet, balancePrintMean,       & balanceEmPmR, balanceQnet, balancePrintMean,
394       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
395       & allowFreezing, useOldFreezing,       & allowFreezing, allowInteriorFreezing, useOldFreezing,
396       & periodicExternalForcing,       & periodicExternalForcing,
397       & globalFiles, useSingleCpuIO,       & globalFiles,
398       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
399       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
400       & writePickupAtEnd,       & writePickupAtEnd,
401       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
402       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast,
403       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & printDomain,
404       & useSRCGSolver       & inAdMode, inAdTrue, inAdFalse, inAdExact
405    
406        LOGICAL fluidIsAir        LOGICAL fluidIsAir
407        LOGICAL fluidIsWater        LOGICAL fluidIsWater
# Line 389  C                        & Last iteratio Line 418  C                        & Last iteratio
418        LOGICAL useNHMTerms        LOGICAL useNHMTerms
419        LOGICAL no_slip_sides        LOGICAL no_slip_sides
420        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
421          LOGICAL useFullLeith
422          LOGICAL useStrainTensionVisc
423          LOGICAL useAreaViscLength
424        LOGICAL momViscosity        LOGICAL momViscosity
425        LOGICAL momAdvection        LOGICAL momAdvection
426        LOGICAL momForcing        LOGICAL momForcing
# Line 406  C                        & Last iteratio Line 438  C                        & Last iteratio
438        LOGICAL checkIniTemp        LOGICAL checkIniTemp
439        LOGICAL checkIniSalt        LOGICAL checkIniSalt
440        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
441        LOGICAL useFullLeith        LOGICAL useSRCGSolver
       LOGICAL useStrainTensionVisc  
       LOGICAL useAreaViscLength  
442        LOGICAL rigidLid        LOGICAL rigidLid
443        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
444        LOGICAL exactConserv        LOGICAL exactConserv
# Line 419  C                        & Last iteratio Line 449  C                        & Last iteratio
449        LOGICAL use3Dsolver        LOGICAL use3Dsolver
450        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
451        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
452          LOGICAL doResetHFactors
453        LOGICAL momStepping        LOGICAL momStepping
454          LOGICAL calc_wVelocity
455        LOGICAL tempStepping        LOGICAL tempStepping
456        LOGICAL saltStepping        LOGICAL saltStepping
457        LOGICAL metricTerms        LOGICAL metricTerms
       LOGICAL useConstantF  
       LOGICAL useBetaPlaneF  
       LOGICAL useSphereF  
458        LOGICAL use3dCoriolis        LOGICAL use3dCoriolis
459        LOGICAL useCDscheme        LOGICAL useCDscheme
460        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
# Line 450  C                        & Last iteratio Line 479  C                        & Last iteratio
479        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
480        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
481        LOGICAL allowFreezing        LOGICAL allowFreezing
482          LOGICAL allowInteriorFreezing
483        LOGICAL useOldFreezing        LOGICAL useOldFreezing
484        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
485        LOGICAL globalFiles        LOGICAL globalFiles
       LOGICAL useSingleCpuIO  
486        LOGICAL pickupStrictlyMatch        LOGICAL pickupStrictlyMatch
487        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
488        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
# Line 462  C                        & Last iteratio Line 491  C                        & Last iteratio
491        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
492        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
493        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
494        LOGICAL debugMode        LOGICAL printDomain
495        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
       LOGICAL useSRCGSolver  
496    
497  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
498  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 490  C           defaults to 0.51 but can be Line 518  C           defaults to 0.51 but can be
518  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
519  C     delRc     :: Vertical grid spacing between cell centers (r unit).  C     delRc     :: Vertical grid spacing between cell centers (r unit).
520  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
521  C     delY        on input flags.  C     delY         on input flags. Note: moved to header file SET_GRID.h
522    C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
523    C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
524    C                :: parameter but it makes geographical references simple.)
525    C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
526    C                :: most face (Lat-Lon grid).
527  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
528  C     recip_gravity and its inverse  C     recip_gravity and its inverse
529  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 )
530  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
531  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density (Boussinesq)
532  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
533  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
534  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
# Line 503  C     rho1Ref   :: reference vertical pr Line 536  C     rho1Ref   :: reference vertical pr
536  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
537  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
538  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
539  C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:  C     dBdrRef   :: vertical gradient of reference buoyancy  [(m/s/r)^2]:
540  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
541  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
542  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
# Line 520  C     rUnit2mass :: units conversion fac Line 553  C     rUnit2mass :: units conversion fac
553  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].
554  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
555  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).  
556  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
557  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
558    C     radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
559  C     f0         :: Reference coriolis parameter ( 1/s )  C     f0         :: Reference coriolis parameter ( 1/s )
560  C                   ( Southern edge f for beta plane )  C                   ( Southern edge f for beta plane )
561  C     beta       :: df/dy ( s^-1.m^-1 )  C     beta       :: df/dy ( s^-1.m^-1 )
562    C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
563    C                   of rotation (reference value = 2.Omega.Cos(Phi))
564  C     omega      :: Angular velocity ( rad/s )  C     omega      :: Angular velocity ( rad/s )
565  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
566  C     viscArNr   :: vertical profile of Eddy viscosity coeff.  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
# Line 662  C     convertFW2Salt :: salinity, used t Line 693  C     convertFW2Salt :: salinity, used t
693  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
694  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
695  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
696    C     temp_addMass :: temperature of addMass array
697    C     salt_addMass :: salinity of addMass array
698  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
699  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
700  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
# Line 671  C     hMixSmooth  :: Smoothing parameter Line 704  C     hMixSmooth  :: Smoothing parameter
704  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
705  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
706  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
707    C     rSigmaBnd   :: vertical position (in r-unit) of r/sigma transition (Hybrid-Sigma)
708  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
709  C                           (default=2: full drag ; =1: gives half-slip BC)  C                           (default=2: full drag ; =1: gives half-slip BC)
710  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
# Line 686  C     thetaEuler    :: Euler angle, rota Line 720  C     thetaEuler    :: Euler angle, rota
720  C     psiEuler      :: Euler angle, rotation about new z-axis  C     psiEuler      :: Euler angle, rotation about new z-axis
721        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
722       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
723       & delR, delRc, delX, delY,       & delR, delRc, xgOrigin, ygOrigin,
724       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
725       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
726       & xgOrigin, ygOrigin, rSphere, recip_RSphere, f0, beta,       & rSphere, recip_rSphere, radius_fromHorizGrid,
727       & viscAh, viscAhW, viscAhMax,       & f0, beta, fPrime, omega, rotationPeriod,
728         & viscFacAdj, viscAh, viscAhW, viscAhMax,
729       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
730       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
731       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
# Line 708  C     psiEuler      :: Euler angle, rota Line 743  C     psiEuler      :: Euler angle, rota
743       & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,       & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
744       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
745       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
746       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhoNil, rhoConst, recip_rhoConst,
747       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
748       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
749       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
# Line 716  C     psiEuler      :: Euler angle, rota Line 751  C     psiEuler      :: Euler angle, rota
751       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
752       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
753       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
754       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq,
755       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
756       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
757       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
758       & hFacMinDr, hFacMinDp,       & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
759       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, Ro_SeaLevel,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth,
760         & Ro_SeaLevel, rSigmaBnd,
761       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
762       & smoothAbsFuncRange,       & smoothAbsFuncRange,
763       & tCylIn, tCylOut,       & tCylIn, tCylOut,
# Line 733  C     psiEuler      :: Euler angle, rota Line 769  C     psiEuler      :: Euler angle, rota
769        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
770        _RL delR(Nr)        _RL delR(Nr)
771        _RL delRc(Nr+1)        _RL delRc(Nr+1)
772        _RL delX(Nx)        _RL xgOrigin
773        _RL delY(Ny)        _RL ygOrigin
774        _RL deltaT        _RL deltaT
775        _RL deltaTClock        _RL deltaTClock
776        _RL deltaTmom        _RL deltaTmom
777        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
778        _RL deltaTfreesurf        _RL deltaTfreesurf
779        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
       _RL xgOrigin  
       _RL ygOrigin  
780        _RL rSphere        _RL rSphere
781        _RL recip_rSphere        _RL recip_rSphere
782          _RL radius_fromHorizGrid
783        _RL f0        _RL f0
784          _RL beta
785          _RL fPrime
786          _RL omega
787          _RL rotationPeriod
788        _RL freeSurfFac        _RL freeSurfFac
789        _RL implicSurfPress        _RL implicSurfPress
790        _RL implicDiv2Dflow        _RL implicDiv2Dflow
# Line 756  C     psiEuler      :: Euler angle, rota Line 795  C     psiEuler      :: Euler angle, rota
795        _RL hFacMinDr        _RL hFacMinDr
796        _RL hFacInf        _RL hFacInf
797        _RL hFacSup        _RL hFacSup
       _RL beta  
798        _RL viscArNr(Nr)        _RL viscArNr(Nr)
799          _RL viscFacAdj
800        _RL viscAh        _RL viscAh
801        _RL viscAhW        _RL viscAhW
802        _RL viscAhD        _RL viscAhD
# Line 797  C     psiEuler      :: Euler angle, rota Line 836  C     psiEuler      :: Euler angle, rota
836        _RL gravity        _RL gravity
837        _RL recip_gravity        _RL recip_gravity
838        _RL gBaro        _RL gBaro
839        _RL rhonil,        recip_rhonil        _RL rhoNil
840        _RL rhoConst,      recip_rhoConst        _RL rhoConst,      recip_rhoConst
841        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
842        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
# Line 829  C     psiEuler      :: Euler angle, rota Line 868  C     psiEuler      :: Euler angle, rota
868        _RL mtFacMom        _RL mtFacMom
869        _RL cosPower        _RL cosPower
870        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
       _RL rotationPeriod  
871        _RL tauThetaClimRelax        _RL tauThetaClimRelax
872        _RL tauSaltClimRelax        _RL tauSaltClimRelax
873        _RL latBandClimRelax        _RL latBandClimRelax
# Line 839  C     psiEuler      :: Euler angle, rota Line 876  C     psiEuler      :: Euler angle, rota
876        _RL convertFW2Salt        _RL convertFW2Salt
877        _RL temp_EvPrRn        _RL temp_EvPrRn
878        _RL salt_EvPrRn        _RL salt_EvPrRn
879          _RL temp_addMass
880          _RL salt_addMass
881        _RL ivdc_kappa        _RL ivdc_kappa
882        _RL hMixCriteria        _RL hMixCriteria
883        _RL dRhoSmall        _RL dRhoSmall
884        _RL hMixSmooth        _RL hMixSmooth
885        _RL Ro_SeaLevel        _RL Ro_SeaLevel
886          _RL rSigmaBnd
887        _RL sideDragFactor        _RL sideDragFactor
888        _RL bottomDragLinear        _RL bottomDragLinear
889        _RL bottomDragQuadratic        _RL bottomDragQuadratic
# Line 890  C Logical flags for selecting packages Line 930  C Logical flags for selecting packages
930        LOGICAL useKPP        LOGICAL useKPP
931        LOGICAL useGMRedi        LOGICAL useGMRedi
932        LOGICAL useDOWN_SLOPE        LOGICAL useDOWN_SLOPE
933          LOGICAL useBBL
934        LOGICAL useCAL        LOGICAL useCAL
935        LOGICAL useEXF        LOGICAL useEXF
936        LOGICAL useBulkForce        LOGICAL useBulkForce
# Line 908  C Logical flags for selecting packages Line 949  C Logical flags for selecting packages
949        LOGICAL useSEAICE        LOGICAL useSEAICE
950        LOGICAL useSALT_PLUME        LOGICAL useSALT_PLUME
951        LOGICAL useShelfIce        LOGICAL useShelfIce
952          LOGICAL useICEFRONT
953        LOGICAL useThSIce        LOGICAL useThSIce
954        LOGICAL useATM2d        LOGICAL useATM2d
955        LOGICAL useAIM        LOGICAL useAIM
# Line 924  C Logical flags for selecting packages Line 966  C Logical flags for selecting packages
966        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
967       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
968       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
969       &        useGMRedi, useDOWN_SLOPE,       &        useGMRedi, useBBL, useDOWN_SLOPE,
970       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
971       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,
972       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
973       &        useSEAICE, useSALT_PLUME, useShelfIce, useThSIce,       &        useSEAICE, useSALT_PLUME, useShelfIce,
974         &        useICEFRONT, useThSIce,
975       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
976       &        useDiagnostics, useREGRID, useLayers, useMNC,       &        useDiagnostics, useREGRID, useLayers, useMNC,
977       &        useRunClock, useEMBED_FILES,       &        useRunClock, useEMBED_FILES,
978       &        useMYPACKAGE       &        useMYPACKAGE
979    
980    C     Logical flags for turning off parts of the code in adjoint mode
981          LOGICAL useKPPinAdMode, useKPPinFwdMode
982          LOGICAL useGMrediInAdMode, useGMrediInFwdMode
983          LOGICAL useSEAICEinAdMode, useSEAICEinFwdMode
984          COMMON /PARM_PACKAGES_ADJ/
985         &       useKPPinAdMode, useKPPinFwdMode,
986         &       useGMrediInAdMode, useGMrediInFwdMode,
987         &       useSEAICEinAdMode, useSEAICEinFwdMode
988    
989  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
990  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
991  CEH3 ;;; End: ***  CEH3 ;;; End: ***
Legend:
Removed from v.1.234  
changed lines
  Added in v.1.257
  ViewVC Help
Powered by ViewVC 1.1.22