/[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.49 by jmc, Tue Feb 20 19:38:24 2001 UTC revision 1.58 by adcroft, Thu Aug 16 17:12:23 2001 UTC
# Line 47  C--   COMMON /PARM_C/ Character valued p Line 47  C--   COMMON /PARM_C/ Character valued p
47  C     checkPtSuff - List of checkpoint file suffices  C     checkPtSuff - List of checkpoint file suffices
48  C     bathyFile   - File containing bathymetry. If not defined bathymetry  C     bathyFile   - File containing bathymetry. If not defined bathymetry
49  C                   is taken from inline function.  C                   is taken from inline function.
50    C     topoFile    - File containing the topography of the surface (unit=m)
51    C                   (mainly used for the atmosphere = ground height).
52  C     hydrogThetaFile - File containing initial hydrographic data for potential  C     hydrogThetaFile - File containing initial hydrographic data for potential
53  C                       temperature.  C                       temperature.
54  C     hydrogSaltFile  - File containing initial hydrographic data for salinity.  C     hydrogSaltFile  - File containing initial hydrographic data for salinity.
# Line 58  C     saltClimFile    - File containing Line 60  C     saltClimFile    - File containing
60  C                       in relaxation term -lambda(salt-salt*)  C                       in relaxation term -lambda(salt-salt*)
61  C     surfQfile       - File containing surface heat flux  C     surfQfile       - File containing surface heat flux
62  C     surfQswfile     - File containing surface shortwave radiation  C     surfQswfile     - File containing surface shortwave radiation
63    C     dQdTfile        - File containing thermal relaxation coefficient
64  C     EmPmRfile       - File containing surface fresh water flux  C     EmPmRfile       - File containing surface fresh water flux
65  C     buoyancyRelation - Flag used to indicate which relation to use to  C     buoyancyRelation - Flag used to indicate which relation to use to
66  C                        get buoyancy.  C                        get buoyancy.
67        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
68       &                bathyFile, hydrogThetaFile, hydrogSaltFile,       &                bathyFile, topoFile,
69         &                hydrogThetaFile, hydrogSaltFile,
70       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
71       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
72       &                EmPmRfile, surfQfile, surfQswfile,       &                EmPmRfile, surfQfile, surfQswfile,
73       &                uVelInitFile, vVelInitFile, pSurfInitFile       &                uVelInitFile, vVelInitFile, pSurfInitFile,
74         &                dQdTfile
75        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
76        CHARACTER*(MAX_LEN_FNAM) bathyFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
77        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
78        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
79        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
# Line 82  C                        get buoyancy. Line 87  C                        get buoyancy.
87        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
88        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
89        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
90          CHARACTER*(MAX_LEN_FNAM) dQdTfile
91    
92  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
93  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        - Maximum number of iterations in the
# Line 100  C     writeStatePrec      - Precision us Line 106  C     writeStatePrec      - Precision us
106  C     writeBinaryPrec     - Precision used for writing binary files  C     writeBinaryPrec     - Precision used for writing binary files
107  C     readBinaryPrec      - Precision used for reading binary files  C     readBinaryPrec      - Precision used for reading binary files
108  C     nCheckLev           - Holds current checkpoint level  C     nCheckLev           - Holds current checkpoint level
109  C     nShap               - "Order" of shapiro filter to apply to  C     nonlinFreeSurf      - option related to non-linear free surface
110  C                           model prognositic fields.  C                           =0 Linear free surface ; >0 Non-linear
 C                           nShap == 1 => del2  
 C                           nShap == 2 => del4  
 C                           nShap == 3 => del6  
 C                           etc...  
111    
112        COMMON /PARM_I/        COMMON /PARM_I/
113       &        cg2dMaxIters,       &        cg2dMaxIters,
# Line 116  C                           etc... Line 118  C                           etc...
118       &        numStepsPerPickup,       &        numStepsPerPickup,
119       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
120       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
121       &        nShap, zonal_filt_sinpow, zonal_filt_cospow       &        nonlinFreeSurf,
122         &        zonal_filt_sinpow, zonal_filt_cospow,
123         &        tempAdvScheme, saltAdvScheme, tracerAdvScheme
124        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
125        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
126        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
# Line 129  C                           etc... Line 133  C                           etc...
133        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
134        INTEGER readBinaryPrec        INTEGER readBinaryPrec
135        INTEGER nCheckLev        INTEGER nCheckLev
136        INTEGER nShap        INTEGER nonlinFreeSurf
137        INTEGER zonal_filt_sinpow        INTEGER zonal_filt_sinpow
138        INTEGER zonal_filt_cospow        INTEGER zonal_filt_cospow
139          INTEGER tempAdvScheme
140          INTEGER saltAdvScheme
141          INTEGER tracerAdvScheme
142    
143  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
144  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian
# Line 162  C     saltAdvection - Flag which turns a Line 169  C     saltAdvection - Flag which turns a
169  C                     and off.  C                     and off.
170  C     saltForcing   - Flag which turns external forcing of salinit on  C     saltForcing   - Flag which turns external forcing of salinit on
171  C                     and off.  C                     and off.
 C     implicitFreeSurface - Set to true to use implcit free surface  
172  C     rigidLid            - Set to true to use rigid lid  C     rigidLid            - Set to true to use rigid lid
173    C     implicitFreeSurface - Set to true to use implcit free surface
174    C     exactConserv        - Set to true to conserve exactly the total Volume
175    C     uniformLin_PhiSurf  - Set to true to use a uniform Bo_surf in the
176    C                           linear relation Phi_surf = Bo_surf*eta
177  C     momStepping   - Turns momentum equation time-stepping off  C     momStepping   - Turns momentum equation time-stepping off
178  C     tempStepping  - Turns temperature equation time-stepping off  C     tempStepping  - Turns temperature equation time-stepping off
179  C     saltStepping  - Turns salinity equation time-stepping off  C     saltStepping  - Turns salinity equation time-stepping off
180    C     tr1Stepping   - Turns passive tracer 1 time-stepping on/off
181  C     useConstantF  - Coriolis parameter set to f0  C     useConstantF  - Coriolis parameter set to f0
182  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
183  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
# Line 186  C     globalFiles    - Selects between " Line 197  C     globalFiles    - Selects between "
197  C     allowFreezing  - Allows water to freeze and form ice  C     allowFreezing  - Allows water to freeze and form ice
198  C     groundAtK1  - put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  - put the surface(k=1) at the Lower Boundary (=ground)
199        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
200         & usingCurvilinearGrid,
201       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
202       & staggerTimeStep,       & staggerTimeStep,
203       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
204       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,       & momPressureForcing, vectorInvariantMomentum,
205         & tempDiffusion, tempAdvection, tempForcing,
206       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
207       & implicitFreeSurface, rigidLid,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
208       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping, tr1Stepping,
209       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
210       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
211       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
212       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
213       & periodicExternalForcing, usingPCoords, usingZCoords,       & periodicExternalForcing, usingPCoords, usingZCoords,
214       & nonHydrostatic, globalFiles,       & nonHydrostatic, globalFiles,
215       & allowFreezing, groundAtK1       & allowFreezing, groundAtK1,
216         & usePickupBeforeC35, debugMode,
217         & readPickupWithTracer, writePickupWithTracer
218        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
219        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
220          LOGICAL usingCurvilinearGrid
221        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
222        LOGICAL no_slip_sides        LOGICAL no_slip_sides
223        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
# Line 211  C     groundAtK1  - put the surface(k=1) Line 227  C     groundAtK1  - put the surface(k=1)
227        LOGICAL momForcing        LOGICAL momForcing
228        LOGICAL momPressureForcing        LOGICAL momPressureForcing
229        LOGICAL useCoriolis        LOGICAL useCoriolis
230          LOGICAL vectorInvariantMomentum
231        LOGICAL tempDiffusion        LOGICAL tempDiffusion
232        LOGICAL tempAdvection        LOGICAL tempAdvection
233        LOGICAL tempForcing        LOGICAL tempForcing
234        LOGICAL saltDiffusion        LOGICAL saltDiffusion
235        LOGICAL saltAdvection        LOGICAL saltAdvection
236        LOGICAL saltForcing        LOGICAL saltForcing
       LOGICAL implicitFreeSurface  
237        LOGICAL rigidLid        LOGICAL rigidLid
238          LOGICAL implicitFreeSurface
239          LOGICAL exactConserv
240          LOGICAL uniformLin_PhiSurf
241        LOGICAL momStepping        LOGICAL momStepping
242        LOGICAL tempStepping        LOGICAL tempStepping
243        LOGICAL saltStepping        LOGICAL saltStepping
244          LOGICAL tr1Stepping
245        LOGICAL metricTerms        LOGICAL metricTerms
246        LOGICAL useConstantF        LOGICAL useConstantF
247        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
# Line 230  C     groundAtK1  - put the surface(k=1) Line 250  C     groundAtK1  - put the surface(k=1)
250        LOGICAL implicitViscosity        LOGICAL implicitViscosity
251        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
252        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
253          LOGICAL doTr1ClimRelax
254        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
255        LOGICAL usingPCoords        LOGICAL usingPCoords
256        LOGICAL usingZCoords        LOGICAL usingZCoords
# Line 237  C     groundAtK1  - put the surface(k=1) Line 258  C     groundAtK1  - put the surface(k=1)
258        LOGICAL globalFiles        LOGICAL globalFiles
259        LOGICAL allowFreezing        LOGICAL allowFreezing
260        LOGICAL groundAtK1        LOGICAL groundAtK1
261          LOGICAL usePickupBeforeC35
262          LOGICAL debugMode
263          LOGICAL readPickupWithTracer
264          LOGICAL writePickupWithTracer
265    
266  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
267  C     cg2dTargetResidual  C     gg2dTargetResidual
268  C               - Target residual for cg2d solver.  C          - Target residual for cg2d solver; no unit (RHS normalisation)
269    C     cg2dTargetResWunit
270    C          - Target residual for cg2d solver; W unit (No RHS normalisation)
271  C     cg3dTargetResidual  C     cg3dTargetResidual
272  C               - Target residual for cg3d solver.  C               - Target residual for cg3d solver.
273  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
# Line 328  C     hFacMin      - Minimum fraction si Line 355  C     hFacMin      - Minimum fraction si
355  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
356  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
357  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
358    C     hFacInf      - Threshold (inf and sup) for fraction size of surface cell
359    C     hFacSup        that control vanishing and creating levels
360  C     tauCD        - CD scheme coupling timescale ( 1/s )  C     tauCD        - CD scheme coupling timescale ( 1/s )
361  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
362  C     startTime     - Starting time for this integration ( s ).  C     startTime     - Starting time for this integration ( s ).
# Line 364  C     Ro_SeaLevel        - standard posi Line 393  C     Ro_SeaLevel        - standard posi
393  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
394  C     bottomDragLinear   - Drag coefficient built in to core dynamics  C     bottomDragLinear   - Drag coefficient built in to core dynamics
395  C         "     Quadratic  ( linear: 1/s, quadratic: 1/m )  C         "     Quadratic  ( linear: 1/s, quadratic: 1/m )
396        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
397       & cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
398       & delP, delZ, delR, delX, delY,       & delP, delZ, delR, delX, delY,
399       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
400       & phiMin, thetaMin, rSphere, recip_RSphere, f0, fCori, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
401         & fCori, fCoriG,
402       & viscAh,  viscAz,  viscA4,  viscAr,       & viscAh,  viscAz,  viscA4,  viscAr,
403       & diffKhT, diffKzT, diffK4T, diffKrT,       & diffKhT, diffKzT, diffK4T, diffKrT,
404       & diffKhS, diffKzS, diffK4S, diffKrS,       & diffKhS, diffKzS, diffK4S, diffKrS,
405       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
406       & hFacMin, hFacMinDz,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
407       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
408       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst, tRef, sRef,
409       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq, monitorFreq,
410       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
411       & cosPower,       & cosPower, cAdjFreq, omega,
412       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, lambdaThetaClimRelax,
413       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
414         & tauTr1ClimRelax, lambdaTr1ClimRelax,
415       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
416       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
417       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
# Line 388  C         "     Quadratic  ( linear: 1/s Line 419  C         "     Quadratic  ( linear: 1/s
419       & bottomDragLinear,bottomDragQuadratic       & bottomDragLinear,bottomDragQuadratic
420    
421        _RL cg2dTargetResidual        _RL cg2dTargetResidual
422          _RL cg2dTargetResWunit
423        _RL cg3dTargetResidual        _RL cg3dTargetResidual
424        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
425        _RL delZ(Nr)        _RL delZ(Nr)
# Line 412  C         "     Quadratic  ( linear: 1/s Line 444  C         "     Quadratic  ( linear: 1/s
444        _RL hFacMinDz        _RL hFacMinDz
445        _RL hFacMinDp        _RL hFacMinDp
446        _RL hFacMinDr        _RL hFacMinDr
447          _RL hFacInf
448          _RL hFacSup
449        _RL beta        _RL beta
450        _RL viscAh        _RL viscAh
451        _RL viscAz        _RL viscAz
# Line 442  C         "     Quadratic  ( linear: 1/s Line 476  C         "     Quadratic  ( linear: 1/s
476        _RL tRef(Nr)        _RL tRef(Nr)
477        _RL theta_S(Nr)        _RL theta_S(Nr)
478        _RL sRef(Nr)        _RL sRef(Nr)
479        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
480          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
481        _RL startTime        _RL startTime
482        _RL endTime        _RL endTime
483        _RL chkPtFreq        _RL chkPtFreq
484        _RL pChkPtFreq        _RL pChkPtFreq
485        _RL dumpFreq        _RL dumpFreq
486        _RL taveFreq        _RL taveFreq
487          _RL monitorFreq
488        _RL afFacMom        _RL afFacMom
489        _RL vfFacMom        _RL vfFacMom
490        _RL pfFacMom        _RL pfFacMom
# Line 462  C         "     Quadratic  ( linear: 1/s Line 498  C         "     Quadratic  ( linear: 1/s
498        _RL lambdaThetaClimRelax        _RL lambdaThetaClimRelax
499        _RL tauSaltClimRelax        _RL tauSaltClimRelax
500        _RL lambdaSaltClimRelax        _RL lambdaSaltClimRelax
501          _RL tauTr1ClimRelax
502          _RL lambdaTr1ClimRelax
503        _RL externForcingCycle        _RL externForcingCycle
504        _RL externForcingPeriod        _RL externForcingPeriod
505        _RL horiVertRatio        _RL horiVertRatio
# Line 490  C     sBeta     - Linear EOS haline cont Line 528  C     sBeta     - Linear EOS haline cont
528        _RL sBeta        _RL sBeta
529        character*(6) eosType        character*(6) eosType
530    
531    C Atmospheric physical parameters (Ideal Gas EOS, ...)
532    C     atm_po    - standard reference pressure
533    C     atm_cp    - specific heat (Cp) of the (dry) air at constant pressure
534    C     atm_kappa - kappa = R/Cp (R: constant of Ideal Gas EOS)
535    C     Integr_GeoPot - option to select the way we integrate the geopotential
536    C                     (still a subject of discussions ...)
537          COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,
538         &                  Integr_GeoPot
539          _RL atm_cp, atm_kappa, atm_po
540          INTEGER Integr_GeoPot
541    
542  C Logical flags for selecting packages  C Logical flags for selecting packages
543        LOGICAL useKPP        LOGICAL useKPP
544        LOGICAL useGMRedi        LOGICAL useGMRedi
545        LOGICAL useOBCS        LOGICAL useOBCS
546        LOGICAL useAIM        LOGICAL useAIM
547          LOGICAL useGrdchk
548        LOGICAL useECCO        LOGICAL useECCO
549          LOGICAL useSHAP_FILT
550        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
551       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
552         &        useSHAP_FILT, useGrdchk
553    
Legend:
Removed from v.1.49  
changed lines
  Added in v.1.58
  ViewVC Help
Powered by ViewVC 1.1.22