/[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.185 by heimbach, Wed Jun 7 01:55:12 2006 UTC revision 1.207 by dimitri, Sat Nov 24 15:44:52 2007 UTC
# Line 43  C     UNSET_xxx :: Used to indicate vari Line 43  C     UNSET_xxx :: Used to indicate vari
43        INTEGER UNSET_I        INTEGER UNSET_I
44        PARAMETER ( UNSET_I      = 123456789  )        PARAMETER ( UNSET_I      = 123456789  )
45    
 C     Checkpoint data  
       INTEGER maxNoChkptLev  
       PARAMETER ( maxNoChkptLev = 2 )  
   
46  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
47  C     checkPtSuff :: List of checkpoint file suffices  C     buoyancyRelation :: Flag used to indicate which relation to use to
48    C                         get buoyancy.
49    C     eosType         :: choose the equation of state:
50    C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
51    C     pickupSuff      :: force to start from pickup files (even if nIter0=0)
52    C                        and read pickup files with this suffix (max 10 Char.)
53    C     mdsioLocalDir   :: read-write tiled file from/to this directory name
54    C                        (+ 4 digits Processor-Rank) instead of current dir.
55    C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
56    C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
57    C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
58    C     delRFile      :: File containing vertical grid spacing delR  (1.D array)
59    C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)
60  C     delXFile      :: File containing X-spacing grid definition (1.D array)  C     delXFile      :: File containing X-spacing grid definition (1.D array)
61  C     delYFile      :: File containing Y-spacing grid definition (1.D array)  C     delYFile      :: File containing Y-spacing grid definition (1.D array)
62  C     horizGridFile :: File containing horizontal-grid definition  C     horizGridFile :: File containing horizontal-grid definition
63  C                        (only when using curvilinear_grid)  C                        (only when using curvilinear_grid)
64  C     bathyFile   :: File containing bathymetry. If not defined bathymetry  C     bathyFile       :: File containing bathymetry. If not defined bathymetry
65  C                   is taken from inline function.  C                        is taken from inline function.
66  C     topoFile    :: File containing the topography of the surface (unit=m)  C     topoFile        :: File containing the topography of the surface (unit=m)
67  C                   (mainly used for the atmosphere = ground height).  C                        (mainly used for the atmosphere = ground height).
68  C     shelfIceFile:: File containing the topography of the shelfice draught  C     shelfIceFile    :: File containing the topography of the shelfice draught
69  C                    (unit=m)  C                        (unit=m)
70  C     hydrogThetaFile :: File containing initial hydrographic data for potential  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
71  C                       temperature.  C                        for potential temperature.
72  C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
73    C                        for salinity.
74    C     diffKrFile      :: File containing 3D specification of vertical diffusivity
75  C     zonalWindFile   :: File containing zonal wind data  C     zonalWindFile   :: File containing zonal wind data
76  C     meridWindFile   :: File containing meridional wind data  C     meridWindFile   :: File containing meridional wind data
77  C     thetaClimFile   :: File containing theta climataology used  C     thetaClimFile   :: File containing surface theta climataology used
78  C                       in relaxation term -lambda(theta-theta*)  C                       in relaxation term -lambda(theta-theta*)
79  C     saltClimFile    :: File containing salt climataology used  C     saltClimFile    :: File containing surface salt climataology used
80  C                       in relaxation term -lambda(salt-salt*)  C                       in relaxation term -lambda(salt-salt*)
81  C     surfQfile       :: File containing surface heat flux, excluding SW  C     surfQfile       :: File containing surface heat flux, excluding SW
82  C                        (old version, kept for backward compatibility)  C                        (old version, kept for backward compatibility)
# Line 78  C     saltFluxFile    :: File containing Line 88  C     saltFluxFile    :: File containing
88  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
89  C     eddyTauxFile    :: File containing zonal Eddy stress data  C     eddyTauxFile    :: File containing zonal Eddy stress data
90  C     eddyTauyFile    :: File containing meridional Eddy stress data  C     eddyTauyFile    :: File containing meridional Eddy stress data
 C     buoyancyRelation :: Flag used to indicate which relation to use to  
 C                        get buoyancy.  
 C     eosType         :: choose the equation of state:  
 C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS  
91  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
92        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/
93         &                buoyancyRelation, eosType,
94         &                pickupSuff, mdsioLocalDir,
95         &                tRefFile, sRefFile, rhoRefFile,
96         &                delRFile, delRcFile,
97       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
98       &                bathyFile, topoFile, shelfIceFile,       &                bathyFile, topoFile, shelfIceFile,
99       &                hydrogThetaFile, hydrogSaltFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
100       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
101       &                saltClimFile, buoyancyRelation,       &                saltClimFile,
102       &                EmPmRfile, saltFluxFile,       &                EmPmRfile, saltFluxFile,
103       &                surfQfile, surfQnetFile, surfQswFile,       &                surfQfile, surfQnetFile, surfQswFile,
104       &                lambdaThetaFile, lambdaSaltFile,       &                lambdaThetaFile, lambdaSaltFile,
105       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
106       &                dQdTfile, ploadFile,       &                dQdTfile, ploadFile,
107       &                eddyTauxFile, eddyTauyFile,       &                eddyTauxFile, eddyTauyFile,
      &                eosType, pickupSuff,  
      &                mdsioLocalDir,  
108       &                the_run_name       &                the_run_name
109        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
110          CHARACTER*(6)  eosType
111          CHARACTER*(10) pickupSuff
112          CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
113          CHARACTER*(MAX_LEN_FNAM) tRefFile
114          CHARACTER*(MAX_LEN_FNAM) sRefFile
115          CHARACTER*(MAX_LEN_FNAM) rhoRefFile
116          CHARACTER*(MAX_LEN_FNAM) delRFile
117          CHARACTER*(MAX_LEN_FNAM) delRcFile
118        CHARACTER*(MAX_LEN_FNAM) delXFile        CHARACTER*(MAX_LEN_FNAM) delXFile
119        CHARACTER*(MAX_LEN_FNAM) delYFile        CHARACTER*(MAX_LEN_FNAM) delYFile
120        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
121        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile
122        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
123        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) diffKrFile
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 114  C     the_run_name    :: string identify Line 130  C     the_run_name    :: string identify
130        CHARACTER*(MAX_LEN_FNAM) surfQswFile        CHARACTER*(MAX_LEN_FNAM) surfQswFile
131        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
132        CHARACTER*(MAX_LEN_FNAM) saltFluxFile        CHARACTER*(MAX_LEN_FNAM) saltFluxFile
       CHARACTER*(MAX_LEN_FNAM) buoyancyRelation  
133        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
134        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
135        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
# Line 124  C     the_run_name    :: string identify Line 139  C     the_run_name    :: string identify
139        CHARACTER*(MAX_LEN_FNAM) eddyTauyFile        CHARACTER*(MAX_LEN_FNAM) eddyTauyFile
140        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
141        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
142        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_PREC/2) the_run_name
       CHARACTER*(MAX_LEN_FNAM) the_run_name  
       CHARACTER*(6) eosType  
       CHARACTER*(10) pickupSuff  
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
# Line 142  C     cg3dChkResFreq      :: Frequency w Line 154  C     cg3dChkResFreq      :: Frequency w
154  C                           in con. grad solver.  C                           in con. grad solver.
155  C     nIter0              :: Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
156  C     nTimeSteps          :: Number of timesteps to execute  C     nTimeSteps          :: Number of timesteps to execute
 C     numStepsPerPickup   :: For offline setup. Frequency of pickup  
 C                           of flow fields.  
157  C     writeStatePrec      :: Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
158  C     writeBinaryPrec     :: Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
159  C     readBinaryPrec      :: Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
 C     nCheckLev           :: Holds current checkpoint level  
160  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
161  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
162  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
# Line 169  C     debugLevel          :: debug level Line 178  C     debugLevel          :: debug level
178       &        cg3dMaxIters,       &        cg3dMaxIters,
179       &        cg3dChkResFreq,       &        cg3dChkResFreq,
180       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
181       &        numStepsPerPickup,       &        writeStatePrec,
      &        writeStatePrec, nCheckLev,  
182       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
183       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
184       &        momForcingOutAB, tracForcingOutAB,       &        momForcingOutAB, tracForcingOutAB,
# Line 186  C     debugLevel          :: debug level Line 194  C     debugLevel          :: debug level
194        INTEGER nIter0        INTEGER nIter0
195        INTEGER nTimeSteps        INTEGER nTimeSteps
196        INTEGER nEndIter        INTEGER nEndIter
       INTEGER numStepsPerPickup  
197        INTEGER writeStatePrec        INTEGER writeStatePrec
198        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
199        INTEGER readBinaryPrec        INTEGER readBinaryPrec
       INTEGER nCheckLev  
200        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
201        INTEGER select_rStar        INTEGER select_rStar
202        INTEGER momForcingOutAB, tracForcingOutAB        INTEGER momForcingOutAB, tracForcingOutAB
# Line 210  C Line 216  C
216  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
217  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
218  C                          coordinate frame.  C                          coordinate frame.
219  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
220  C                               spherical polar frame.  C                               spherical polar frame.
221  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
222    C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
223    C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
224  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
225  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
226  C     momViscosity  :: Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
# Line 228  C     tempAdvection :: Flag which turns Line 236  C     tempAdvection :: Flag which turns
236  C                     and off.  C                     and off.
237  C     tempForcing   :: Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
238  C                     and off.  C                     and off.
239  C     saltAdvection :: Flag which turns advection of salinity on  C     saltAdvection :: Flag which turns advection of salinity on
240  C                     and off.  C                     and off.
241  C     saltForcing   :: Flag which turns external forcing of salinity on  C     saltForcing   :: Flag which turns external forcing of salinity on
242  C                     and off.  C                     and off.
243  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
244  C                         as a real Fresh Water (=> changes the Sea Level)  C                         as a real Fresh Water (=> changes the Sea Level)
245  C                         if F, converts P+R-E to salt flux (no SL effect)  C                         if F, converts P+R-E to salt flux (no SL effect)
246  C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable  C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
# Line 243  C     useStrainTensionVisc:: Set to true Line 251  C     useStrainTensionVisc:: Set to true
251  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
252  C     implicitFreeSurface :: Set to true to use implicit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
253  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
254    C     linFSConserveTr     :: Set to true to correct source/sink of tracer
255    C                            at the surface due to Linear Free Surface
256  C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the  C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
257  C                           linear relation Phi_surf = Bo_surf*eta  C                           linear relation Phi_surf = Bo_surf*eta
258  C     use3Dsolver   :: set to true to use 3-D pressure solver  C     use3Dsolver   :: set to true to use 3-D pressure solver
# Line 254  C     saltStepping  :: Turns salinity eq Line 264  C     saltStepping  :: Turns salinity eq
264  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
265  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
266  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
267    C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
268  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
269  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
270  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
# Line 272  C     useMultiDimAdvec  :: True if multi Line 283  C     useMultiDimAdvec  :: True if multi
283  C     momDissip_In_AB   :: if False, put Dissipation tendency contribution  C     momDissip_In_AB   :: if False, put Dissipation tendency contribution
284  C                          out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
285  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
286  C                          apply AB on tracer tendencies (rather than on Tracer)  C                          apply AB on tracer tendencies (rather than on Tracer)
287  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
288    C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
289    C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
290    C                           before checkpoint-54a, Jul 06, 2004.
291  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
292  C                        climatology is required.  C                        climatology is required.
293  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
# Line 289  C     fluidIsWater     :: Set to indicat Line 303  C     fluidIsWater     :: Set to indicat
303  C                        is water  C                        is water
304  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.)
305  C                         this requires specific code for restart & exchange  C                         this requires specific code for restart & exchange
306  C     setCenterDr    :: set cell Center depth and put Interface at the middle  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
307    C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
308  C     nonHydrostatic :: Using non-hydrostatic terms  C     nonHydrostatic :: Using non-hydrostatic terms
309  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
310  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
# Line 305  C     pickup_write_immed :: echo the pic Line 320  C     pickup_write_immed :: echo the pic
320  C     timeave_mdsio      :: use mdsio for timeave output  C     timeave_mdsio      :: use mdsio for timeave output
321  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
322  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
323  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
324  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
325  C     balanceEmPmR    :: substract global mean of EmPmR at every time step  C     balanceEmPmR    :: substract global mean of EmPmR at every time step
326  C     balanceQnet     :: substract global mean of Qnet at every time step  C     balanceQnet     :: substract global mean of Qnet at every time step
# Line 313  C     balancePrintMean:: print substract Line 328  C     balancePrintMean:: print substract
328    
329        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
330       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
331         & deepAtmosphere, setInterFDr, setCenterDr,
332       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
333       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
334       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
# Line 321  C     balancePrintMean:: print substract Line 337  C     balancePrintMean:: print substract
337       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
338       & useFullLeith, useStrainTensionVisc,       & useFullLeith, useStrainTensionVisc,
339       & useAreaViscLength,       & useAreaViscLength,
340       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
341         & uniformLin_PhiSurf,
342       & use3Dsolver, implicitIntGravWave, staggerTimeStep,       & use3Dsolver, implicitIntGravWave, staggerTimeStep,
343       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
344       & metricTerms, useNHMTerms,       & metricTerms, useNHMTerms,
345       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF, use3dCoriolis,
346       & useCDscheme,       & useCDscheme,
347       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
348       & SadournyCoriolis, upwindVorticity, highOrderVorticity,       & SadournyCoriolis, upwindVorticity, highOrderVorticity,
# Line 337  C     balancePrintMean:: print substract Line 354  C     balancePrintMean:: print substract
354       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
355       & periodicExternalForcing,       & periodicExternalForcing,
356       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
357       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc,
358       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
359       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
360       & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
361       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
362       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
363       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast, debugMode,
# Line 351  C     balancePrintMean:: print substract Line 368  C     balancePrintMean:: print substract
368        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
369        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
370        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
371          LOGICAL deepAtmosphere
372          LOGICAL setInterFDr
373          LOGICAL setCenterDr
374        LOGICAL useNHMTerms        LOGICAL useNHMTerms
375        LOGICAL no_slip_sides        LOGICAL no_slip_sides
376        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
# Line 371  C     balancePrintMean:: print substract Line 391  C     balancePrintMean:: print substract
391        LOGICAL rigidLid        LOGICAL rigidLid
392        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
393        LOGICAL exactConserv        LOGICAL exactConserv
394          LOGICAL linFSConserveTr
395        LOGICAL uniformLin_PhiSurf        LOGICAL uniformLin_PhiSurf
396        LOGICAL use3Dsolver        LOGICAL use3Dsolver
397        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
# Line 382  C     balancePrintMean:: print substract Line 403  C     balancePrintMean:: print substract
403        LOGICAL useConstantF        LOGICAL useConstantF
404        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
405        LOGICAL useSphereF        LOGICAL useSphereF
406          LOGICAL use3dCoriolis
407        LOGICAL useCDscheme        LOGICAL useCDscheme
408        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
409        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
# Line 409  C     balancePrintMean:: print substract Line 431  C     balancePrintMean:: print substract
431        LOGICAL usingPCoords        LOGICAL usingPCoords
432        LOGICAL usingZCoords        LOGICAL usingZCoords
433        LOGICAL useDynP_inEos_Zc        LOGICAL useDynP_inEos_Zc
       LOGICAL setCenterDr  
434        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
435        LOGICAL quasiHydrostatic        LOGICAL quasiHydrostatic
436        LOGICAL globalFiles        LOGICAL globalFiles
437        LOGICAL useSingleCpuIO        LOGICAL useSingleCpuIO
438        LOGICAL allowFreezing        LOGICAL allowFreezing
439        LOGICAL useOldFreezing        LOGICAL useOldFreezing
440        LOGICAL usePickupBeforeC35        LOGICAL pickupStrictlyMatch
441        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
442        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
443        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
# Line 460  C     gravity   :: Accel. due to gravity Line 481  C     gravity   :: Accel. due to gravity
481  C     recip_gravity and its inverse  C     recip_gravity and its inverse
482  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 )
483  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
484  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
485    C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
486    C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
487  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
488  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
489  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
490  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
491  C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:  C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:
492  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
493  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
494    C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
495    C                :: from r-coordinate vertical velocity to vertical velocity [m/s].
496    C                :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit
497    C     wUnit2rVel :: units conversion factor (Non-Hydrostatic code),
498    C                :: from vertical velocity [m/s] to r-coordinate vertical velocity.
499    C                :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel
500    C     mass2rUnit :: units conversion factor (surface forcing),
501    C                :: from mass per unit area [kg/m2] to vertical r-coordinate unit.
502    C                :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ;
503    C                :: p-coord: = gravity    ( [kg/m2] *  g = [Pa] ) ;
504    C     rUnit2mass :: units conversion factor (surface forcing),
505    C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
506    C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
507    C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
508  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
509  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
510  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
511  C                 to make geographical references simple.)  C                 to make geographical references simple.)
512  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).
513  C     recip_RSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
514  C     f0        :: Reference coriolis parameter ( 1/s )  C     f0        :: Reference coriolis parameter ( 1/s )
515  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
516  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
# Line 484  C                 momentum laterally ( m Line 521  C                 momentum laterally ( m
521  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
522  C                 momentum laterally, no effect for hydrostatic  C                 momentum laterally, no effect for hydrostatic
523  C                 model, defaults to viscAh if unset ( m^2/s )  C                 model, defaults to viscAh if unset ( m^2/s )
524    C                 Not used if variable horiz. viscosity is used.
525  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
526  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
527  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
# Line 491  C                 momentum laterally ( m Line 529  C                 momentum laterally ( m
529  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical
530  C                 momentum laterally, no effect for hydrostatic  C                 momentum laterally, no effect for hydrostatic
531  C                 model, defaults to viscA4 if unset ( m^2/s )  C                 model, defaults to viscA4 if unset ( m^2/s )
532    C                 Not used if variable horiz. viscosity is used.
533  C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally
534  C                  (act on Divergence part) ( m^2/s )  C                  (act on Divergence part) ( m^2/s )
535  C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally
# Line 535  C     diffKrBL79surf :: T/S surface diff Line 574  C     diffKrBL79surf :: T/S surface diff
574  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
575  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
576  C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979  C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
577    C     BL79LatVary    :: polarwise of this latitude diffKrBL79 is applied with
578    C                       gradual transition to diffKrBLEQ towards Equator
579    C     diffKrBLEQsurf :: same as diffKrBL79surf but at Equator
580    C     diffKrBLEQdeep :: same as diffKrBL79deep but at Equator
581    C     diffKrBLEQscl  :: same as diffKrBL79scl but at Equator
582    C     diffKrBLEQHo   :: same as diffKrBL79Ho but at Equator
583  C     deltaT    :: Default timestep ( s )  C     deltaT    :: Default timestep ( s )
584  C     deltaTClock  :: Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
585  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
# Line 601  C     salt_EvPrRn :: salinity of Rain & Line 646  C     salt_EvPrRn :: salinity of Rain &
646  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
647  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
648  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
649  C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.  C     hMixCrit    :: criteria for mixed-layer diagnostic
650  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
651  C                          ( g*rho if horiz in m and vertical in Pa ).  C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
652  C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
 C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  
653  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
654  C                           (default=2: full drag ; =1: gives half-slip BC)  C                           (default=2: full drag ; =1: gives half-slip BC)
655  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
# Line 634  C                      (i.e. allows conv Line 678  C                      (i.e. allows conv
678       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
679       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
680       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
681         & BL79LatVary,
682         & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
683       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
684       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
685       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_gravity, gBaro,
686       & recip_rhoConst, rhoConst,       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
687       & rhoConstFresh, convertEmP2rUnit, tRef, sRef, phiRef, dBdrRef,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
688         & rhoConstFresh, tRef, sRef, phiRef, dBdrRef,
689         & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
690       & baseTime, startTime, endTime,       & baseTime, startTime, endTime,
691       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
692       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
# Line 649  C                      (i.e. allows conv Line 697  C                      (i.e. allows conv
697       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
698       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
699       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
700       & horiVertRatio, recip_horiVertRatio,       & ivdc_kappa, hMixCriteria, Ro_SeaLevel,
      & ivdc_kappa, Ro_SeaLevel,  
701       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
702       & smoothAbsFuncRange,       & smoothAbsFuncRange,
703       & tCylIn, tCylOut       & tCylIn, tCylOut
704    
705        _RL cg2dTargetResidual        _RL cg2dTargetResidual
# Line 672  C                      (i.e. allows conv Line 719  C                      (i.e. allows conv
719        _RL phiMin        _RL phiMin
720        _RL thetaMin        _RL thetaMin
721        _RL rSphere        _RL rSphere
722        _RL recip_RSphere        _RL recip_rSphere
723        _RL f0        _RL f0
724        _RL freeSurfFac        _RL freeSurfFac
725        _RL implicSurfPress        _RL implicSurfPress
# Line 717  C                      (i.e. allows conv Line 764  C                      (i.e. allows conv
764        _RL diffKrBL79deep        _RL diffKrBL79deep
765        _RL diffKrBL79scl        _RL diffKrBL79scl
766        _RL diffKrBL79Ho        _RL diffKrBL79Ho
767          _RL BL79LatVary
768          _RL diffKrBLEQsurf
769          _RL diffKrBLEQdeep
770          _RL diffKrBLEQscl
771          _RL diffKrBLEQHo
772        _RL delt        _RL delt
773        _RL tauCD        _RL tauCD
774        _RL rCD        _RL rCD
775        _RL gravity        _RL gravity
776        _RL recip_gravity        _RL recip_gravity
777        _RL gBaro        _RL gBaro
778        _RL rhonil        _RL rhonil,        recip_rhonil
779        _RL recip_rhonil        _RL rhoConst,      recip_rhoConst
780        _RL rhoConst        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
781        _RL recip_rhoConst        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
782        _RL rhoConstFresh        _RL rhoConstFresh
       _RL convertEmP2rUnit  
783        _RL tRef(Nr)        _RL tRef(Nr)
784        _RL sRef(Nr)        _RL sRef(Nr)
785        _RL phiRef(2*Nr+1)        _RL phiRef(2*Nr+1)
786        _RL dBdrRef(Nr)        _RL dBdrRef(Nr)
787          _RL rVel2wUnit(Nr+1), wUnit2rVel(Nr+1)
788          _RL mass2rUnit, rUnit2mass
789        _RL baseTime        _RL baseTime
790        _RL startTime        _RL startTime
791        _RL endTime        _RL endTime
# Line 765  C                      (i.e. allows conv Line 818  C                      (i.e. allows conv
818        _RL convertFW2Salt        _RL convertFW2Salt
819        _RL temp_EvPrRn        _RL temp_EvPrRn
820        _RL salt_EvPrRn        _RL salt_EvPrRn
       _RL horiVertRatio  
       _RL recip_horiVertRatio  
821        _RL ivdc_kappa        _RL ivdc_kappa
822          _RL hMixCriteria
823        _RL Ro_SeaLevel        _RL Ro_SeaLevel
824        _RL sideDragFactor        _RL sideDragFactor
825        _RL bottomDragLinear        _RL bottomDragLinear
# Line 808  C Logical flags for selecting packages Line 860  C Logical flags for selecting packages
860        LOGICAL useMY82        LOGICAL useMY82
861        LOGICAL useGGL90        LOGICAL useGGL90
862        LOGICAL useKPP        LOGICAL useKPP
863          LOGICAL useGAD
864        LOGICAL useGMRedi        LOGICAL useGMRedi
865        LOGICAL useOBCS        LOGICAL useOBCS
866        LOGICAL useAIM        LOGICAL useAIM
# Line 829  C Logical flags for selecting packages Line 882  C Logical flags for selecting packages
882        LOGICAL useSEAICE        LOGICAL useSEAICE
883        LOGICAL useShelfIce        LOGICAL useShelfIce
884        LOGICAL useThSIce        LOGICAL useThSIce
885          LOGICAL useATM2d
886        LOGICAL useBulkForce        LOGICAL useBulkForce
887        LOGICAL usefizhi        LOGICAL usefizhi
888        LOGICAL usegridalt        LOGICAL usegridalt
889        LOGICAL useDiagnostics        LOGICAL useDiagnostics
890        LOGICAL useMNC        LOGICAL useMNC
891          LOGICAL useREGRID
892        LOGICAL useRunClock        LOGICAL useRunClock
893        LOGICAL useEMBED_FILES        LOGICAL useEMBED_FILES
894          LOGICAL useMYPACKAGE
895          LOGICAL usePLUME
896        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
897       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
898       &        useGMRedi, useOBCS, useAIM, useLand,       &        useGAD, useGMRedi, useOBCS, useAIM, useLand,
899       &        useCAL, useEXF, useEBM, useGrdchk, useECCO,       &        useCAL, useEXF, useEBM, useGrdchk, useECCO,
900       &        useSHAP_FILT, useZONAL_FILT, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useFLT,
901       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
902       &        useSBO, useSEAICE, useShelfIce, useThSIce, useBulkForce,       &        useSBO, useSEAICE, useShelfIce,
903       &        usefizhi, usegridalt, useDiagnostics, useMNC,       &        useThSIce, useATM2D, useBulkForce,
904       &        useRunClock, useEMBED_FILES       &        usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID,
905         &        useRunClock, useEMBED_FILES, useMYPACKAGE, usePLUME
906    
907  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
908  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***

Legend:
Removed from v.1.185  
changed lines
  Added in v.1.207

  ViewVC Help
Powered by ViewVC 1.1.22