/[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.220 by jmc, Sun Aug 17 02:06:04 2008 UTC revision 1.244 by jmc, Wed Nov 17 21:15:08 2010 UTC
# Line 38  C     sRefFile      :: File containing r Line 38  C     sRefFile      :: File containing r
38  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
39  C     delRFile      :: File containing vertical grid spacing delR  (1.D array)  C     delRFile      :: File containing vertical grid spacing delR  (1.D array)
40  C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)  C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)
41    C     hybSigmFile   :: File containing hybrid-sigma vertical coord. coeff. (2x 1.D)
42  C     delXFile      :: File containing X-spacing grid definition (1.D array)  C     delXFile      :: File containing X-spacing grid definition (1.D array)
43  C     delYFile      :: File containing Y-spacing grid definition (1.D array)  C     delYFile      :: File containing Y-spacing grid definition (1.D array)
44  C     horizGridFile :: File containing horizontal-grid definition  C     horizGridFile :: File containing horizontal-grid definition
# Line 46  C     bathyFile       :: File containing Line 47  C     bathyFile       :: File containing
47  C                        is taken from inline function.  C                        is taken from inline function.
48  C     topoFile        :: File containing the topography of the surface (unit=m)  C     topoFile        :: File containing the topography of the surface (unit=m)
49  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)  
50  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
51  C                        for potential temperature.  C                        for potential temperature.
52  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
53  C                        for salinity.  C                        for salinity.
54  C     diffKrFile      :: File containing 3D specification of vertical diffusivity  C     diffKrFile      :: File containing 3D specification of vertical diffusivity
55    C     viscAhDfile     :: File containing 3D specification of horizontal viscosity
56    C     viscAhZfile     :: File containing 3D specification of horizontal viscosity
57    C     viscA4Dfile     :: File containing 3D specification of horizontal viscosity
58    C     viscA4Zfile     :: File containing 3D specification of horizontal viscosity
59  C     zonalWindFile   :: File containing zonal wind data  C     zonalWindFile   :: File containing zonal wind data
60  C     meridWindFile   :: File containing meridional wind data  C     meridWindFile   :: File containing meridional wind data
61  C     thetaClimFile   :: File containing surface theta climataology used  C     thetaClimFile   :: File containing surface theta climataology used
# Line 77  C     the_run_name    :: string identify Line 80  C     the_run_name    :: string identify
80       &                buoyancyRelation, eosType,       &                buoyancyRelation, eosType,
81       &                pickupSuff, mdsioLocalDir,       &                pickupSuff, mdsioLocalDir,
82       &                tRefFile, sRefFile, rhoRefFile,       &                tRefFile, sRefFile, rhoRefFile,
83       &                delRFile, delRcFile,       &                delRFile, delRcFile, hybSigmFile,
84       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
85       &                bathyFile, topoFile, shelfIceFile,       &                bathyFile, topoFile,
86         &                viscAhDfile, viscAhZfile,
87         &                viscA4Dfile, viscA4Zfile,
88       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
89       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
90       &                saltClimFile,       &                saltClimFile,
# Line 99  C     the_run_name    :: string identify Line 104  C     the_run_name    :: string identify
104        CHARACTER*(MAX_LEN_FNAM) rhoRefFile        CHARACTER*(MAX_LEN_FNAM) rhoRefFile
105        CHARACTER*(MAX_LEN_FNAM) delRFile        CHARACTER*(MAX_LEN_FNAM) delRFile
106        CHARACTER*(MAX_LEN_FNAM) delRcFile        CHARACTER*(MAX_LEN_FNAM) delRcFile
107          CHARACTER*(MAX_LEN_FNAM) hybSigmFile
108        CHARACTER*(MAX_LEN_FNAM) delXFile        CHARACTER*(MAX_LEN_FNAM) delXFile
109        CHARACTER*(MAX_LEN_FNAM) delYFile        CHARACTER*(MAX_LEN_FNAM) delYFile
110        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
111        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
112        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
113        CHARACTER*(MAX_LEN_FNAM) diffKrFile        CHARACTER*(MAX_LEN_FNAM) diffKrFile
114          CHARACTER*(MAX_LEN_FNAM) viscAhDfile
115          CHARACTER*(MAX_LEN_FNAM) viscAhZfile
116          CHARACTER*(MAX_LEN_FNAM) viscA4Dfile
117          CHARACTER*(MAX_LEN_FNAM) viscA4Zfile
118        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
119        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
120        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
# Line 141  C     nTimeSteps          :: Number of t Line 151  C     nTimeSteps          :: Number of t
151  C     writeStatePrec      :: Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
152  C     writeBinaryPrec     :: Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
153  C     readBinaryPrec      :: Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
154    C     selectCoriMap       :: select setting of Coriolis parameter map:
155    C                           =0 f-Plane (Constant Coriolis, = f0)
156    C                           =1 Beta-Plane Coriolis (= f0 + beta.y)
157    C                           =2 Spherical Coriolis (= 2.omega.sin(phi))
158    C                           =3 Read Coriolis 2-d fields from files.
159    C     selectSigmaCoord    :: option related to sigma vertical coordinate
160  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
161  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
162  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
163  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
164    C     selectNHfreeSurf    :: option for Non-Hydrostatic (free-)Surface formulation:
165    C                           =0 (default) hydrostatic surf. ; > 0 add NH effects.
166    C     selectAddFluid      :: option to add mass source/sink of fluid in the interior
167    C                            (3-D generalisation of oceanic real-fresh water flux)
168    C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
169  C     momForcingOutAB     :: =1: take momentum forcing contribution  C     momForcingOutAB     :: =1: take momentum forcing contribution
170  C                           out of (=0: in) Adams-Bashforth time stepping.  C                           out of (=0: in) Adams-Bashforth time stepping.
171  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
# Line 157  C     selectKEscheme      :: Kinetic Ene Line 178  C     selectKEscheme      :: Kinetic Ene
178  C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)  C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)
179  C     monitorSelect       :: select group of variables to monitor  C     monitorSelect       :: select group of variables to monitor
180  C                            =1 : dynvars ; =2 : + vort ; =3 : + surface  C                            =1 : dynvars ; =2 : + vort ; =3 : + surface
181  C     debugLevel          :: debug level selector: higher -> more writing  C-    debugLevel          :: controls printing of algorithm intermediate results
182    C                            and statistics ; higher -> more writing
183    
184        COMMON /PARM_I/        COMMON /PARM_I/
185       &        cg2dMaxIters,       &        cg2dMaxIters,
# Line 167  C     debugLevel          :: debug level Line 189  C     debugLevel          :: debug level
189       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
190       &        writeStatePrec,       &        writeStatePrec,
191       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
192         &        selectCoriMap,
193         &        selectSigmaCoord,
194       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
195         &        selectNHfreeSurf,
196         &        selectAddFluid,
197       &        momForcingOutAB, tracForcingOutAB,       &        momForcingOutAB, tracForcingOutAB,
198       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
199       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
# Line 184  C     debugLevel          :: debug level Line 210  C     debugLevel          :: debug level
210        INTEGER writeStatePrec        INTEGER writeStatePrec
211        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
212        INTEGER readBinaryPrec        INTEGER readBinaryPrec
213          INTEGER selectCoriMap
214          INTEGER selectSigmaCoord
215        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
216        INTEGER select_rStar        INTEGER select_rStar
217          INTEGER selectNHfreeSurf
218          INTEGER selectAddFluid
219        INTEGER momForcingOutAB, tracForcingOutAB        INTEGER momForcingOutAB, tracForcingOutAB
220        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
221        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
# Line 235  C     metricTerms   :: Flag which turns Line 265  C     metricTerms   :: Flag which turns
265  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
266  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
267  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)  
268  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
269  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
270  C                                (default = F = use mom_fluxform package)  C                                (default = F = use mom_fluxform package)
# Line 259  C     saltAdvection  :: Flag which turns Line 286  C     saltAdvection  :: Flag which turns
286  C     saltIsActiveTr :: Salinity  is a dynamically active tracer  C     saltIsActiveTr :: Salinity  is a dynamically active tracer
287  C     saltForcing    :: Flag which turns external forcing of salinity on  C     saltForcing    :: Flag which turns external forcing of salinity on
288  C                       and off.  C                       and off.
289    C     maskIniTemp    :: apply mask to initial Pot.Temp.
290    C     maskIniSalt    :: apply mask to initial salinity
291    C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
292    C     checkIniSalt   :: check for points with identically zero initial salinity
293  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
294  C                         as a real Fresh Water (=> changes the Sea Level)  C                         as a real Fresh Water (=> changes the Sea Level)
295  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)
296    C- Pressure solver related parameters (PARM02)
297    C     useSRCGSolver  :: Set to true to use conjugate gradient
298    C                       solver with single reduction (only one call of
299    C                       s/r mpi_allreduce), default is false
300  C- Time-stepping params:  C- Time-stepping params:
301  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
302  C     implicitFreeSurface :: Set to true to use implicit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
# Line 298  C     allowFreezing  :: Allows surface w Line 333  C     allowFreezing  :: Allows surface w
333  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
334  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
335  C- I/O parameters -  C- I/O parameters -
336  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files.
337  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  C                       On some platforms with MPI, option globalFiles is either
338  C                       slow (f77) or does not work (f90).  When  C                       slow or does not work. Use useSingleCpuIO instead.
339  C                       useSingleCpuIO is set, mdsio_writefield.F  C     useSingleCpuIO :: moved to EEPARAMS.h
 C                       outputs from master mpi process only.  
340  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
341  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
342  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
# Line 316  C     snapshot_mdsio     :: use mdsio fo Line 350  C     snapshot_mdsio     :: use mdsio fo
350  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
351  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
352  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
353    C     debugMode       :: controls printing of debug msg (sequence of S/R calls).
354    
355        COMMON /PARM_L/        COMMON /PARM_L/
356       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
# Line 328  C                        & Last iteratio Line 363  C                        & Last iteratio
363       & momViscosity, momAdvection, momForcing,       & momViscosity, momAdvection, momForcing,
364       & momPressureForcing, metricTerms, useNHMTerms,       & momPressureForcing, metricTerms, useNHMTerms,
365       & useCoriolis, use3dCoriolis,       & useCoriolis, use3dCoriolis,
      & useConstantF, useBetaPlaneF, useSphereF,  
366       & useCDscheme, vectorInvariantMomentum,       & useCDscheme, vectorInvariantMomentum,
367       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
368       & upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
# Line 336  C                        & Last iteratio Line 370  C                        & Last iteratio
370       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
371       & tempAdvection, tempIsActiveTr, tempForcing,       & tempAdvection, tempIsActiveTr, tempForcing,
372       & saltAdvection, saltIsActiveTr, saltForcing,       & saltAdvection, saltIsActiveTr, saltForcing,
373         & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
374       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
375       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
376       & uniformLin_PhiSurf,       & uniformLin_PhiSurf,
# Line 349  C                        & Last iteratio Line 384  C                        & Last iteratio
384       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
385       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
386       & periodicExternalForcing,       & periodicExternalForcing,
387       & globalFiles, useSingleCpuIO,       & globalFiles,
388       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
389       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
390       & writePickupAtEnd,       & writePickupAtEnd,
391       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
392       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast, debugMode,
393       & inAdMode, inAdTrue, inAdFalse, inAdExact       & inAdMode, inAdTrue, inAdFalse, inAdExact,
394         & useSRCGSolver
395    
396        LOGICAL fluidIsAir        LOGICAL fluidIsAir
397        LOGICAL fluidIsWater        LOGICAL fluidIsWater
# Line 384  C                        & Last iteratio Line 420  C                        & Last iteratio
420        LOGICAL saltAdvection        LOGICAL saltAdvection
421        LOGICAL saltIsActiveTr        LOGICAL saltIsActiveTr
422        LOGICAL saltForcing        LOGICAL saltForcing
423          LOGICAL maskIniTemp
424          LOGICAL maskIniSalt
425          LOGICAL checkIniTemp
426          LOGICAL checkIniSalt
427        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
428        LOGICAL useFullLeith        LOGICAL useFullLeith
429        LOGICAL useStrainTensionVisc        LOGICAL useStrainTensionVisc
# Line 402  C                        & Last iteratio Line 442  C                        & Last iteratio
442        LOGICAL tempStepping        LOGICAL tempStepping
443        LOGICAL saltStepping        LOGICAL saltStepping
444        LOGICAL metricTerms        LOGICAL metricTerms
       LOGICAL useConstantF  
       LOGICAL useBetaPlaneF  
       LOGICAL useSphereF  
445        LOGICAL use3dCoriolis        LOGICAL use3dCoriolis
446        LOGICAL useCDscheme        LOGICAL useCDscheme
447        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
# Line 432  C                        & Last iteratio Line 469  C                        & Last iteratio
469        LOGICAL useOldFreezing        LOGICAL useOldFreezing
470        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
471        LOGICAL globalFiles        LOGICAL globalFiles
       LOGICAL useSingleCpuIO  
472        LOGICAL pickupStrictlyMatch        LOGICAL pickupStrictlyMatch
473        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
474        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
# Line 443  C                        & Last iteratio Line 479  C                        & Last iteratio
479        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
480        LOGICAL debugMode        LOGICAL debugMode
481        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
482          LOGICAL useSRCGSolver
483    
484  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
485  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 477  C     rhoConst  :: Vertically constant r Line 514  C     rhoConst  :: Vertically constant r
514  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
515  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
516  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
517    C     rho1Ref   :: reference vertical profile for density
518  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
519  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
520  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
# Line 497  C     rUnit2mass :: units conversion fac Line 535  C     rUnit2mass :: units conversion fac
535  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].
536  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
537  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
538  C     phiMin    :: Latitude of southern most cell face.  C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
539  C     thetaMin  :: Longitude of western most cell face (this  C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
540  C                 is an "inert" parameter but it is included  C                :: parameter but it makes geographical references simple.)
541  C                 to make geographical references simple.)  C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
542  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).  C                :: most face (Lat-Lon grid).
543    C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
544  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
545  C     f0        :: Reference coriolis parameter ( 1/s )  C     f0         :: Reference coriolis parameter ( 1/s )
546  C                 ( Southern edge f for beta plane )  C                   ( Southern edge f for beta plane )
547  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta       :: df/dy ( s^-1.m^-1 )
548  C     omega     :: Angular velocity ( rad/s )  C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
549    C                   of rotation (reference value = 2.Omega.Cos(Phi))
550    C     omega      :: Angular velocity ( rad/s )
551  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
552  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
553  C                 momentum vertically ( units of r^2/s )  C                   for vertical mixing of momentum ( units of r^2/s )
554  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh     :: Eddy viscosity coeff. for mixing of
555  C                 momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
556  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
557  C                 momentum laterally, no effect for hydrostatic  C                   momentum laterally, no effect for hydrostatic
558  C                 model, defaults to viscAh if unset ( m^2/s )  C                   model, defaults to viscAh if unset ( m^2/s )
559  C                 Not used if variable horiz. viscosity is used.  C                   Not used if variable horiz. viscosity is used.
560  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4     :: Biharmonic viscosity coeff. for mixing of
561  C                 momentum laterally ( m^4/s )  C                   momentum laterally ( m^4/s )
562  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical  C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
563  C                 momentum laterally, no effect for hydrostatic  C                   momentum laterally, no effect for hydrostatic
564  C                 model, defaults to viscA4 if unset ( m^2/s )  C                   model, defaults to viscA4 if unset ( m^2/s )
565  C                 Not used if variable horiz. viscosity is used.  C                   Not used if variable horiz. viscosity is used.
566  C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
567  C                  (act on Divergence part) ( m^2/s )  C                   (act on Divergence part) ( m^2/s )
568  C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhZ    :: Eddy viscosity coeff. for mixing of momentum laterally
569  C                  (act on Vorticity  part) ( m^2/s )  C                   (act on Vorticity  part) ( m^2/s )
570  C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4D    :: Biharmonic viscosity coeff. for mixing of momentum laterally
571  C                  (act on Divergence part) ( m^4/s )  C                   (act on Divergence part) ( m^4/s )
572  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
573  C                  (act on Vorticity  part) ( m^4/s )  C                   (act on Vorticity  part) ( m^4/s )
574  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
575  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
576  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
# Line 592  C     implicSurfPress :: parameter of th Line 633  C     implicSurfPress :: parameter of th
633  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
634  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
635  C                     Implicit part of barotropic flow Divergence ( 0-1 )  C                     Implicit part of barotropic flow Divergence ( 0-1 )
636    C     implicitNHPress :: parameter of the Crank-Nickelson time stepping :
637    C                     Implicit part of Non-Hydrostatic Pressure Gradient ( 0-1 )
638  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
639  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    :: Minimum dimensional size of a cell (affects hFacC etc..., m)
640  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    :: Minimum dimensional size of a cell (affects hFacC etc..., Pa)
641  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)
642  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
643  C     hFacSup        that control vanishing and creating levels  C     hFacSup          that control vanishing and creating levels
644  C     tauCD        :: CD scheme coupling timescale ( 1/s )  C     tauCD         :: CD scheme coupling timescale ( s )
645  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )  C     rCD           :: CD scheme normalised coupling parameter (= 1 - deltaT/tauCD)
646    C     epsAB_CD      :: Adams-Bashforth-2 stabilizing weight used in CD scheme
647  C     baseTime      :: model base time (time origin) = time @ iteration zero  C     baseTime      :: model base time (time origin) = time @ iteration zero
648  C     startTime     :: Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
649  C     endTime       :: Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
# Line 635  C     convertFW2Salt :: salinity, used t Line 679  C     convertFW2Salt :: salinity, used t
679  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
680  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
681  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
682    C     temp_addMass :: temperature of addMass array
683    C     salt_addMass :: salinity of addMass array
684  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
685  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
686  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
687  C     hMixCrit    :: criteria for mixed-layer diagnostic  C     hMixCriteria:: criteria for mixed-layer diagnostic
688    C     dRhoSmall   :: parameter for mixed-layer diagnostic
689    C     hMixSmooth  :: Smoothing parameter for mixed-layer diag (default=0=no smoothing)
690  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
691  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
692  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
693    C     rSigmaBnd   :: vertical position (in r-unit) of r/sigma transition (Hybrid-Sigma)
694  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
695  C                           (default=2: full drag ; =1: gives half-slip BC)  C                           (default=2: full drag ; =1: gives half-slip BC)
696  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
# Line 660  C     psiEuler      :: Euler angle, rota Line 709  C     psiEuler      :: Euler angle, rota
709       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
710       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
711       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
712       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & xgOrigin, ygOrigin, rSphere, recip_rSphere,
713       & viscAh, viscAhW, viscAhMax,       & f0, beta, fPrime, omega, rotationPeriod,
714         & viscFacAdj, viscAh, viscAhW, viscAhMax,
715       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
716       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
717       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
# Line 669  C     psiEuler      :: Euler angle, rota Line 719  C     psiEuler      :: Euler angle, rota
719       & viscA4, viscA4W, viscA4Max,       & viscA4, viscA4W, viscA4Max,
720       & viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Grid, viscA4GridMax, viscA4GridMin,
721       & viscAhReMax, viscA4ReMax,       & viscAhReMax, viscA4ReMax,
722       & viscC4leith, viscC4leithD, viscAr,       & viscC4leith, viscC4leithD, viscArNr,
723       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
724       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
725       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
726       & BL79LatVary,       & BL79LatVary,
727       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
728       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & tauCD, rCD, epsAB_CD,
729         & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
730       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
731       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
732       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
733       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
734       & rhoConstFresh, tRef, sRef, phiRef, dBdrRef,       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
735       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
736       & baseTime, startTime, endTime,       & baseTime, startTime, endTime,
737       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
738       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
739       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
740       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq,
741       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
742       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
743       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
744       & hFacMinDr, hFacMinDp,       & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
745       & ivdc_kappa, hMixCriteria, Ro_SeaLevel,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth,
746         & Ro_SeaLevel, rSigmaBnd,
747       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
748       & smoothAbsFuncRange,       & smoothAbsFuncRange,
749       & tCylIn, tCylOut,       & tCylIn, tCylOut,
# Line 711  C     psiEuler      :: Euler angle, rota Line 763  C     psiEuler      :: Euler angle, rota
763        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
764        _RL deltaTfreesurf        _RL deltaTfreesurf
765        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
766        _RL phiMin        _RL xgOrigin
767        _RL thetaMin        _RL ygOrigin
768        _RL rSphere        _RL rSphere
769        _RL recip_rSphere        _RL recip_rSphere
770        _RL f0        _RL f0
771          _RL beta
772          _RL fPrime
773          _RL omega
774          _RL rotationPeriod
775        _RL freeSurfFac        _RL freeSurfFac
776        _RL implicSurfPress        _RL implicSurfPress
777        _RL implicDiv2Dflow        _RL implicDiv2Dflow
778          _RL implicitNHPress
779        _RL hFacMin        _RL hFacMin
780        _RL hFacMinDz        _RL hFacMinDz
781        _RL hFacMinDp        _RL hFacMinDp
782        _RL hFacMinDr        _RL hFacMinDr
783        _RL hFacInf        _RL hFacInf
784        _RL hFacSup        _RL hFacSup
785        _RL beta        _RL viscArNr(Nr)
786        _RL viscAr        _RL viscFacAdj
787        _RL viscAh        _RL viscAh
788        _RL viscAhW        _RL viscAhW
789        _RL viscAhD        _RL viscAhD
# Line 762  C     psiEuler      :: Euler angle, rota Line 819  C     psiEuler      :: Euler angle, rota
819        _RL diffKrBLEQdeep        _RL diffKrBLEQdeep
820        _RL diffKrBLEQscl        _RL diffKrBLEQscl
821        _RL diffKrBLEQHo        _RL diffKrBLEQHo
822        _RL delt        _RL tauCD, rCD, epsAB_CD
       _RL tauCD  
       _RL rCD  
823        _RL gravity        _RL gravity
824        _RL recip_gravity        _RL recip_gravity
825        _RL gBaro        _RL gBaro
# Line 773  C     psiEuler      :: Euler angle, rota Line 828  C     psiEuler      :: Euler angle, rota
828        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
829        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
830        _RL rhoConstFresh        _RL rhoConstFresh
831          _RL rho1Ref(Nr)
832        _RL tRef(Nr)        _RL tRef(Nr)
833        _RL sRef(Nr)        _RL sRef(Nr)
834        _RL phiRef(2*Nr+1)        _RL phiRef(2*Nr+1)
# Line 799  C     psiEuler      :: Euler angle, rota Line 855  C     psiEuler      :: Euler angle, rota
855        _RL mtFacMom        _RL mtFacMom
856        _RL cosPower        _RL cosPower
857        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
       _RL rotationPeriod  
858        _RL tauThetaClimRelax        _RL tauThetaClimRelax
859        _RL tauSaltClimRelax        _RL tauSaltClimRelax
860        _RL latBandClimRelax        _RL latBandClimRelax
# Line 809  C     psiEuler      :: Euler angle, rota Line 863  C     psiEuler      :: Euler angle, rota
863        _RL convertFW2Salt        _RL convertFW2Salt
864        _RL temp_EvPrRn        _RL temp_EvPrRn
865        _RL salt_EvPrRn        _RL salt_EvPrRn
866          _RL temp_addMass
867          _RL salt_addMass
868        _RL ivdc_kappa        _RL ivdc_kappa
869        _RL hMixCriteria        _RL hMixCriteria
870          _RL dRhoSmall
871          _RL hMixSmooth
872        _RL Ro_SeaLevel        _RL Ro_SeaLevel
873          _RL rSigmaBnd
874        _RL sideDragFactor        _RL sideDragFactor
875        _RL bottomDragLinear        _RL bottomDragLinear
876        _RL bottomDragQuadratic        _RL bottomDragQuadratic
# Line 864  C Logical flags for selecting packages Line 923  C Logical flags for selecting packages
923        LOGICAL useEBM        LOGICAL useEBM
924        LOGICAL useCheapAML        LOGICAL useCheapAML
925        LOGICAL useGrdchk        LOGICAL useGrdchk
926          LOGICAL useSMOOTH
927        LOGICAL useECCO        LOGICAL useECCO
928        LOGICAL useSBO        LOGICAL useSBO
929        LOGICAL useFLT        LOGICAL useFLT
# Line 875  C Logical flags for selecting packages Line 935  C Logical flags for selecting packages
935        LOGICAL useSEAICE        LOGICAL useSEAICE
936        LOGICAL useSALT_PLUME        LOGICAL useSALT_PLUME
937        LOGICAL useShelfIce        LOGICAL useShelfIce
938          LOGICAL useICEFRONT
939        LOGICAL useThSIce        LOGICAL useThSIce
940        LOGICAL useATM2d        LOGICAL useATM2d
941        LOGICAL useAIM        LOGICAL useAIM
# Line 883  C Logical flags for selecting packages Line 944  C Logical flags for selecting packages
944        LOGICAL useGridAlt        LOGICAL useGridAlt
945        LOGICAL useDiagnostics        LOGICAL useDiagnostics
946        LOGICAL useREGRID        LOGICAL useREGRID
947          LOGICAL useLayers
948        LOGICAL useMNC        LOGICAL useMNC
949        LOGICAL useRunClock        LOGICAL useRunClock
950        LOGICAL useEMBED_FILES        LOGICAL useEMBED_FILES
# Line 892  C Logical flags for selecting packages Line 954  C Logical flags for selecting packages
954       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
955       &        useGMRedi, useDOWN_SLOPE,       &        useGMRedi, useDOWN_SLOPE,
956       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
957       &        useGrdchk, useECCO, useSBO, useFLT,       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,
958       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
959       &        useSEAICE, useSALT_PLUME, useShelfIce, useThSIce,       &        useSEAICE, useSALT_PLUME, useShelfIce,
960         &        useICEFRONT, useThSIce,
961       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
962       &        useDiagnostics, useREGRID, useMNC,       &        useDiagnostics, useREGRID, useLayers, useMNC,
963       &        useRunClock, useEMBED_FILES,       &        useRunClock, useEMBED_FILES,
964       &        useMYPACKAGE       &        useMYPACKAGE
965  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
Legend:
Removed from v.1.220  
changed lines
  Added in v.1.244
  ViewVC Help
Powered by ViewVC 1.1.22