/[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.231 by jmc, Thu Nov 19 19:48:29 2009 UTC revision 1.250 by dimitri, Wed Apr 20 13:45:13 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 269  C     checkIniSalt   :: check for points Line 299  C     checkIniSalt   :: check for points
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 302  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 323  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     debugMode       :: controls printing of debug msg (sequence of S/R calls).
361    C     printDomain     :: controls printing of domain fields (bathy, hFac ...).
362    
363        COMMON /PARM_L/        COMMON /PARM_L/
364       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
# Line 335  C                        & Last iteratio Line 371  C                        & Last iteratio
371       & momViscosity, momAdvection, momForcing,       & momViscosity, momAdvection, momForcing,
372       & momPressureForcing, metricTerms, useNHMTerms,       & momPressureForcing, metricTerms, useNHMTerms,
373       & useCoriolis, use3dCoriolis,       & useCoriolis, use3dCoriolis,
      & useConstantF, useBetaPlaneF, useSphereF,  
374       & useCDscheme, vectorInvariantMomentum,       & useCDscheme, vectorInvariantMomentum,
375       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
376       & upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
# Line 344  C                        & Last iteratio Line 379  C                        & Last iteratio
379       & tempAdvection, tempIsActiveTr, tempForcing,       & tempAdvection, tempIsActiveTr, tempForcing,
380       & saltAdvection, saltIsActiveTr, saltForcing,       & saltAdvection, saltIsActiveTr, saltForcing,
381       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
382       & useRealFreshWaterFlux,       & useRealFreshWaterFlux, useSRCGSolver,
383       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
384       & uniformLin_PhiSurf,       & uniformLin_PhiSurf,
385       & quasiHydrostatic, nonHydrostatic,       & quasiHydrostatic, nonHydrostatic,
# Line 355  C                        & Last iteratio Line 390  C                        & Last iteratio
390       & momDissip_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
391       & balanceEmPmR, balanceQnet, balancePrintMean,       & balanceEmPmR, balanceQnet, balancePrintMean,
392       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
393       & allowFreezing, useOldFreezing,       & allowFreezing, allowInteriorFreezing, useOldFreezing,
394       & periodicExternalForcing,       & periodicExternalForcing,
395       & globalFiles, useSingleCpuIO,       & globalFiles,
396       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
397       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
398       & writePickupAtEnd,       & writePickupAtEnd,
399       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
400       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast,
401         & debugMode, printDomain,
402       & inAdMode, inAdTrue, inAdFalse, inAdExact       & inAdMode, inAdTrue, inAdFalse, inAdExact
403    
404        LOGICAL fluidIsAir        LOGICAL fluidIsAir
# Line 380  C                        & Last iteratio Line 416  C                        & Last iteratio
416        LOGICAL useNHMTerms        LOGICAL useNHMTerms
417        LOGICAL no_slip_sides        LOGICAL no_slip_sides
418        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
419          LOGICAL useFullLeith
420          LOGICAL useStrainTensionVisc
421          LOGICAL useAreaViscLength
422        LOGICAL momViscosity        LOGICAL momViscosity
423        LOGICAL momAdvection        LOGICAL momAdvection
424        LOGICAL momForcing        LOGICAL momForcing
# Line 397  C                        & Last iteratio Line 436  C                        & Last iteratio
436        LOGICAL checkIniTemp        LOGICAL checkIniTemp
437        LOGICAL checkIniSalt        LOGICAL checkIniSalt
438        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
439        LOGICAL useFullLeith        LOGICAL useSRCGSolver
       LOGICAL useStrainTensionVisc  
       LOGICAL useAreaViscLength  
440        LOGICAL rigidLid        LOGICAL rigidLid
441        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
442        LOGICAL exactConserv        LOGICAL exactConserv
# Line 414  C                        & Last iteratio Line 451  C                        & Last iteratio
451        LOGICAL tempStepping        LOGICAL tempStepping
452        LOGICAL saltStepping        LOGICAL saltStepping
453        LOGICAL metricTerms        LOGICAL metricTerms
       LOGICAL useConstantF  
       LOGICAL useBetaPlaneF  
       LOGICAL useSphereF  
454        LOGICAL use3dCoriolis        LOGICAL use3dCoriolis
455        LOGICAL useCDscheme        LOGICAL useCDscheme
456        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
# Line 441  C                        & Last iteratio Line 475  C                        & Last iteratio
475        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
476        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
477        LOGICAL allowFreezing        LOGICAL allowFreezing
478          LOGICAL allowInteriorFreezing
479        LOGICAL useOldFreezing        LOGICAL useOldFreezing
480        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
481        LOGICAL globalFiles        LOGICAL globalFiles
       LOGICAL useSingleCpuIO  
482        LOGICAL pickupStrictlyMatch        LOGICAL pickupStrictlyMatch
483        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
484        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
# Line 453  C                        & Last iteratio Line 487  C                        & Last iteratio
487        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
488        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
489        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
490        LOGICAL debugMode        LOGICAL debugMode, printDomain
491        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
492    
493  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
# Line 481  C     delR      :: Vertical grid spacing Line 515  C     delR      :: Vertical grid spacing
515  C     delRc     :: Vertical grid spacing between cell centers (r unit).  C     delRc     :: Vertical grid spacing between cell centers (r unit).
516  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
517  C     delY        on input flags.  C     delY        on input flags.
518    C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
519    C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
520    C                :: parameter but it makes geographical references simple.)
521    C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
522    C                :: most face (Lat-Lon grid).
523  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
524  C     recip_gravity and its inverse  C     recip_gravity and its inverse
525  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 493  C     rho1Ref   :: reference vertical pr Line 532  C     rho1Ref   :: reference vertical pr
532  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
533  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
534  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
535  C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:  C     dBdrRef   :: vertical gradient of reference buoyancy  [(m/s/r)^2]:
536  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
537  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
538  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
# Line 510  C     rUnit2mass :: units conversion fac Line 549  C     rUnit2mass :: units conversion fac
549  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].
550  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
551  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).  
552  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
553  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
554    C     radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
555  C     f0         :: Reference coriolis parameter ( 1/s )  C     f0         :: Reference coriolis parameter ( 1/s )
556  C                   ( Southern edge f for beta plane )  C                   ( Southern edge f for beta plane )
557  C     beta       :: df/dy ( s^-1.m^-1 )  C     beta       :: df/dy ( s^-1.m^-1 )
558    C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
559    C                   of rotation (reference value = 2.Omega.Cos(Phi))
560  C     omega      :: Angular velocity ( rad/s )  C     omega      :: Angular velocity ( rad/s )
561  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
562  C     viscArNr   :: vertical profile of Eddy viscosity coeff.  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
# Line 606  C     implicSurfPress :: parameter of th Line 643  C     implicSurfPress :: parameter of th
643  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
644  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
645  C                     Implicit part of barotropic flow Divergence ( 0-1 )  C                     Implicit part of barotropic flow Divergence ( 0-1 )
646    C     implicitNHPress :: parameter of the Crank-Nickelson time stepping :
647    C                     Implicit part of Non-Hydrostatic Pressure Gradient ( 0-1 )
648  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
649  C     hFacMinDz    :: Minimum dimensional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    :: Minimum dimensional size of a cell (affects hFacC etc..., m)
650  C     hFacMinDp    :: Minimum dimensional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    :: Minimum dimensional size of a cell (affects hFacC etc..., Pa)
# Line 650  C     convertFW2Salt :: salinity, used t Line 689  C     convertFW2Salt :: salinity, used t
689  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
690  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
691  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
692    C     temp_addMass :: temperature of addMass array
693    C     salt_addMass :: salinity of addMass array
694  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
695  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
696  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 659  C     hMixSmooth  :: Smoothing parameter Line 700  C     hMixSmooth  :: Smoothing parameter
700  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
701  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
702  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
703    C     rSigmaBnd   :: vertical position (in r-unit) of r/sigma transition (Hybrid-Sigma)
704  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
705  C                           (default=2: full drag ; =1: gives half-slip BC)  C                           (default=2: full drag ; =1: gives half-slip BC)
706  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
# Line 674  C     thetaEuler    :: Euler angle, rota Line 716  C     thetaEuler    :: Euler angle, rota
716  C     psiEuler      :: Euler angle, rotation about new z-axis  C     psiEuler      :: Euler angle, rotation about new z-axis
717        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
718       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
719       & delR, delRc, delX, delY,       & delR, delRc, delX, delY, xgOrigin, ygOrigin,
720       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
721       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
722       & xgOrigin, ygOrigin, rSphere, recip_RSphere, f0, beta,       & rSphere, recip_rSphere, radius_fromHorizGrid,
723       & viscAh, viscAhW, viscAhMax,       & f0, beta, fPrime, omega, rotationPeriod,
724         & viscFacAdj, viscAh, viscAhW, viscAhMax,
725       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
726       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
727       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
# Line 693  C     psiEuler      :: Euler angle, rota Line 736  C     psiEuler      :: Euler angle, rota
736       & BL79LatVary,       & BL79LatVary,
737       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
738       & tauCD, rCD, epsAB_CD,       & tauCD, rCD, epsAB_CD,
739       & freeSurfFac, implicSurfPress, implicDiv2Dflow,       & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
740       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
741       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
742       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
# Line 704  C     psiEuler      :: Euler angle, rota Line 747  C     psiEuler      :: Euler angle, rota
747       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
748       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
749       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
750       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq,
751       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
752       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
753       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
754       & hFacMinDr, hFacMinDp,       & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
755       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, Ro_SeaLevel,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth,
756         & Ro_SeaLevel, rSigmaBnd,
757       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
758       & smoothAbsFuncRange,       & smoothAbsFuncRange,
759       & tCylIn, tCylOut,       & tCylIn, tCylOut,
# Line 723  C     psiEuler      :: Euler angle, rota Line 767  C     psiEuler      :: Euler angle, rota
767        _RL delRc(Nr+1)        _RL delRc(Nr+1)
768        _RL delX(Nx)        _RL delX(Nx)
769        _RL delY(Ny)        _RL delY(Ny)
770          _RL xgOrigin
771          _RL ygOrigin
772        _RL deltaT        _RL deltaT
773        _RL deltaTClock        _RL deltaTClock
774        _RL deltaTmom        _RL deltaTmom
775        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
776        _RL deltaTfreesurf        _RL deltaTfreesurf
777        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
       _RL xgOrigin  
       _RL ygOrigin  
778        _RL rSphere        _RL rSphere
779        _RL recip_rSphere        _RL recip_rSphere
780          _RL radius_fromHorizGrid
781        _RL f0        _RL f0
782          _RL beta
783          _RL fPrime
784          _RL omega
785          _RL rotationPeriod
786        _RL freeSurfFac        _RL freeSurfFac
787        _RL implicSurfPress        _RL implicSurfPress
788        _RL implicDiv2Dflow        _RL implicDiv2Dflow
789          _RL implicitNHPress
790        _RL hFacMin        _RL hFacMin
791        _RL hFacMinDz        _RL hFacMinDz
792        _RL hFacMinDp        _RL hFacMinDp
793        _RL hFacMinDr        _RL hFacMinDr
794        _RL hFacInf        _RL hFacInf
795        _RL hFacSup        _RL hFacSup
       _RL beta  
796        _RL viscArNr(Nr)        _RL viscArNr(Nr)
797          _RL viscFacAdj
798        _RL viscAh        _RL viscAh
799        _RL viscAhW        _RL viscAhW
800        _RL viscAhD        _RL viscAhD
# Line 816  C     psiEuler      :: Euler angle, rota Line 866  C     psiEuler      :: Euler angle, rota
866        _RL mtFacMom        _RL mtFacMom
867        _RL cosPower        _RL cosPower
868        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
       _RL rotationPeriod  
869        _RL tauThetaClimRelax        _RL tauThetaClimRelax
870        _RL tauSaltClimRelax        _RL tauSaltClimRelax
871        _RL latBandClimRelax        _RL latBandClimRelax
# Line 826  C     psiEuler      :: Euler angle, rota Line 874  C     psiEuler      :: Euler angle, rota
874        _RL convertFW2Salt        _RL convertFW2Salt
875        _RL temp_EvPrRn        _RL temp_EvPrRn
876        _RL salt_EvPrRn        _RL salt_EvPrRn
877          _RL temp_addMass
878          _RL salt_addMass
879        _RL ivdc_kappa        _RL ivdc_kappa
880        _RL hMixCriteria        _RL hMixCriteria
881        _RL dRhoSmall        _RL dRhoSmall
882        _RL hMixSmooth        _RL hMixSmooth
883        _RL Ro_SeaLevel        _RL Ro_SeaLevel
884          _RL rSigmaBnd
885        _RL sideDragFactor        _RL sideDragFactor
886        _RL bottomDragLinear        _RL bottomDragLinear
887        _RL bottomDragQuadratic        _RL bottomDragQuadratic
# Line 895  C Logical flags for selecting packages Line 946  C Logical flags for selecting packages
946        LOGICAL useSEAICE        LOGICAL useSEAICE
947        LOGICAL useSALT_PLUME        LOGICAL useSALT_PLUME
948        LOGICAL useShelfIce        LOGICAL useShelfIce
949          LOGICAL useICEFRONT
950        LOGICAL useThSIce        LOGICAL useThSIce
951        LOGICAL useATM2d        LOGICAL useATM2d
952        LOGICAL useAIM        LOGICAL useAIM
# Line 915  C Logical flags for selecting packages Line 967  C Logical flags for selecting packages
967       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
968       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,
969       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
970       &        useSEAICE, useSALT_PLUME, useShelfIce, useThSIce,       &        useSEAICE, useSALT_PLUME, useShelfIce,
971         &        useICEFRONT, useThSIce,
972       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
973       &        useDiagnostics, useREGRID, useLayers, useMNC,       &        useDiagnostics, useREGRID, useLayers, useMNC,
974       &        useRunClock, useEMBED_FILES,       &        useRunClock, useEMBED_FILES,
975       &        useMYPACKAGE       &        useMYPACKAGE
976    
977    C     Logical flags for turning off parts of the code in adjoint mode
978          LOGICAL useKPPinAdMode, useKPPinFwdMode
979          LOGICAL useGMrediInAdMode, useGMrediInFwdMode
980          LOGICAL useSEAICEinAdMode, useSEAICEinFwdMode
981          COMMON /PARM_PACKAGES_ADJ/
982         &       useKPPinAdMode, useKPPinFwdMode,
983         &       useGMrediInAdMode, useGMrediInFwdMode,
984         &       useSEAICEinAdMode, useSEAICEinFwdMode
985          
986  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
987  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
988  CEH3 ;;; End: ***  CEH3 ;;; End: ***
Legend:
Removed from v.1.231  
changed lines
  Added in v.1.250
  ViewVC Help
Powered by ViewVC 1.1.22