/[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.17 by adcroft, Wed Jun 10 16:05:39 1998 UTC revision 1.26 by cnh, Sun Aug 23 15:34:39 1998 UTC
# Line 40  C                       temperature. Line 40  C                       temperature.
40  C     hydrogSaltFile  - File containing initial hydrographic data for salinity.  C     hydrogSaltFile  - File containing initial hydrographic data for salinity.
41  C     zonalWindFile   - File containing zonal wind data  C     zonalWindFile   - File containing zonal wind data
42  C     meridWindFile   - File containing meridional wind data  C     meridWindFile   - File containing meridional wind data
43    C     thetaClimFile   - File containing theta climataology used
44    C                       in relaxation term -lambda(theta-theta*)
45    C     saltClimFile    - File containing salt climataology used
46    C                       in relaxation term -lambda(salt-salt*)
47    C     buoyancyRelation - Flag used to indicate which relation to use to
48    C                        get buoyancy.
49        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
50       &                bathyFile, hydrogThetaFile, hydrogSaltFile,       &                bathyFile, hydrogThetaFile, hydrogSaltFile,
51       &                zonalWindFile, meridWindFile       &                zonalWindFile, meridWindFile, thetaClimFile,
52         &                saltClimFile, buoyancyRelation
53        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
54        CHARACTER*(MAX_LEN_FNAM) bathyFile        CHARACTER*(MAX_LEN_FNAM) bathyFile
55        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
56        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
57        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
58        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
59          CHARACTER*(MAX_LEN_FNAM) thetaClimFile
60          CHARACTER*(MAX_LEN_FNAM) saltClimFile
61          CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
62    
63  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
64  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        - Maximum number of iterations in the
# Line 115  C     useConstantF  - Coriolis parameter Line 125  C     useConstantF  - Coriolis parameter
125  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
126  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
127  C     implicitDiffusion - Turns implicit vertical diffusion on  C     implicitDiffusion - Turns implicit vertical diffusion on
128    C     doThetaClimRelax - Set true if relaxation to temperature
129    C                        climatology is required.
130    C     doSaltClimRelax  - Set true if relaxation to salinity
131    C                        climatology is required.
132    C     periodicExternalForcing - Set true if forcing is time-dependant
133        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
134       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,
135       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
# Line 123  C     implicitDiffusion - Turns implicit Line 138  C     implicitDiffusion - Turns implicit
138       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
139       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
140       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
141       & implicitDiffusion       & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,
142         & periodicExternalForcing
143        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
144        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
145        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
# Line 148  C     implicitDiffusion - Turns implicit Line 164  C     implicitDiffusion - Turns implicit
164        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
165        LOGICAL useSphereF        LOGICAL useSphereF
166        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
167          LOGICAL doThetaClimRelax
168          LOGICAL doSaltClimRelax
169          LOGICAL periodicExternalForcing
170    
171  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
172  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 166  C           number of iterations for con Line 185  C           number of iterations for con
185  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
186  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
187  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
188  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     delP      - Vertical grid spacing ( Pa ).
189  C                 between "w" surfaces.  C     delZ      - Vertical grid spacing ( m  ).
190    C     delR      - Vertical grid spacing ( units of r ).
191  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
192  C     delY        on input flags.  C     delY        on input flags.
193  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
194  C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )  C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )
195  C     ronil     - Reference density  C     ronil     - Reference density
196    C     rhoConst  - Vertically constant reference density
197  C     startTime - Start time for model ( s )  C     startTime - Start time for model ( s )
198  C     phiMin    - Latitude of southern most cell face.  C     phiMin    - Latitude of southern most cell face.
199  C     thetaMin  - Longitude of western most cell face (this  C     thetaMin  - Longitude of western most cell face (this
200  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
201  C                 to make geographical references simple.)  C                 to make geographical references simple.)
202  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).
203  C     rRSphere  - Reciprocal radius of sphere for a spherical polar grid ( m ).  C     recip_RSphere  - Reciprocal radius of sphere ( m ).
204  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        - Reference coriolis parameter ( 1/s )
205  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
206  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      - df/dy ( s^-1.m^-1 )
# Line 188  C     viscAh    - Eddy viscosity coeff. Line 209  C     viscAh    - Eddy viscosity coeff.
209  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
210  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    - Eddy viscosity coeff. for mixing of
211  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
212    C     viscAr    - Eddy viscosity coeff. for mixing of
213    C                 momentum vertically ( units of r^2/s )
214  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscA4    - Biharmonic viscosity coeff. for mixing of
215  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
216  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   - Laplacian diffusion coeff. for mixing of
217  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
218  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   - Laplacian diffusion coeff. for mixing of
219  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
220    C     diffKrT   - Laplacian diffusion coeff. for mixing of
221    C                 heat vertically ( units of r^2/s )
222  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   - Biharmonic diffusion coeff. for mixing of
223  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
224  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  -  Laplacian diffusion coeff. for mixing of
225  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
226  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   - Laplacian diffusion coeff. for mixing of
227  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
228    C     diffKrS   - Laplacian diffusion coeff. for mixing of
229    C                 salt vertically ( units of r^2/s )
230  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   - Biharmonic diffusion coeff. for mixing of
231  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
232  C     deltaT    - Default timestep ( s )  C     deltaT    - Default timestep ( s )
# Line 214  C     deltaTtracer - Timestep for tracer Line 241  C     deltaTtracer - Timestep for tracer
241  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     freesurfFac  - Parameter to turn implicit free surface term on or off
242  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
243  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
244  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
245  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
246  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
247  C     GMlength  - Length to use in Visbeck et al. formula for K (m)  C     tauCD        - CD scheme coupling timescale ( 1/s )
248  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
249  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C     GMmaxslope   - max. slope allowed in GM/Redi tensor
250  C     GMkbackground - background value of GM/Redi coefficient  C     GMlength     - Length to use in Visbeck et al. formula for K (m)
251  C     startTime - Starting time for this integration ( s ).  C     GMalpha      - alpha to use in Visbeck et al. formula for K
252  C     endTime   - Ending time for this integration ( s ).  C     GMdepth      - Depth over which to integrate Richardson # (Visbeck et al.)
253  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s )
254  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     GMmaxval      - max. value of KapGM allowed in GM/Redi scheme ( m^2/s )
255  C     dumpFreq  - Frequency with which model state is written to  C     startTime     - Starting time for this integration ( s ).
256    C     endTime       - Ending time for this integration ( s ).
257    C     chkPtFreq     - Frequency of rolling check pointing ( s ).
258    C     pChkPtFreq    - Frequency of permanent check pointing ( s ).
259    C     dumpFreq      - Frequency with which model state is written to
260    C                     post-processing files ( s ).
261    C     afFacMom      - Advection of momentum term tracer parameter
262    C     vfFacMom      - Momentum viscosity tracer parameter
263    C     pfFacMom      - Momentum pressure forcing tracer parameter
264    C     cfFacMom      - Coriolis term tracer parameter
265    C     foFacMom      - Momentum forcing tracer parameter
266    C     mtFacMom      - Metric terms tracer parameter
267    C     cAdjFreq      - Frequency of convective adjustment
268    C
269    C     taveFreq  - Frequency with which time-averaged model state is written to
270  C                 post-processing files ( s ).  C                 post-processing files ( s ).
271  C     afFacMom  - Advection of momentum term scaling parameter  C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).
272  C     vfFacMom  - Momentum viscosity scaling parameter  C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
273  C     pfFacMom  - Momentum pressure forcing parameter  C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
274  C     cfFacMom  - Coriolis term scaling parameter  C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
275  C     foFacMom  - Momentum forcing scaling parameter  C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
276  C     mtFacMom  - Metric terms scaling parameter  C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
277  C     cAdjFreq  - Frequency of convective adjustment  C                          (note: externForcingCycle must be an integer
278        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,  C                           number times externForcingPeriod)
279          COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
280         & delP, delZ, delR, delX, delY,
281       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
282       & thetaMin, rSphere, rRSphere, f0, fCori, beta, viscAh, viscAz, viscA4,       & thetaMin, rSphere, recip_RSphere, f0, fCori, beta,
283       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,       & viscAh,  viscAz,  viscA4,  viscAr,
284       & tauCD, rCD, freeSurfFac,       & diffKhT, diffKzT, diffK4T, diffKrT,
285       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,       & diffKhS, diffKzS, diffK4S, diffKrS,
286       & gravity, gBaro, rhonil, tRef, sRef,       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
287       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
288         & gravity, gBaro, rhonil, recip_rhonil,
289         & recip_rhoConst, rhoConst, tRef, sRef, theta_S, specVol_S,
290         & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
291       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
292       & cAdjFreq, omega       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
293         & tauSaltClimRelax, lambdaSaltClimRelax,
294         & externForcingCycle, externForcingPeriod
295        _RL cg2dTargetResidual        _RL cg2dTargetResidual
296        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
297        _RL delZ(Nz)        _RL delZ(Nr)
298          _RL delP(Nr)
299          _RL delR(Nr)
300        _RL delX(Nx)        _RL delX(Nx)
301        _RL delY(Ny)        _RL delY(Ny)
302        _RL deltaT        _RL deltaT
# Line 257  C     cAdjFreq  - Frequency of convectiv Line 307  C     cAdjFreq  - Frequency of convectiv
307        _RL phiMin        _RL phiMin
308        _RL thetaMin        _RL thetaMin
309        _RL rSphere        _RL rSphere
310        _RL rRSphere        _RL recip_RSphere
311        _RL f0        _RL f0
312        _RL freeSurfFac        _RL freeSurfFac
313          _RL hFacMin
314          _RL hFacMinDz
315        _RL beta        _RL beta
316        _RL viscAh        _RL viscAh
317        _RL viscAz        _RL viscAz
318          _RL viscAr
319        _RL viscA4        _RL viscA4
320        _RL diffKhT        _RL diffKhT
321          _RL diffKrT
322        _RL diffKzT        _RL diffKzT
323        _RL diffK4T        _RL diffK4T
324        _RL diffKhS        _RL diffKhS
325          _RL diffKrS
326        _RL diffKzS        _RL diffKzS
327        _RL diffK4S        _RL diffK4S
328        _RL delt        _RL delt
# Line 278  C     cAdjFreq  - Frequency of convectiv Line 333  C     cAdjFreq  - Frequency of convectiv
333        _RL GMalpha        _RL GMalpha
334        _RL GMdepth        _RL GMdepth
335        _RL GMkbackground        _RL GMkbackground
336          _RL GMmaxval
337        _RL gravity        _RL gravity
338        _RL gBaro        _RL gBaro
339        _RL rhonil        _RL rhonil
340        _RL tRef(Nz)        _RL recip_rhonil
341        _RL sRef(Nz)        _RL rhoConst
342          _RL recip_rhoConst
343          _RL specVol_S(Nr)
344          _RL tRef(Nr)
345          _RL theta_S(Nr)
346          _RL sRef(Nr)
347        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
348        _RL startTime        _RL startTime
349        _RL endTime        _RL endTime
350        _RL chkPtFreq        _RL chkPtFreq
351        _RL pChkPtFreq        _RL pChkPtFreq
352        _RL dumpFreq        _RL dumpFreq
353          _RL taveFreq
354        _RL afFacMom        _RL afFacMom
355        _RL vfFacMom        _RL vfFacMom
356        _RL pfFacMom        _RL pfFacMom
# Line 297  C     cAdjFreq  - Frequency of convectiv Line 359  C     cAdjFreq  - Frequency of convectiv
359        _RL mTFacMom        _RL mTFacMom
360        _RL cAdjFreq        _RL cAdjFreq
361        _RL omega        _RL omega
362          _RL tauThetaClimRelax
363          _RL lambdaThetaClimRelax
364          _RL tauSaltClimRelax
365          _RL lambdaSaltClimRelax
366          _RL externForcingCycle
367          _RL externForcingPeriod
368    
369        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,
370       &                Lamba_theta       &                Lamba_theta
# Line 305  C     cAdjFreq  - Frequency of convectiv Line 373  C     cAdjFreq  - Frequency of convectiv
373    
374  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
375        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
376        _RL eosC(9,Nz+1),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)        _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
377  C Linear equation of state  C Linear equation of state
378  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
379  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     - Linear EOS haline contraction coefficient.
Legend:
Removed from v.1.17  
changed lines
  Added in v.1.26
  ViewVC Help
Powered by ViewVC 1.1.22