/[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.238 by jmc, Sat May 22 23:45:18 2010 UTC
# Line 51  C                        for potential t Line 51  C                        for potential t
51  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
52  C                        for salinity.  C                        for salinity.
53  C     diffKrFile      :: File containing 3D specification of vertical diffusivity  C     diffKrFile      :: File containing 3D specification of vertical diffusivity
54    C     viscAhDfile     :: File containing 3D specification of horizontal viscosity
55    C     viscAhZfile     :: File containing 3D specification of horizontal viscosity
56    C     viscA4Dfile     :: File containing 3D specification of horizontal viscosity
57    C     viscA4Zfile     :: File containing 3D specification of horizontal viscosity
58  C     zonalWindFile   :: File containing zonal wind data  C     zonalWindFile   :: File containing zonal wind data
59  C     meridWindFile   :: File containing meridional wind data  C     meridWindFile   :: File containing meridional wind data
60  C     thetaClimFile   :: File containing surface theta climataology used  C     thetaClimFile   :: File containing surface theta climataology used
# Line 78  C     the_run_name    :: string identify Line 82  C     the_run_name    :: string identify
82       &                delRFile, delRcFile,       &                delRFile, delRcFile,
83       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
84       &                bathyFile, topoFile,       &                bathyFile, topoFile,
85         &                viscAhDfile, viscAhZfile,
86         &                viscA4Dfile, viscA4Zfile,
87       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
88       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
89       &                saltClimFile,       &                saltClimFile,
# Line 103  C     the_run_name    :: string identify Line 109  C     the_run_name    :: string identify
109        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
110        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
111        CHARACTER*(MAX_LEN_FNAM) diffKrFile        CHARACTER*(MAX_LEN_FNAM) diffKrFile
112          CHARACTER*(MAX_LEN_FNAM) viscAhDfile
113          CHARACTER*(MAX_LEN_FNAM) viscAhZfile
114          CHARACTER*(MAX_LEN_FNAM) viscA4Dfile
115          CHARACTER*(MAX_LEN_FNAM) viscA4Zfile
116        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
117        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
118        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
# Line 143  C     nonlinFreeSurf      :: option rela Line 153  C     nonlinFreeSurf      :: option rela
153  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
154  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
155  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
156    C     selectNHfreeSurf    :: option for Non-Hydrostatic (free-)Surface formulation:
157    C                           =0 (default) hydrostatic surf. ; > 0 add NH effects.
158  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
159  C                            (3-D generalisation of oceanic real-fresh water flux)  C                            (3-D generalisation of oceanic real-fresh water flux)
160  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 169  C     debugLevel          :: debug level Line 181  C     debugLevel          :: debug level
181       &        writeStatePrec,       &        writeStatePrec,
182       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
183       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
184         &        selectNHfreeSurf,
185       &        selectAddFluid,       &        selectAddFluid,
186       &        momForcingOutAB, tracForcingOutAB,       &        momForcingOutAB, tracForcingOutAB,
187       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
# Line 188  C     debugLevel          :: debug level Line 201  C     debugLevel          :: debug level
201        INTEGER readBinaryPrec        INTEGER readBinaryPrec
202        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
203        INTEGER select_rStar        INTEGER select_rStar
204          INTEGER selectNHfreeSurf
205        INTEGER selectAddFluid        INTEGER selectAddFluid
206        INTEGER momForcingOutAB, tracForcingOutAB        INTEGER momForcingOutAB, tracForcingOutAB
207        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
# Line 269  C     checkIniSalt   :: check for points Line 283  C     checkIniSalt   :: check for points
283  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
284  C                         as a real Fresh Water (=> changes the Sea Level)  C                         as a real Fresh Water (=> changes the Sea Level)
285  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)
286    C- Pressure solver related parameters (PARM02)
287    C     useSRCGSolver  :: Set to true to use conjugate gradient
288    C                       solver with single reduction (only one call of
289    C                       s/r mpi_allreduce), default is false
290  C- Time-stepping params:  C- Time-stepping params:
291  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
292  C     implicitFreeSurface :: Set to true to use implicit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
# Line 305  C     allowFreezing  :: Allows surface w Line 323  C     allowFreezing  :: Allows surface w
323  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
324  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
325  C- I/O parameters -  C- I/O parameters -
326  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files.
327  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  C                       On some platforms with MPI, option globalFiles is either
328  C                       slow (f77) or does not work (f90).  When  C                       slow or does not work. Use useSingleCpuIO instead.
329  C                       useSingleCpuIO is set, mdsio_writefield.F  C     useSingleCpuIO :: moved to EEPARAMS.h
 C                       outputs from master mpi process only.  
330  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
331  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
332  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
# Line 357  C                        & Last iteratio Line 374  C                        & Last iteratio
374       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
375       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
376       & periodicExternalForcing,       & periodicExternalForcing,
377       & globalFiles, useSingleCpuIO,       & globalFiles,
378       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
379       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
380       & writePickupAtEnd,       & writePickupAtEnd,
381       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
382       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast, debugMode,
383       & inAdMode, inAdTrue, inAdFalse, inAdExact       & inAdMode, inAdTrue, inAdFalse, inAdExact,
384         & useSRCGSolver
385    
386        LOGICAL fluidIsAir        LOGICAL fluidIsAir
387        LOGICAL fluidIsWater        LOGICAL fluidIsWater
# Line 444  C                        & Last iteratio Line 462  C                        & Last iteratio
462        LOGICAL useOldFreezing        LOGICAL useOldFreezing
463        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
464        LOGICAL globalFiles        LOGICAL globalFiles
       LOGICAL useSingleCpuIO  
465        LOGICAL pickupStrictlyMatch        LOGICAL pickupStrictlyMatch
466        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
467        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
# Line 455  C                        & Last iteratio Line 472  C                        & Last iteratio
472        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
473        LOGICAL debugMode        LOGICAL debugMode
474        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
475          LOGICAL useSRCGSolver
476    
477  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
478  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 606  C     implicSurfPress :: parameter of th Line 624  C     implicSurfPress :: parameter of th
624  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
625  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
626  C                     Implicit part of barotropic flow Divergence ( 0-1 )  C                     Implicit part of barotropic flow Divergence ( 0-1 )
627    C     implicitNHPress :: parameter of the Crank-Nickelson time stepping :
628    C                     Implicit part of Non-Hydrostatic Pressure Gradient ( 0-1 )
629  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
630  C     hFacMinDz    :: Minimum dimensional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    :: Minimum dimensional size of a cell (affects hFacC etc..., m)
631  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 670  C     convertFW2Salt :: salinity, used t
670  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
671  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
672  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
673    C     temp_addMass :: temperature of addMass array
674    C     salt_addMass :: salinity of addMass array
675  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
676  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
677  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 693  C     psiEuler      :: Euler angle, rota Line 715  C     psiEuler      :: Euler angle, rota
715       & BL79LatVary,       & BL79LatVary,
716       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
717       & tauCD, rCD, epsAB_CD,       & tauCD, rCD, epsAB_CD,
718       & freeSurfFac, implicSurfPress, implicDiv2Dflow,       & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
719       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
720       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
721       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
# Line 708  C     psiEuler      :: Euler angle, rota Line 730  C     psiEuler      :: Euler angle, rota
730       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
731       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
732       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
733       & hFacMinDr, hFacMinDp,       & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
734       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, Ro_SeaLevel,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, Ro_SeaLevel,
735       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
736       & smoothAbsFuncRange,       & smoothAbsFuncRange,
# Line 737  C     psiEuler      :: Euler angle, rota Line 759  C     psiEuler      :: Euler angle, rota
759        _RL freeSurfFac        _RL freeSurfFac
760        _RL implicSurfPress        _RL implicSurfPress
761        _RL implicDiv2Dflow        _RL implicDiv2Dflow
762          _RL implicitNHPress
763        _RL hFacMin        _RL hFacMin
764        _RL hFacMinDz        _RL hFacMinDz
765        _RL hFacMinDp        _RL hFacMinDp
# Line 826  C     psiEuler      :: Euler angle, rota Line 849  C     psiEuler      :: Euler angle, rota
849        _RL convertFW2Salt        _RL convertFW2Salt
850        _RL temp_EvPrRn        _RL temp_EvPrRn
851        _RL salt_EvPrRn        _RL salt_EvPrRn
852          _RL temp_addMass
853          _RL salt_addMass
854        _RL ivdc_kappa        _RL ivdc_kappa
855        _RL hMixCriteria        _RL hMixCriteria
856        _RL dRhoSmall        _RL dRhoSmall
# Line 895  C Logical flags for selecting packages Line 920  C Logical flags for selecting packages
920        LOGICAL useSEAICE        LOGICAL useSEAICE
921        LOGICAL useSALT_PLUME        LOGICAL useSALT_PLUME
922        LOGICAL useShelfIce        LOGICAL useShelfIce
923          LOGICAL useICEFRONT
924        LOGICAL useThSIce        LOGICAL useThSIce
925        LOGICAL useATM2d        LOGICAL useATM2d
926        LOGICAL useAIM        LOGICAL useAIM
# Line 915  C Logical flags for selecting packages Line 941  C Logical flags for selecting packages
941       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
942       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,
943       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
944       &        useSEAICE, useSALT_PLUME, useShelfIce, useThSIce,       &        useSEAICE, useSALT_PLUME, useShelfIce,
945         &        useICEFRONT, useThSIce,
946       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
947       &        useDiagnostics, useREGRID, useLayers, useMNC,       &        useDiagnostics, useREGRID, useLayers, useMNC,
948       &        useRunClock, useEMBED_FILES,       &        useRunClock, useEMBED_FILES,
Legend:
Removed from v.1.231  
changed lines
  Added in v.1.238
  ViewVC Help
Powered by ViewVC 1.1.22