/[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.240 by mlosch, Sat Sep 25 23:09:54 2010 UTC revision 1.245 by mlosch, Mon Dec 6 10:45:51 2010 UTC
# Line 33  C     pickupSuff      :: force to start Line 33  C     pickupSuff      :: force to start
33  C                        and read pickup files with this suffix (max 10 Char.)  C                        and read pickup files with this suffix (max 10 Char.)
34  C     mdsioLocalDir   :: read-write tiled file from/to this directory name  C     mdsioLocalDir   :: read-write tiled file from/to this directory name
35  C                        (+ 4 digits Processor-Rank) instead of current dir.  C                        (+ 4 digits Processor-Rank) instead of current dir.
36    C     adTapeDir       :: read-write checkpointing tape files from/to this
37    C                        directory name instead of current dir. Conflicts
38    C                        mdsioLocalDir, so only one of the two can be set.
39    C                        In contrast to mdsioLocalDir, if specified adTapeDir
40    C                        must exist before the model starts.
41  C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)  C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
42  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
43  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
# Line 78  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, hybSigmFile,       &                delRFile, delRcFile, hybSigmFile,
89       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
# Line 99  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
# Line 151  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:  C     selectNHfreeSurf    :: option for Non-Hydrostatic (free-)Surface formulation:
171  C                           =0 (default) hydrostatic surf. ; > 0 add NH effects.  C                           =0 (default) hydrostatic surf. ; > 0 add NH effects.
 C     selectSigmaCoord    :: option related to sigma vertical coordinate  
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 173  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 183  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,       &        selectNHfreeSurf,
      &        selectSigmaCoord,  
202       &        selectAddFluid,       &        selectAddFluid,
203       &        momForcingOutAB, tracForcingOutAB,       &        momForcingOutAB, tracForcingOutAB,
204       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
# Line 203  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        INTEGER selectNHfreeSurf
       INTEGER selectSigmaCoord  
224        INTEGER selectAddFluid        INTEGER selectAddFluid
225        INTEGER momForcingOutAB, tracForcingOutAB        INTEGER momForcingOutAB, tracForcingOutAB
226        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
# Line 257  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 345  C     snapshot_mdsio     :: use mdsio fo Line 356  C     snapshot_mdsio     :: use mdsio fo
356  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
357  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
358  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
359    C     debugMode       :: controls printing of debug msg (sequence of S/R calls).
360    
361        COMMON /PARM_L/        COMMON /PARM_L/
362       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
# Line 357  C                        & Last iteratio Line 369  C                        & Last iteratio
369       & momViscosity, momAdvection, momForcing,       & momViscosity, momAdvection, momForcing,
370       & momPressureForcing, metricTerms, useNHMTerms,       & momPressureForcing, metricTerms, useNHMTerms,
371       & useCoriolis, use3dCoriolis,       & useCoriolis, use3dCoriolis,
      & useConstantF, useBetaPlaneF, useSphereF,  
372       & useCDscheme, vectorInvariantMomentum,       & useCDscheme, vectorInvariantMomentum,
373       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
374       & upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
# Line 437  C                        & Last iteratio Line 448  C                        & Last iteratio
448        LOGICAL tempStepping        LOGICAL tempStepping
449        LOGICAL saltStepping        LOGICAL saltStepping
450        LOGICAL metricTerms        LOGICAL metricTerms
       LOGICAL useConstantF  
       LOGICAL useBetaPlaneF  
       LOGICAL useSphereF  
451        LOGICAL use3dCoriolis        LOGICAL use3dCoriolis
452        LOGICAL useCDscheme        LOGICAL useCDscheme
453        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
# Line 543  C     recip_rSphere  :: Reciprocal radiu Line 551  C     recip_rSphere  :: Reciprocal radiu
551  C     f0         :: Reference coriolis parameter ( 1/s )  C     f0         :: Reference coriolis parameter ( 1/s )
552  C                   ( Southern edge f for beta plane )  C                   ( Southern edge f for beta plane )
553  C     beta       :: df/dy ( s^-1.m^-1 )  C     beta       :: df/dy ( s^-1.m^-1 )
554    C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
555    C                   of rotation (reference value = 2.Omega.Cos(Phi))
556  C     omega      :: Angular velocity ( rad/s )  C     omega      :: Angular velocity ( rad/s )
557  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
558  C     viscArNr   :: vertical profile of Eddy viscosity coeff.  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
# Line 705  C     psiEuler      :: Euler angle, rota Line 715  C     psiEuler      :: Euler angle, rota
715       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
716       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
717       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
718       & xgOrigin, ygOrigin, rSphere, recip_RSphere, f0, beta,       & xgOrigin, ygOrigin, rSphere, recip_rSphere,
719       & viscAh, viscAhW, viscAhMax,       & f0, beta, fPrime, omega, rotationPeriod,
720         & viscFacAdj, viscAh, viscAhW, viscAhMax,
721       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
722       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
723       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
# Line 732  C     psiEuler      :: Euler angle, rota Line 743  C     psiEuler      :: Euler angle, rota
743       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
744       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
745       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
746       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq,
747       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
748       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
749       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
# Line 763  C     psiEuler      :: Euler angle, rota Line 774  C     psiEuler      :: Euler angle, rota
774        _RL rSphere        _RL rSphere
775        _RL recip_rSphere        _RL recip_rSphere
776        _RL f0        _RL f0
777          _RL beta
778          _RL fPrime
779          _RL omega
780          _RL rotationPeriod
781        _RL freeSurfFac        _RL freeSurfFac
782        _RL implicSurfPress        _RL implicSurfPress
783        _RL implicDiv2Dflow        _RL implicDiv2Dflow
# Line 773  C     psiEuler      :: Euler angle, rota Line 788  C     psiEuler      :: Euler angle, rota
788        _RL hFacMinDr        _RL hFacMinDr
789        _RL hFacInf        _RL hFacInf
790        _RL hFacSup        _RL hFacSup
       _RL beta  
791        _RL viscArNr(Nr)        _RL viscArNr(Nr)
792          _RL viscFacAdj
793        _RL viscAh        _RL viscAh
794        _RL viscAhW        _RL viscAhW
795        _RL viscAhD        _RL viscAhD
# Line 846  C     psiEuler      :: Euler angle, rota Line 861  C     psiEuler      :: Euler angle, rota
861        _RL mtFacMom        _RL mtFacMom
862        _RL cosPower        _RL cosPower
863        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
       _RL rotationPeriod  
864        _RL tauThetaClimRelax        _RL tauThetaClimRelax
865        _RL tauSaltClimRelax        _RL tauSaltClimRelax
866        _RL latBandClimRelax        _RL latBandClimRelax
# Line 941  C Logical flags for selecting packages Line 954  C Logical flags for selecting packages
954        LOGICAL useMNC        LOGICAL useMNC
955        LOGICAL useRunClock        LOGICAL useRunClock
956        LOGICAL useEMBED_FILES        LOGICAL useEMBED_FILES
       LOGICAL useOASIS  
957        LOGICAL useMYPACKAGE        LOGICAL useMYPACKAGE
958        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
959       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
# Line 955  C Logical flags for selecting packages Line 967  C Logical flags for selecting packages
967       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
968       &        useDiagnostics, useREGRID, useLayers, useMNC,       &        useDiagnostics, useREGRID, useLayers, useMNC,
969       &        useRunClock, useEMBED_FILES,       &        useRunClock, useEMBED_FILES,
      &        useOASIS,  
970       &        useMYPACKAGE       &        useMYPACKAGE
971    
972  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
973  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
974  CEH3 ;;; End: ***  CEH3 ;;; End: ***
Legend:
Removed from v.1.240  
changed lines
  Added in v.1.245
  ViewVC Help
Powered by ViewVC 1.1.22