/[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.228 by rpa, Wed Sep 16 21:36:53 2009 UTC revision 1.251 by jmc, Mon Jun 6 12:43:27 2011 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 139  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 158  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 168  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 186  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 238  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 262  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 298  C                        climatology is Line 336  C                        climatology is
336  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
337  C                        climatology is required.  C                        climatology is required.
338  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
339    C     allowInteriorFreezing :: Allow water at depth to freeze and rise to the surface
340  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
341  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
342  C- I/O parameters -  C- I/O parameters -
343  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files.
344  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  C                       On some platforms with MPI, option globalFiles is either
345  C                       slow (f77) or does not work (f90).  When  C                       slow or does not work. Use useSingleCpuIO instead.
346  C                       useSingleCpuIO is set, mdsio_writefield.F  C     useSingleCpuIO :: moved to EEPARAMS.h
 C                       outputs from master mpi process only.  
347  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
348  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
349  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
# Line 319  C     snapshot_mdsio     :: use mdsio fo Line 357  C     snapshot_mdsio     :: use mdsio fo
357  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
358  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
359  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
360    C     printDomain     :: controls printing of domain fields (bathy, hFac ...).
361    
362        COMMON /PARM_L/        COMMON /PARM_L/
363       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
# Line 331  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 339  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 350  C                        & Last iteratio Line 389  C                        & Last iteratio
389       & momDissip_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
390       & balanceEmPmR, balanceQnet, balancePrintMean,       & balanceEmPmR, balanceQnet, balancePrintMean,
391       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
392       & allowFreezing, useOldFreezing,       & allowFreezing, allowInteriorFreezing, 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         & printDomain,
401       & inAdMode, inAdTrue, inAdFalse, inAdExact       & inAdMode, inAdTrue, inAdFalse, inAdExact
402    
403        LOGICAL fluidIsAir        LOGICAL fluidIsAir
# Line 375  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 387  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 405  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 432  C                        & Last iteratio Line 474  C                        & Last iteratio
474        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
475        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
476        LOGICAL allowFreezing        LOGICAL allowFreezing
477          LOGICAL allowInteriorFreezing
478        LOGICAL useOldFreezing        LOGICAL useOldFreezing
479        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
480        LOGICAL globalFiles        LOGICAL globalFiles
       LOGICAL useSingleCpuIO  
481        LOGICAL pickupStrictlyMatch        LOGICAL pickupStrictlyMatch
482        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
483        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
# Line 444  C                        & Last iteratio Line 486  C                        & Last iteratio
486        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
487        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
488        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
489        LOGICAL debugMode        LOGICAL printDomain
490        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
491    
492  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
# Line 472  C     delR      :: Vertical grid spacing Line 514  C     delR      :: Vertical grid spacing
514  C     delRc     :: Vertical grid spacing between cell centers (r unit).  C     delRc     :: Vertical grid spacing between cell centers (r unit).
515  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
516  C     delY        on input flags.  C     delY        on input flags.
517    C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
518    C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
519    C                :: parameter but it makes geographical references simple.)
520    C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
521    C                :: most face (Lat-Lon grid).
522  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
523  C     recip_gravity and its inverse  C     recip_gravity and its inverse
524  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 )
# Line 484  C     rho1Ref   :: reference vertical pr Line 531  C     rho1Ref   :: reference vertical pr
531  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
532  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
533  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
534  C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:  C     dBdrRef   :: vertical gradient of reference buoyancy  [(m/s/r)^2]:
535  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
536  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
537  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
# Line 501  C     rUnit2mass :: units conversion fac Line 548  C     rUnit2mass :: units conversion fac
548  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].
549  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
550  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).  
551  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
552  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
553    C     radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
554  C     f0         :: Reference coriolis parameter ( 1/s )  C     f0         :: Reference coriolis parameter ( 1/s )
555  C                   ( Southern edge f for beta plane )  C                   ( Southern edge f for beta plane )
556  C     beta       :: df/dy ( s^-1.m^-1 )  C     beta       :: df/dy ( s^-1.m^-1 )
557    C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
558    C                   of rotation (reference value = 2.Omega.Cos(Phi))
559  C     omega      :: Angular velocity ( rad/s )  C     omega      :: Angular velocity ( rad/s )
560  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
561  C     viscAr     :: Eddy viscosity coeff. for mixing of  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
562  C                   momentum vertically ( units of r^2/s )  C                   for vertical mixing of momentum ( units of r^2/s )
563  C     viscAh     :: Eddy viscosity coeff. for mixing of  C     viscAh     :: Eddy viscosity coeff. for mixing of
564  C                   momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
565  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
# Line 597  C     implicSurfPress :: parameter of th Line 642  C     implicSurfPress :: parameter of th
642  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
643  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
644  C                     Implicit part of barotropic flow Divergence ( 0-1 )  C                     Implicit part of barotropic flow Divergence ( 0-1 )
645    C     implicitNHPress :: parameter of the Crank-Nickelson time stepping :
646    C                     Implicit part of Non-Hydrostatic Pressure Gradient ( 0-1 )
647  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
648  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    :: Minimum dimensional size of a cell (affects hFacC etc..., m)
649  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    :: Minimum dimensional size of a cell (affects hFacC etc..., Pa)
650  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)
651  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
652  C     hFacSup        that control vanishing and creating levels  C     hFacSup          that control vanishing and creating levels
653  C     tauCD        :: CD scheme coupling timescale ( 1/s )  C     tauCD         :: CD scheme coupling timescale ( s )
654  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )  C     rCD           :: CD scheme normalised coupling parameter (= 1 - deltaT/tauCD)
655    C     epsAB_CD      :: Adams-Bashforth-2 stabilizing weight used in CD scheme
656  C     baseTime      :: model base time (time origin) = time @ iteration zero  C     baseTime      :: model base time (time origin) = time @ iteration zero
657  C     startTime     :: Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
658  C     endTime       :: Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
# Line 640  C     convertFW2Salt :: salinity, used t Line 688  C     convertFW2Salt :: salinity, used t
688  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
689  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
690  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
691    C     temp_addMass :: temperature of addMass array
692    C     salt_addMass :: salinity of addMass array
693  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
694  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
695  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 649  C     hMixSmooth  :: Smoothing parameter Line 699  C     hMixSmooth  :: Smoothing parameter
699  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
700  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
701  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
702    C     rSigmaBnd   :: vertical position (in r-unit) of r/sigma transition (Hybrid-Sigma)
703  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
704  C                           (default=2: full drag ; =1: gives half-slip BC)  C                           (default=2: full drag ; =1: gives half-slip BC)
705  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
# Line 664  C     thetaEuler    :: Euler angle, rota Line 715  C     thetaEuler    :: Euler angle, rota
715  C     psiEuler      :: Euler angle, rotation about new z-axis  C     psiEuler      :: Euler angle, rotation about new z-axis
716        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
717       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
718       & delR, delRc, delX, delY,       & delR, delRc, delX, delY, xgOrigin, ygOrigin,
719       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
720       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
721       & xgOrigin, ygOrigin, rSphere, recip_RSphere, f0, beta,       & rSphere, recip_rSphere, radius_fromHorizGrid,
722       & viscAh, viscAhW, viscAhMax,       & f0, beta, fPrime, omega, rotationPeriod,
723         & viscFacAdj, viscAh, viscAhW, viscAhMax,
724       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
725       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
726       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
# Line 676  C     psiEuler      :: Euler angle, rota Line 728  C     psiEuler      :: Euler angle, rota
728       & viscA4, viscA4W, viscA4Max,       & viscA4, viscA4W, viscA4Max,
729       & viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Grid, viscA4GridMax, viscA4GridMin,
730       & viscAhReMax, viscA4ReMax,       & viscAhReMax, viscA4ReMax,
731       & viscC4leith, viscC4leithD, viscAr,       & viscC4leith, viscC4leithD, viscArNr,
732       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
733       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
734       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
735       & BL79LatVary,       & BL79LatVary,
736       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
737       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & tauCD, rCD, epsAB_CD,
738         & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
739       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
740       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
741       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
# Line 693  C     psiEuler      :: Euler angle, rota Line 746  C     psiEuler      :: Euler angle, rota
746       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
747       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
748       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
749       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq,
750       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
751       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
752       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
753       & hFacMinDr, hFacMinDp,       & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
754       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, Ro_SeaLevel,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth,
755         & Ro_SeaLevel, rSigmaBnd,
756       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
757       & smoothAbsFuncRange,       & smoothAbsFuncRange,
758       & tCylIn, tCylOut,       & tCylIn, tCylOut,
# Line 712  C     psiEuler      :: Euler angle, rota Line 766  C     psiEuler      :: Euler angle, rota
766        _RL delRc(Nr+1)        _RL delRc(Nr+1)
767        _RL delX(Nx)        _RL delX(Nx)
768        _RL delY(Ny)        _RL delY(Ny)
769          _RL xgOrigin
770          _RL ygOrigin
771        _RL deltaT        _RL deltaT
772        _RL deltaTClock        _RL deltaTClock
773        _RL deltaTmom        _RL deltaTmom
774        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
775        _RL deltaTfreesurf        _RL deltaTfreesurf
776        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
       _RL xgOrigin  
       _RL ygOrigin  
777        _RL rSphere        _RL rSphere
778        _RL recip_rSphere        _RL recip_rSphere
779          _RL radius_fromHorizGrid
780        _RL f0        _RL f0
781          _RL beta
782          _RL fPrime
783          _RL omega
784          _RL rotationPeriod
785        _RL freeSurfFac        _RL freeSurfFac
786        _RL implicSurfPress        _RL implicSurfPress
787        _RL implicDiv2Dflow        _RL implicDiv2Dflow
788          _RL implicitNHPress
789        _RL hFacMin        _RL hFacMin
790        _RL hFacMinDz        _RL hFacMinDz
791        _RL hFacMinDp        _RL hFacMinDp
792        _RL hFacMinDr        _RL hFacMinDr
793        _RL hFacInf        _RL hFacInf
794        _RL hFacSup        _RL hFacSup
795        _RL beta        _RL viscArNr(Nr)
796        _RL viscAr        _RL viscFacAdj
797        _RL viscAh        _RL viscAh
798        _RL viscAhW        _RL viscAhW
799        _RL viscAhD        _RL viscAhD
# Line 769  C     psiEuler      :: Euler angle, rota Line 829  C     psiEuler      :: Euler angle, rota
829        _RL diffKrBLEQdeep        _RL diffKrBLEQdeep
830        _RL diffKrBLEQscl        _RL diffKrBLEQscl
831        _RL diffKrBLEQHo        _RL diffKrBLEQHo
832        _RL delt        _RL tauCD, rCD, epsAB_CD
       _RL tauCD  
       _RL rCD  
833        _RL gravity        _RL gravity
834        _RL recip_gravity        _RL recip_gravity
835        _RL gBaro        _RL gBaro
# Line 807  C     psiEuler      :: Euler angle, rota Line 865  C     psiEuler      :: Euler angle, rota
865        _RL mtFacMom        _RL mtFacMom
866        _RL cosPower        _RL cosPower
867        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
       _RL rotationPeriod  
868        _RL tauThetaClimRelax        _RL tauThetaClimRelax
869        _RL tauSaltClimRelax        _RL tauSaltClimRelax
870        _RL latBandClimRelax        _RL latBandClimRelax
# Line 817  C     psiEuler      :: Euler angle, rota Line 873  C     psiEuler      :: Euler angle, rota
873        _RL convertFW2Salt        _RL convertFW2Salt
874        _RL temp_EvPrRn        _RL temp_EvPrRn
875        _RL salt_EvPrRn        _RL salt_EvPrRn
876          _RL temp_addMass
877          _RL salt_addMass
878        _RL ivdc_kappa        _RL ivdc_kappa
879        _RL hMixCriteria        _RL hMixCriteria
880        _RL dRhoSmall        _RL dRhoSmall
881        _RL hMixSmooth        _RL hMixSmooth
882        _RL Ro_SeaLevel        _RL Ro_SeaLevel
883          _RL rSigmaBnd
884        _RL sideDragFactor        _RL sideDragFactor
885        _RL bottomDragLinear        _RL bottomDragLinear
886        _RL bottomDragQuadratic        _RL bottomDragQuadratic
# Line 874  C Logical flags for selecting packages Line 933  C Logical flags for selecting packages
933        LOGICAL useEBM        LOGICAL useEBM
934        LOGICAL useCheapAML        LOGICAL useCheapAML
935        LOGICAL useGrdchk        LOGICAL useGrdchk
936          LOGICAL useSMOOTH
937        LOGICAL useECCO        LOGICAL useECCO
938        LOGICAL useSBO        LOGICAL useSBO
939        LOGICAL useFLT        LOGICAL useFLT
# Line 885  C Logical flags for selecting packages Line 945  C Logical flags for selecting packages
945        LOGICAL useSEAICE        LOGICAL useSEAICE
946        LOGICAL useSALT_PLUME        LOGICAL useSALT_PLUME
947        LOGICAL useShelfIce        LOGICAL useShelfIce
948          LOGICAL useICEFRONT
949        LOGICAL useThSIce        LOGICAL useThSIce
950        LOGICAL useATM2d        LOGICAL useATM2d
951        LOGICAL useAIM        LOGICAL useAIM
# Line 903  C Logical flags for selecting packages Line 964  C Logical flags for selecting packages
964       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
965       &        useGMRedi, useDOWN_SLOPE,       &        useGMRedi, useDOWN_SLOPE,
966       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
967       &        useGrdchk, useECCO, useSBO, useFLT,       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,
968       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
969       &        useSEAICE, useSALT_PLUME, useShelfIce, useThSIce,       &        useSEAICE, useSALT_PLUME, useShelfIce,
970         &        useICEFRONT, useThSIce,
971       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
972       &        useDiagnostics, useREGRID, useLayers, useMNC,       &        useDiagnostics, useREGRID, useLayers, useMNC,
973       &        useRunClock, useEMBED_FILES,       &        useRunClock, useEMBED_FILES,
974       &        useMYPACKAGE       &        useMYPACKAGE
975    
976    C     Logical flags for turning off parts of the code in adjoint mode
977          LOGICAL useKPPinAdMode, useKPPinFwdMode
978          LOGICAL useGMrediInAdMode, useGMrediInFwdMode
979          LOGICAL useSEAICEinAdMode, useSEAICEinFwdMode
980          COMMON /PARM_PACKAGES_ADJ/
981         &       useKPPinAdMode, useKPPinFwdMode,
982         &       useGMrediInAdMode, useGMrediInFwdMode,
983         &       useSEAICEinAdMode, useSEAICEinFwdMode
984    
985  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
986  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
987  CEH3 ;;; End: ***  CEH3 ;;; End: ***
Legend:
Removed from v.1.228  
changed lines
  Added in v.1.251
  ViewVC Help
Powered by ViewVC 1.1.22