/[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.216 by jmc, Sat Apr 5 18:09:30 2008 UTC revision 1.226 by dfer, Fri Nov 14 03:06:11 2008 UTC
# Line 24  C     Useful physical values Line 24  C     Useful physical values
24        Real*8 deg2rad        Real*8 deg2rad
25        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
26    
 C     Symbolic values  
 C     precXXXX :: Used to indicate what precision to use for  
 C                dumping model state.  
       INTEGER precFloat32  
       PARAMETER ( precFloat32 = 32 )  
       INTEGER precFloat64  
       PARAMETER ( precFloat64 = 64 )  
 C     UNSET_xxx :: Used to indicate variables that have not been given a value  
       Real*8 UNSET_FLOAT8  
       PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )  
       Real*4 UNSET_FLOAT4  
       PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )  
       _RL    UNSET_RL  
       PARAMETER ( UNSET_RL     = 1.234567D5 )  
       _RS    UNSET_RS  
       PARAMETER ( UNSET_RS     = 1.234567E5 )  
       INTEGER UNSET_I  
       PARAMETER ( UNSET_I      = 123456789  )  
   
27  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
28  C     buoyancyRelation :: Flag used to indicate which relation to use to  C     buoyancyRelation :: Flag used to indicate which relation to use to
29  C                         get buoyancy.  C                         get buoyancy.
# Line 65  C     bathyFile       :: File containing Line 46  C     bathyFile       :: File containing
46  C                        is taken from inline function.  C                        is taken from inline function.
47  C     topoFile        :: File containing the topography of the surface (unit=m)  C     topoFile        :: File containing the topography of the surface (unit=m)
48  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)  
49  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
50  C                        for potential temperature.  C                        for potential temperature.
51  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
# Line 89  C                 m/s when using externa Line 68  C                 m/s when using externa
68  C                 to kg/m2/s by multiplying by rhoConstFresh.  C                 to kg/m2/s by multiplying by rhoConstFresh.
69  C     saltFluxFile    :: File containing surface salt flux  C     saltFluxFile    :: File containing surface salt flux
70  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
71  C     eddyTauxFile    :: File containing zonal Eddy stress data  C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data
72  C     eddyTauyFile    :: File containing meridional Eddy stress data  C     eddyPsiYFile    :: File containing meridional Eddy streamfunction data
73  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
74        COMMON /PARM_C/        COMMON /PARM_C/
75       &                buoyancyRelation, eosType,       &                buoyancyRelation, eosType,
# Line 98  C     the_run_name    :: string identify Line 77  C     the_run_name    :: string identify
77       &                tRefFile, sRefFile, rhoRefFile,       &                tRefFile, sRefFile, rhoRefFile,
78       &                delRFile, delRcFile,       &                delRFile, delRcFile,
79       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
80       &                bathyFile, topoFile, shelfIceFile,       &                bathyFile, topoFile,
81       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
82       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
83       &                saltClimFile,       &                saltClimFile,
# Line 107  C     the_run_name    :: string identify Line 86  C     the_run_name    :: string identify
86       &                lambdaThetaFile, lambdaSaltFile,       &                lambdaThetaFile, lambdaSaltFile,
87       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
88       &                dQdTfile, ploadFile,       &                dQdTfile, ploadFile,
89       &                eddyTauxFile, eddyTauyFile,       &                eddyPsiXFile, eddyPsiYFile,
90       &                the_run_name       &                the_run_name
91        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
92        CHARACTER*(6)  eosType        CHARACTER*(6)  eosType
# Line 121  C     the_run_name    :: string identify Line 100  C     the_run_name    :: string identify
100        CHARACTER*(MAX_LEN_FNAM) delXFile        CHARACTER*(MAX_LEN_FNAM) delXFile
101        CHARACTER*(MAX_LEN_FNAM) delYFile        CHARACTER*(MAX_LEN_FNAM) delYFile
102        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
103        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
104        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
105        CHARACTER*(MAX_LEN_FNAM) diffKrFile        CHARACTER*(MAX_LEN_FNAM) diffKrFile
106        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
# Line 138  C     the_run_name    :: string identify Line 117  C     the_run_name    :: string identify
117        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
118        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
119        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) ploadFile
120        CHARACTER*(MAX_LEN_FNAM) eddyTauxFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile
121        CHARACTER*(MAX_LEN_FNAM) eddyTauyFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile
122        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
123        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile        CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
124        CHARACTER*(MAX_LEN_PREC/2) the_run_name        CHARACTER*(MAX_LEN_PREC/2) the_run_name
# Line 164  C     nonlinFreeSurf      :: option rela Line 143  C     nonlinFreeSurf      :: option rela
143  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
144  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
145  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
146    C     selectAddFluid      :: option to add mass source/sink of fluid in the interior
147    C                            (3-D generalisation of oceanic real-fresh water flux)
148    C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
149  C     momForcingOutAB     :: =1: take momentum forcing contribution  C     momForcingOutAB     :: =1: take momentum forcing contribution
150  C                           out of (=0: in) Adams-Bashforth time stepping.  C                           out of (=0: in) Adams-Bashforth time stepping.
151  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
# Line 187  C     debugLevel          :: debug level Line 169  C     debugLevel          :: debug level
169       &        writeStatePrec,       &        writeStatePrec,
170       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
171       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
172         &        selectAddFluid,
173       &        momForcingOutAB, tracForcingOutAB,       &        momForcingOutAB, tracForcingOutAB,
174       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
175       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
# Line 205  C     debugLevel          :: debug level Line 188  C     debugLevel          :: debug level
188        INTEGER readBinaryPrec        INTEGER readBinaryPrec
189        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
190        INTEGER select_rStar        INTEGER select_rStar
191          INTEGER selectAddFluid
192        INTEGER momForcingOutAB, tracForcingOutAB        INTEGER momForcingOutAB, tracForcingOutAB
193        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
194        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
# Line 213  C     debugLevel          :: debug level Line 197  C     debugLevel          :: debug level
197        INTEGER monitorSelect        INTEGER monitorSelect
198        INTEGER debugLevel        INTEGER debugLevel
199    
 C  
       INTEGER debLevZero  
       PARAMETER(debLevZero=0)  
       INTEGER debLevA  
       PARAMETER(debLevA=1)  
       INTEGER debLevB  
       PARAMETER(debLevB=2)  
   
200  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
201  C- Coordinate + Grid params:  C- Coordinate + Grid params:
202  C     fluidIsAir       :: Set to indicate that the fluid major constituent  C     fluidIsAir       :: Set to indicate that the fluid major constituent
# Line 504  C     rhoConst  :: Vertically constant r Line 480  C     rhoConst  :: Vertically constant r
480  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
481  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
482  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
483    C     rho1Ref   :: reference vertical profile for density
484  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
485  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
486  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
# Line 665  C     salt_EvPrRn :: salinity of Rain & Line 642  C     salt_EvPrRn :: salinity of Rain &
642  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
643  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
644  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
645  C     hMixCrit    :: criteria for mixed-layer diagnostic  C     hMixCriteria:: criteria for mixed-layer diagnostic
646    C     dRhoSmall   :: parameter for mixed-layer diagnostic
647    C     hMixSmooth  :: Smoothing parameter for mixed-layer diag (default=0=no smoothing)
648  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
649  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
650  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
# Line 707  C     psiEuler      :: Euler angle, rota Line 686  C     psiEuler      :: Euler angle, rota
686       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
687       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
688       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
689       & rhoConstFresh, tRef, sRef, phiRef, dBdrRef,       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
690       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
691       & baseTime, startTime, endTime,       & baseTime, startTime, endTime,
692       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
# Line 718  C     psiEuler      :: Euler angle, rota Line 697  C     psiEuler      :: Euler angle, rota
697       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
698       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
699       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
700       & ivdc_kappa, hMixCriteria, Ro_SeaLevel,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, Ro_SeaLevel,
701       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
702       & smoothAbsFuncRange,       & smoothAbsFuncRange,
703       & tCylIn, tCylOut,       & tCylIn, tCylOut,
# Line 800  C     psiEuler      :: Euler angle, rota Line 779  C     psiEuler      :: Euler angle, rota
779        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
780        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
781        _RL rhoConstFresh        _RL rhoConstFresh
782          _RL rho1Ref(Nr)
783        _RL tRef(Nr)        _RL tRef(Nr)
784        _RL sRef(Nr)        _RL sRef(Nr)
785        _RL phiRef(2*Nr+1)        _RL phiRef(2*Nr+1)
# Line 838  C     psiEuler      :: Euler angle, rota Line 818  C     psiEuler      :: Euler angle, rota
818        _RL salt_EvPrRn        _RL salt_EvPrRn
819        _RL ivdc_kappa        _RL ivdc_kappa
820        _RL hMixCriteria        _RL hMixCriteria
821          _RL dRhoSmall
822          _RL hMixSmooth
823        _RL Ro_SeaLevel        _RL Ro_SeaLevel
824        _RL sideDragFactor        _RL sideDragFactor
825        _RL bottomDragLinear        _RL bottomDragLinear
# Line 874  C             derived from the orography Line 856  C             derived from the orography
856        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
857    
858  C Logical flags for selecting packages  C Logical flags for selecting packages
859          LOGICAL useGAD
860          LOGICAL useOBCS
861          LOGICAL useSHAP_FILT
862          LOGICAL useZONAL_FILT
863        LOGICAL useOPPS        LOGICAL useOPPS
864        LOGICAL usePP81        LOGICAL usePP81
865        LOGICAL useMY82        LOGICAL useMY82
866        LOGICAL useGGL90        LOGICAL useGGL90
867        LOGICAL useKPP        LOGICAL useKPP
       LOGICAL useGAD  
868        LOGICAL useGMRedi        LOGICAL useGMRedi
869        LOGICAL useOBCS        LOGICAL useDOWN_SLOPE
       LOGICAL useAIM  
       LOGICAL useLand  
870        LOGICAL useCAL        LOGICAL useCAL
871        LOGICAL useEXF        LOGICAL useEXF
872          LOGICAL useBulkForce
873        LOGICAL useEBM        LOGICAL useEBM
874          LOGICAL useCheapAML
875        LOGICAL useGrdchk        LOGICAL useGrdchk
876        LOGICAL useECCO        LOGICAL useECCO
877        LOGICAL useSHAP_FILT        LOGICAL useSBO
       LOGICAL useZONAL_FILT  
878        LOGICAL useFLT        LOGICAL useFLT
879        LOGICAL usePTRACERS        LOGICAL usePTRACERS
880        LOGICAL useGCHEM        LOGICAL useGCHEM
881        LOGICAL useRBCS        LOGICAL useRBCS
882        LOGICAL useOffLine        LOGICAL useOffLine
883        LOGICAL useMATRIX        LOGICAL useMATRIX
       LOGICAL useSBO  
884        LOGICAL useSEAICE        LOGICAL useSEAICE
885          LOGICAL useSALT_PLUME
886        LOGICAL useShelfIce        LOGICAL useShelfIce
887        LOGICAL useThSIce        LOGICAL useThSIce
888        LOGICAL useATM2d        LOGICAL useATM2d
889        LOGICAL useBulkForce        LOGICAL useAIM
890        LOGICAL usefizhi        LOGICAL useLand
891        LOGICAL usegridalt        LOGICAL useFizhi
892          LOGICAL useGridAlt
893        LOGICAL useDiagnostics        LOGICAL useDiagnostics
       LOGICAL useMNC  
894        LOGICAL useREGRID        LOGICAL useREGRID
895          LOGICAL useMNC
896        LOGICAL useRunClock        LOGICAL useRunClock
897        LOGICAL useEMBED_FILES        LOGICAL useEMBED_FILES
898        LOGICAL useMYPACKAGE        LOGICAL useMYPACKAGE
       LOGICAL useSALT_PLUME  
899        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
900         &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
901       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
902       &        useGAD, useGMRedi, useOBCS, useAIM, useLand,       &        useGMRedi, useDOWN_SLOPE,
903       &        useCAL, useEXF, useEBM, useGrdchk, useECCO,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
904       &        useSHAP_FILT, useZONAL_FILT, useFLT,       &        useGrdchk, useECCO, useSBO, useFLT,
905       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
906       &        useSBO, useSEAICE, useShelfIce,       &        useSEAICE, useSALT_PLUME, useShelfIce, useThSIce,
907       &        useThSIce, useATM2D, useBulkForce,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
908       &        usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID,       &        useDiagnostics, useREGRID, useMNC,
909       &        useRunClock, useEMBED_FILES, useMYPACKAGE, useSALT_PLUME       &        useRunClock, useEMBED_FILES,
910         &        useMYPACKAGE
911  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
912  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
913  CEH3 ;;; End: ***  CEH3 ;;; End: ***
Legend:
Removed from v.1.216  
changed lines
  Added in v.1.226
  ViewVC Help
Powered by ViewVC 1.1.22