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

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

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

revision 1.223 by jmc, Fri Sep 5 19:55:56 2008 UTC revision 1.246 by jmc, Fri Dec 24 21:48:39 2010 UTC
# Line 33  C     pickupSuff      :: force to start Line 33  C     pickupSuff      :: force to start
33  C                        and read pickup files with this suffix (max 10 Char.)  C                        and read pickup files with this suffix (max 10 Char.)
34  C     mdsioLocalDir   :: read-write tiled file from/to this directory name  C     mdsioLocalDir   :: read-write tiled file from/to this directory name
35  C                        (+ 4 digits Processor-Rank) instead of current dir.  C                        (+ 4 digits Processor-Rank) instead of current dir.
36    C     adTapeDir       :: read-write checkpointing tape files from/to this
37    C                        directory name instead of current dir. Conflicts
38    C                        mdsioLocalDir, so only one of the two can be set.
39    C                        In contrast to mdsioLocalDir, if specified adTapeDir
40    C                        must exist before the model starts.
41  C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)  C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
42  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
43  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
44  C     delRFile      :: File containing vertical grid spacing delR  (1.D array)  C     delRFile      :: File containing vertical grid spacing delR  (1.D array)
45  C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)  C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)
46    C     hybSigmFile   :: File containing hybrid-sigma vertical coord. coeff. (2x 1.D)
47  C     delXFile      :: File containing X-spacing grid definition (1.D array)  C     delXFile      :: File containing X-spacing grid definition (1.D array)
48  C     delYFile      :: File containing Y-spacing grid definition (1.D array)  C     delYFile      :: File containing Y-spacing grid definition (1.D array)
49  C     horizGridFile :: File containing horizontal-grid definition  C     horizGridFile :: File containing horizontal-grid definition
# Line 46  C     bathyFile       :: File containing Line 52  C     bathyFile       :: File containing
52  C                        is taken from inline function.  C                        is taken from inline function.
53  C     topoFile        :: File containing the topography of the surface (unit=m)  C     topoFile        :: File containing the topography of the surface (unit=m)
54  C                        (mainly used for the atmosphere = ground height).  C                        (mainly used for the atmosphere = ground height).
 C     shelfIceFile    :: File containing the topography of the shelfice draught  
 C                        (unit=m)  
55  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
56  C                        for potential temperature.  C                        for potential temperature.
57  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
58  C                        for salinity.  C                        for salinity.
59  C     diffKrFile      :: File containing 3D specification of vertical diffusivity  C     diffKrFile      :: File containing 3D specification of vertical diffusivity
60    C     viscAhDfile     :: File containing 3D specification of horizontal viscosity
61    C     viscAhZfile     :: File containing 3D specification of horizontal viscosity
62    C     viscA4Dfile     :: File containing 3D specification of horizontal viscosity
63    C     viscA4Zfile     :: File containing 3D specification of horizontal viscosity
64  C     zonalWindFile   :: File containing zonal wind data  C     zonalWindFile   :: File containing zonal wind data
65  C     meridWindFile   :: File containing meridional wind data  C     meridWindFile   :: File containing meridional wind data
66  C     thetaClimFile   :: File containing surface theta climataology used  C     thetaClimFile   :: File containing surface theta climataology used
# Line 75  C     eddyPsiYFile    :: File containing Line 83  C     eddyPsiYFile    :: File containing
83  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
84        COMMON /PARM_C/        COMMON /PARM_C/
85       &                buoyancyRelation, eosType,       &                buoyancyRelation, eosType,
86       &                pickupSuff, mdsioLocalDir,       &                pickupSuff, mdsioLocalDir, adTapeDir,
87       &                tRefFile, sRefFile, rhoRefFile,       &                tRefFile, sRefFile, rhoRefFile,
88       &                delRFile, delRcFile,       &                delRFile, delRcFile, hybSigmFile,
89       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
90       &                bathyFile, topoFile, shelfIceFile,       &                bathyFile, topoFile,
91         &                viscAhDfile, viscAhZfile,
92         &                viscA4Dfile, viscA4Zfile,
93       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
94       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
95       &                saltClimFile,       &                saltClimFile,
# Line 94  C     the_run_name    :: string identify Line 104  C     the_run_name    :: string identify
104        CHARACTER*(6)  eosType        CHARACTER*(6)  eosType
105        CHARACTER*(10) pickupSuff        CHARACTER*(10) pickupSuff
106        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
107          CHARACTER*(MAX_LEN_FNAM) adTapeDir
108        CHARACTER*(MAX_LEN_FNAM) tRefFile        CHARACTER*(MAX_LEN_FNAM) tRefFile
109        CHARACTER*(MAX_LEN_FNAM) sRefFile        CHARACTER*(MAX_LEN_FNAM) sRefFile
110        CHARACTER*(MAX_LEN_FNAM) rhoRefFile        CHARACTER*(MAX_LEN_FNAM) rhoRefFile
111        CHARACTER*(MAX_LEN_FNAM) delRFile        CHARACTER*(MAX_LEN_FNAM) delRFile
112        CHARACTER*(MAX_LEN_FNAM) delRcFile        CHARACTER*(MAX_LEN_FNAM) delRcFile
113          CHARACTER*(MAX_LEN_FNAM) hybSigmFile
114        CHARACTER*(MAX_LEN_FNAM) delXFile        CHARACTER*(MAX_LEN_FNAM) delXFile
115        CHARACTER*(MAX_LEN_FNAM) delYFile        CHARACTER*(MAX_LEN_FNAM) delYFile
116        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
117        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
118        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
119        CHARACTER*(MAX_LEN_FNAM) diffKrFile        CHARACTER*(MAX_LEN_FNAM) diffKrFile
120          CHARACTER*(MAX_LEN_FNAM) viscAhDfile
121          CHARACTER*(MAX_LEN_FNAM) viscAhZfile
122          CHARACTER*(MAX_LEN_FNAM) viscA4Dfile
123          CHARACTER*(MAX_LEN_FNAM) viscA4Zfile
124        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
125        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
126        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
# Line 141  C     nTimeSteps          :: Number of t Line 157  C     nTimeSteps          :: Number of t
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
160    C     selectCoriMap       :: select setting of Coriolis parameter map:
161    C                           =0 f-Plane (Constant Coriolis, = f0)
162    C                           =1 Beta-Plane Coriolis (= f0 + beta.y)
163    C                           =2 Spherical Coriolis (= 2.omega.sin(phi))
164    C                           =3 Read Coriolis 2-d fields from files.
165    C     selectSigmaCoord    :: option related to sigma vertical coordinate
166  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
167  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
168  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
169  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
170    C     selectNHfreeSurf    :: option for Non-Hydrostatic (free-)Surface formulation:
171    C                           =0 (default) hydrostatic surf. ; > 0 add NH effects.
172  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
173  C                            (3-D generalisation of oceanic real-fresh water flux)  C                            (3-D generalisation of oceanic real-fresh water flux)
174  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
# Line 160  C     selectKEscheme      :: Kinetic Ene Line 184  C     selectKEscheme      :: Kinetic Ene
184  C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)  C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)
185  C     monitorSelect       :: select group of variables to monitor  C     monitorSelect       :: select group of variables to monitor
186  C                            =1 : dynvars ; =2 : + vort ; =3 : + surface  C                            =1 : dynvars ; =2 : + vort ; =3 : + surface
187  C     debugLevel          :: debug level selector: higher -> more writing  C-    debugLevel          :: controls printing of algorithm intermediate results
188    C                            and statistics ; higher -> more writing
189    
190        COMMON /PARM_I/        COMMON /PARM_I/
191       &        cg2dMaxIters,       &        cg2dMaxIters,
# Line 170  C     debugLevel          :: debug level Line 195  C     debugLevel          :: debug level
195       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
196       &        writeStatePrec,       &        writeStatePrec,
197       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
198         &        selectCoriMap,
199         &        selectSigmaCoord,
200       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
201         &        selectNHfreeSurf,
202       &        selectAddFluid,       &        selectAddFluid,
203       &        momForcingOutAB, tracForcingOutAB,       &        momForcingOutAB, tracForcingOutAB,
204       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
# Line 188  C     debugLevel          :: debug level Line 216  C     debugLevel          :: debug level
216        INTEGER writeStatePrec        INTEGER writeStatePrec
217        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
218        INTEGER readBinaryPrec        INTEGER readBinaryPrec
219          INTEGER selectCoriMap
220          INTEGER selectSigmaCoord
221        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
222        INTEGER select_rStar        INTEGER select_rStar
223          INTEGER selectNHfreeSurf
224        INTEGER selectAddFluid        INTEGER selectAddFluid
225        INTEGER momForcingOutAB, tracForcingOutAB        INTEGER momForcingOutAB, tracForcingOutAB
226        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
# Line 240  C     metricTerms   :: Flag which turns Line 271  C     metricTerms   :: Flag which turns
271  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
272  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
273  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)  
274  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
275  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
276  C                                (default = F = use mom_fluxform package)  C                                (default = F = use mom_fluxform package)
# Line 264  C     saltAdvection  :: Flag which turns Line 292  C     saltAdvection  :: Flag which turns
292  C     saltIsActiveTr :: Salinity  is a dynamically active tracer  C     saltIsActiveTr :: Salinity  is a dynamically active tracer
293  C     saltForcing    :: Flag which turns external forcing of salinity on  C     saltForcing    :: Flag which turns external forcing of salinity on
294  C                       and off.  C                       and off.
295    C     maskIniTemp    :: apply mask to initial Pot.Temp.
296    C     maskIniSalt    :: apply mask to initial salinity
297    C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
298    C     checkIniSalt   :: check for points with identically zero initial salinity
299  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
300  C                         as a real Fresh Water (=> changes the Sea Level)  C                         as a real Fresh Water (=> changes the Sea Level)
301  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)
302    C- Pressure solver related parameters (PARM02)
303    C     useSRCGSolver  :: Set to true to use conjugate gradient
304    C                       solver with single reduction (only one call of
305    C                       s/r mpi_allreduce), default is false
306  C- Time-stepping params:  C- Time-stepping params:
307  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
308  C     implicitFreeSurface :: Set to true to use implicit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
# Line 303  C     allowFreezing  :: Allows surface w Line 339  C     allowFreezing  :: Allows surface w
339  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
340  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
341  C- I/O parameters -  C- I/O parameters -
342  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files.
343  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  C                       On some platforms with MPI, option globalFiles is either
344  C                       slow (f77) or does not work (f90).  When  C                       slow or does not work. Use useSingleCpuIO instead.
345  C                       useSingleCpuIO is set, mdsio_writefield.F  C     useSingleCpuIO :: moved to EEPARAMS.h
 C                       outputs from master mpi process only.  
346  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
347  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
348  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
# Line 321  C     snapshot_mdsio     :: use mdsio fo Line 356  C     snapshot_mdsio     :: use mdsio fo
356  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
357  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
358  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
359    C     debugMode       :: controls printing of debug msg (sequence of S/R calls).
360    C     printDomain     :: controls printing of domain fields (bathy, hFac ...).
361    
362        COMMON /PARM_L/        COMMON /PARM_L/
363       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
# Line 333  C                        & Last iteratio Line 370  C                        & Last iteratio
370       & momViscosity, momAdvection, momForcing,       & momViscosity, momAdvection, momForcing,
371       & momPressureForcing, metricTerms, useNHMTerms,       & momPressureForcing, metricTerms, useNHMTerms,
372       & useCoriolis, use3dCoriolis,       & useCoriolis, use3dCoriolis,
      & useConstantF, useBetaPlaneF, useSphereF,  
373       & useCDscheme, vectorInvariantMomentum,       & useCDscheme, vectorInvariantMomentum,
374       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
375       & upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
# Line 341  C                        & Last iteratio Line 377  C                        & Last iteratio
377       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
378       & tempAdvection, tempIsActiveTr, tempForcing,       & tempAdvection, tempIsActiveTr, tempForcing,
379       & saltAdvection, saltIsActiveTr, saltForcing,       & saltAdvection, saltIsActiveTr, saltForcing,
380       & useRealFreshWaterFlux,       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
381         & useRealFreshWaterFlux, useSRCGSolver,
382       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
383       & uniformLin_PhiSurf,       & uniformLin_PhiSurf,
384       & quasiHydrostatic, nonHydrostatic,       & quasiHydrostatic, nonHydrostatic,
# Line 354  C                        & Last iteratio Line 391  C                        & Last iteratio
391       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
392       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
393       & periodicExternalForcing,       & periodicExternalForcing,
394       & globalFiles, useSingleCpuIO,       & globalFiles,
395       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
396       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
397       & writePickupAtEnd,       & writePickupAtEnd,
398       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
399       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast,
400         & debugMode, printDomain,
401       & inAdMode, inAdTrue, inAdFalse, inAdExact       & inAdMode, inAdTrue, inAdFalse, inAdExact
402    
403        LOGICAL fluidIsAir        LOGICAL fluidIsAir
# Line 377  C                        & Last iteratio Line 415  C                        & Last iteratio
415        LOGICAL useNHMTerms        LOGICAL useNHMTerms
416        LOGICAL no_slip_sides        LOGICAL no_slip_sides
417        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
418          LOGICAL useFullLeith
419          LOGICAL useStrainTensionVisc
420          LOGICAL useAreaViscLength
421        LOGICAL momViscosity        LOGICAL momViscosity
422        LOGICAL momAdvection        LOGICAL momAdvection
423        LOGICAL momForcing        LOGICAL momForcing
# Line 389  C                        & Last iteratio Line 430  C                        & Last iteratio
430        LOGICAL saltAdvection        LOGICAL saltAdvection
431        LOGICAL saltIsActiveTr        LOGICAL saltIsActiveTr
432        LOGICAL saltForcing        LOGICAL saltForcing
433          LOGICAL maskIniTemp
434          LOGICAL maskIniSalt
435          LOGICAL checkIniTemp
436          LOGICAL checkIniSalt
437        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
438        LOGICAL useFullLeith        LOGICAL useSRCGSolver
       LOGICAL useStrainTensionVisc  
       LOGICAL useAreaViscLength  
439        LOGICAL rigidLid        LOGICAL rigidLid
440        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
441        LOGICAL exactConserv        LOGICAL exactConserv
# Line 407  C                        & Last iteratio Line 450  C                        & Last iteratio
450        LOGICAL tempStepping        LOGICAL tempStepping
451        LOGICAL saltStepping        LOGICAL saltStepping
452        LOGICAL metricTerms        LOGICAL metricTerms
       LOGICAL useConstantF  
       LOGICAL useBetaPlaneF  
       LOGICAL useSphereF  
453        LOGICAL use3dCoriolis        LOGICAL use3dCoriolis
454        LOGICAL useCDscheme        LOGICAL useCDscheme
455        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
# Line 437  C                        & Last iteratio Line 477  C                        & Last iteratio
477        LOGICAL useOldFreezing        LOGICAL useOldFreezing
478        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
479        LOGICAL globalFiles        LOGICAL globalFiles
       LOGICAL useSingleCpuIO  
480        LOGICAL pickupStrictlyMatch        LOGICAL pickupStrictlyMatch
481        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
482        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
# Line 446  C                        & Last iteratio Line 485  C                        & Last iteratio
485        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
486        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
487        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
488        LOGICAL debugMode        LOGICAL debugMode, printDomain
489        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
490    
491  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
# Line 503  C     rUnit2mass :: units conversion fac Line 542  C     rUnit2mass :: units conversion fac
542  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].
543  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
544  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
545  C     phiMin    :: Latitude of southern most cell face.  C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
546  C     thetaMin  :: Longitude of western most cell face (this  C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
547  C                 is an "inert" parameter but it is included  C                :: parameter but it makes geographical references simple.)
548  C                 to make geographical references simple.)  C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
549  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).  C                :: most face (Lat-Lon grid).
550    C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
551  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
552  C     f0        :: Reference coriolis parameter ( 1/s )  C     f0         :: Reference coriolis parameter ( 1/s )
553  C                 ( Southern edge f for beta plane )  C                   ( Southern edge f for beta plane )
554  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta       :: df/dy ( s^-1.m^-1 )
555  C     omega     :: Angular velocity ( rad/s )  C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
556    C                   of rotation (reference value = 2.Omega.Cos(Phi))
557    C     omega      :: Angular velocity ( rad/s )
558  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
559  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
560  C                 momentum vertically ( units of r^2/s )  C                   for vertical mixing of momentum ( units of r^2/s )
561  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh     :: Eddy viscosity coeff. for mixing of
562  C                 momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
563  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
564  C                 momentum laterally, no effect for hydrostatic  C                   momentum laterally, no effect for hydrostatic
565  C                 model, defaults to viscAh if unset ( m^2/s )  C                   model, defaults to viscAh if unset ( m^2/s )
566  C                 Not used if variable horiz. viscosity is used.  C                   Not used if variable horiz. viscosity is used.
567  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4     :: Biharmonic viscosity coeff. for mixing of
568  C                 momentum laterally ( m^4/s )  C                   momentum laterally ( m^4/s )
569  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical  C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
570  C                 momentum laterally, no effect for hydrostatic  C                   momentum laterally, no effect for hydrostatic
571  C                 model, defaults to viscA4 if unset ( m^2/s )  C                   model, defaults to viscA4 if unset ( m^2/s )
572  C                 Not used if variable horiz. viscosity is used.  C                   Not used if variable horiz. viscosity is used.
573  C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
574  C                  (act on Divergence part) ( m^2/s )  C                   (act on Divergence part) ( m^2/s )
575  C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhZ    :: Eddy viscosity coeff. for mixing of momentum laterally
576  C                  (act on Vorticity  part) ( m^2/s )  C                   (act on Vorticity  part) ( m^2/s )
577  C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4D    :: Biharmonic viscosity coeff. for mixing of momentum laterally
578  C                  (act on Divergence part) ( m^4/s )  C                   (act on Divergence part) ( m^4/s )
579  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
580  C                  (act on Vorticity  part) ( m^4/s )  C                   (act on Vorticity  part) ( m^4/s )
581  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
582  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
583  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
# Line 598  C     implicSurfPress :: parameter of th Line 640  C     implicSurfPress :: parameter of th
640  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
641  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
642  C                     Implicit part of barotropic flow Divergence ( 0-1 )  C                     Implicit part of barotropic flow Divergence ( 0-1 )
643    C     implicitNHPress :: parameter of the Crank-Nickelson time stepping :
644    C                     Implicit part of Non-Hydrostatic Pressure Gradient ( 0-1 )
645  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
646  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    :: Minimum dimensional size of a cell (affects hFacC etc..., m)
647  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    :: Minimum dimensional size of a cell (affects hFacC etc..., Pa)
648  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)  C     hFacMinDr    :: Minimum dimensional size of a cell (-> hFacC etc..., r units)
649  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
650  C     hFacSup        that control vanishing and creating levels  C     hFacSup          that control vanishing and creating levels
651  C     tauCD        :: CD scheme coupling timescale ( 1/s )  C     tauCD         :: CD scheme coupling timescale ( s )
652  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )  C     rCD           :: CD scheme normalised coupling parameter (= 1 - deltaT/tauCD)
653    C     epsAB_CD      :: Adams-Bashforth-2 stabilizing weight used in CD scheme
654  C     baseTime      :: model base time (time origin) = time @ iteration zero  C     baseTime      :: model base time (time origin) = time @ iteration zero
655  C     startTime     :: Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
656  C     endTime       :: Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
# Line 641  C     convertFW2Salt :: salinity, used t Line 686  C     convertFW2Salt :: salinity, used t
686  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
687  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
688  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
689    C     temp_addMass :: temperature of addMass array
690    C     salt_addMass :: salinity of addMass array
691  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
692  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
693  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
694  C     hMixCrit    :: criteria for mixed-layer diagnostic  C     hMixCriteria:: criteria for mixed-layer diagnostic
695    C     dRhoSmall   :: parameter for mixed-layer diagnostic
696    C     hMixSmooth  :: Smoothing parameter for mixed-layer diag (default=0=no smoothing)
697  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
698  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
699  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
700    C     rSigmaBnd   :: vertical position (in r-unit) of r/sigma transition (Hybrid-Sigma)
701  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
702  C                           (default=2: full drag ; =1: gives half-slip BC)  C                           (default=2: full drag ; =1: gives half-slip BC)
703  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
# Line 666  C     psiEuler      :: Euler angle, rota Line 716  C     psiEuler      :: Euler angle, rota
716       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
717       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
718       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
719       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & xgOrigin, ygOrigin, rSphere, recip_rSphere,
720       & viscAh, viscAhW, viscAhMax,       & f0, beta, fPrime, omega, rotationPeriod,
721         & viscFacAdj, viscAh, viscAhW, viscAhMax,
722       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
723       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
724       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
# Line 675  C     psiEuler      :: Euler angle, rota Line 726  C     psiEuler      :: Euler angle, rota
726       & viscA4, viscA4W, viscA4Max,       & viscA4, viscA4W, viscA4Max,
727       & viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Grid, viscA4GridMax, viscA4GridMin,
728       & viscAhReMax, viscA4ReMax,       & viscAhReMax, viscA4ReMax,
729       & viscC4leith, viscC4leithD, viscAr,       & viscC4leith, viscC4leithD, viscArNr,
730       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
731       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
732       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
733       & BL79LatVary,       & BL79LatVary,
734       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
735       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & tauCD, rCD, epsAB_CD,
736         & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
737       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
738       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
739       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
# Line 692  C     psiEuler      :: Euler angle, rota Line 744  C     psiEuler      :: Euler angle, rota
744       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
745       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
746       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
747       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq,
748       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
749       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
750       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
751       & hFacMinDr, hFacMinDp,       & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
752       & ivdc_kappa, hMixCriteria, Ro_SeaLevel,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth,
753         & Ro_SeaLevel, rSigmaBnd,
754       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
755       & smoothAbsFuncRange,       & smoothAbsFuncRange,
756       & tCylIn, tCylOut,       & tCylIn, tCylOut,
# Line 717  C     psiEuler      :: Euler angle, rota Line 770  C     psiEuler      :: Euler angle, rota
770        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
771        _RL deltaTfreesurf        _RL deltaTfreesurf
772        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
773        _RL phiMin        _RL xgOrigin
774        _RL thetaMin        _RL ygOrigin
775        _RL rSphere        _RL rSphere
776        _RL recip_rSphere        _RL recip_rSphere
777        _RL f0        _RL f0
778          _RL beta
779          _RL fPrime
780          _RL omega
781          _RL rotationPeriod
782        _RL freeSurfFac        _RL freeSurfFac
783        _RL implicSurfPress        _RL implicSurfPress
784        _RL implicDiv2Dflow        _RL implicDiv2Dflow
785          _RL implicitNHPress
786        _RL hFacMin        _RL hFacMin
787        _RL hFacMinDz        _RL hFacMinDz
788        _RL hFacMinDp        _RL hFacMinDp
789        _RL hFacMinDr        _RL hFacMinDr
790        _RL hFacInf        _RL hFacInf
791        _RL hFacSup        _RL hFacSup
792        _RL beta        _RL viscArNr(Nr)
793        _RL viscAr        _RL viscFacAdj
794        _RL viscAh        _RL viscAh
795        _RL viscAhW        _RL viscAhW
796        _RL viscAhD        _RL viscAhD
# Line 768  C     psiEuler      :: Euler angle, rota Line 826  C     psiEuler      :: Euler angle, rota
826        _RL diffKrBLEQdeep        _RL diffKrBLEQdeep
827        _RL diffKrBLEQscl        _RL diffKrBLEQscl
828        _RL diffKrBLEQHo        _RL diffKrBLEQHo
829        _RL delt        _RL tauCD, rCD, epsAB_CD
       _RL tauCD  
       _RL rCD  
830        _RL gravity        _RL gravity
831        _RL recip_gravity        _RL recip_gravity
832        _RL gBaro        _RL gBaro
# Line 806  C     psiEuler      :: Euler angle, rota Line 862  C     psiEuler      :: Euler angle, rota
862        _RL mtFacMom        _RL mtFacMom
863        _RL cosPower        _RL cosPower
864        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
       _RL rotationPeriod  
865        _RL tauThetaClimRelax        _RL tauThetaClimRelax
866        _RL tauSaltClimRelax        _RL tauSaltClimRelax
867        _RL latBandClimRelax        _RL latBandClimRelax
# Line 816  C     psiEuler      :: Euler angle, rota Line 870  C     psiEuler      :: Euler angle, rota
870        _RL convertFW2Salt        _RL convertFW2Salt
871        _RL temp_EvPrRn        _RL temp_EvPrRn
872        _RL salt_EvPrRn        _RL salt_EvPrRn
873          _RL temp_addMass
874          _RL salt_addMass
875        _RL ivdc_kappa        _RL ivdc_kappa
876        _RL hMixCriteria        _RL hMixCriteria
877          _RL dRhoSmall
878          _RL hMixSmooth
879        _RL Ro_SeaLevel        _RL Ro_SeaLevel
880          _RL rSigmaBnd
881        _RL sideDragFactor        _RL sideDragFactor
882        _RL bottomDragLinear        _RL bottomDragLinear
883        _RL bottomDragQuadratic        _RL bottomDragQuadratic
# Line 871  C Logical flags for selecting packages Line 930  C Logical flags for selecting packages
930        LOGICAL useEBM        LOGICAL useEBM
931        LOGICAL useCheapAML        LOGICAL useCheapAML
932        LOGICAL useGrdchk        LOGICAL useGrdchk
933          LOGICAL useSMOOTH
934        LOGICAL useECCO        LOGICAL useECCO
935        LOGICAL useSBO        LOGICAL useSBO
936        LOGICAL useFLT        LOGICAL useFLT
# Line 882  C Logical flags for selecting packages Line 942  C Logical flags for selecting packages
942        LOGICAL useSEAICE        LOGICAL useSEAICE
943        LOGICAL useSALT_PLUME        LOGICAL useSALT_PLUME
944        LOGICAL useShelfIce        LOGICAL useShelfIce
945          LOGICAL useICEFRONT
946        LOGICAL useThSIce        LOGICAL useThSIce
947        LOGICAL useATM2d        LOGICAL useATM2d
948        LOGICAL useAIM        LOGICAL useAIM
# Line 890  C Logical flags for selecting packages Line 951  C Logical flags for selecting packages
951        LOGICAL useGridAlt        LOGICAL useGridAlt
952        LOGICAL useDiagnostics        LOGICAL useDiagnostics
953        LOGICAL useREGRID        LOGICAL useREGRID
954          LOGICAL useLayers
955        LOGICAL useMNC        LOGICAL useMNC
956        LOGICAL useRunClock        LOGICAL useRunClock
957        LOGICAL useEMBED_FILES        LOGICAL useEMBED_FILES
# Line 899  C Logical flags for selecting packages Line 961  C Logical flags for selecting packages
961       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
962       &        useGMRedi, useDOWN_SLOPE,       &        useGMRedi, useDOWN_SLOPE,
963       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
964       &        useGrdchk, useECCO, useSBO, useFLT,       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,
965       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
966       &        useSEAICE, useSALT_PLUME, useShelfIce, useThSIce,       &        useSEAICE, useSALT_PLUME, useShelfIce,
967         &        useICEFRONT, useThSIce,
968       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
969       &        useDiagnostics, useREGRID, useMNC,       &        useDiagnostics, useREGRID, useLayers, useMNC,
970       &        useRunClock, useEMBED_FILES,       &        useRunClock, useEMBED_FILES,
971       &        useMYPACKAGE       &        useMYPACKAGE
972    
973  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
974  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
975  CEH3 ;;; End: ***  CEH3 ;;; End: ***
Legend:
Removed from v.1.223  
changed lines
  Added in v.1.246
  ViewVC Help
Powered by ViewVC 1.1.22