/[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.237 by dimitri, Mon Apr 26 20:37:02 2010 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 79  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,       &                bathyFile, topoFile,
86       &                viscAhDfile, viscAhZfile,       &                viscAhDfile, viscAhZfile,
87       &                viscA4Dfile, viscA4Zfile,       &                viscA4Dfile, viscA4Zfile,
88       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
89       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
90       &                saltClimFile,       &                saltClimFile,
# Line 103  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
# Line 149  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
# Line 170  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 180  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,       &        selectNHfreeSurf,
196       &        selectAddFluid,       &        selectAddFluid,
# Line 199  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        INTEGER selectNHfreeSurf
# Line 252  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 323  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 341  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 353  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 375  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,
# Line 433  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 463  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 540  C     recip_rSphere  :: Reciprocal radiu Line 545  C     recip_rSphere  :: Reciprocal radiu
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     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 )  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     viscArNr   :: vertical profile of Eddy viscosity coeff.  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
# Line 683  C     hMixSmooth  :: Smoothing parameter Line 690  C     hMixSmooth  :: Smoothing parameter
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 701  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       & xgOrigin, ygOrigin, 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 728  C     psiEuler      :: Euler angle, rota Line 737  C     psiEuler      :: Euler angle, rota
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       & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,       & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
745       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, 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 758  C     psiEuler      :: Euler angle, rota Line 768  C     psiEuler      :: Euler angle, rota
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
# Line 768  C     psiEuler      :: Euler angle, rota Line 782  C     psiEuler      :: Euler angle, rota
782        _RL hFacMinDr        _RL hFacMinDr
783        _RL hFacInf        _RL hFacInf
784        _RL hFacSup        _RL hFacSup
       _RL beta  
785        _RL viscArNr(Nr)        _RL viscArNr(Nr)
786          _RL viscFacAdj
787        _RL viscAh        _RL viscAh
788        _RL viscAhW        _RL viscAhW
789        _RL viscAhD        _RL viscAhD
# Line 841  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 858  C     psiEuler      :: Euler angle, rota Line 870  C     psiEuler      :: Euler angle, rota
870        _RL dRhoSmall        _RL dRhoSmall
871        _RL hMixSmooth        _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
Legend:
Removed from v.1.237  
changed lines
  Added in v.1.244
  ViewVC Help
Powered by ViewVC 1.1.22