/[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.15 by cnh, Mon Jun 8 21:43:00 1998 UTC revision 1.28 by cnh, Sat Sep 5 17:52:13 1998 UTC
# Line 26  C                dumping model state. Line 26  C                dumping model state.
26        PARAMETER ( precFloat32 = 0 )        PARAMETER ( precFloat32 = 0 )
27        INTEGER precFloat64        INTEGER precFloat64
28        PARAMETER ( precFloat64 = 1 )        PARAMETER ( precFloat64 = 1 )
29    C     UNSET_xxx - Used to indicate variables that have not been given a value
30          Real*8 UNSET_FLOAT8
31          PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
32          Real*4 UNSET_FLOAT4
33          PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
34          _RL    UNSET_RL    
35          PARAMETER ( UNSET_RL     = 1.234567D5 )
36          _RS    UNSET_RS    
37          PARAMETER ( UNSET_RS     = 1.234567E5 )
38          INTEGER UNSET_I
39          PARAMETER ( UNSET_I      = 123456789  )
40    
41  C     Checkpoint data  C     Checkpoint data
42        INTEGER maxNoChkptLev        INTEGER maxNoChkptLev
# Line 33  C     Checkpoint data Line 44  C     Checkpoint data
44    
45  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
46  C     checkPtSuff - List of checkpoint file suffices  C     checkPtSuff - List of checkpoint file suffices
47        COMMON /PARM_C/ checkPtSuff  C     bathyFile   - File containing bathymetry. If not defined bathymetry
48    C                   is taken from inline function.
49    C     hydrogThetaFile - File containing initial hydrographic data for potential
50    C                       temperature.
51    C     hydrogSaltFile  - File containing initial hydrographic data for salinity.
52    C     zonalWindFile   - File containing zonal wind data
53    C     meridWindFile   - File containing meridional wind data
54    C     thetaClimFile   - File containing theta climataology used
55    C                       in relaxation term -lambda(theta-theta*)
56    C     saltClimFile    - File containing salt climataology used
57    C                       in relaxation term -lambda(salt-salt*)
58    C     buoyancyRelation - Flag used to indicate which relation to use to
59    C                        get buoyancy.
60          COMMON /PARM_C/ checkPtSuff,
61         &                bathyFile, hydrogThetaFile, hydrogSaltFile,
62         &                zonalWindFile, meridWindFile, thetaClimFile,
63         &                saltClimFile, buoyancyRelation
64        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
65          CHARACTER*(MAX_LEN_FNAM) bathyFile
66          CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
67          CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
68          CHARACTER*(MAX_LEN_FNAM) zonalWindFile
69          CHARACTER*(MAX_LEN_FNAM) meridWindFile
70          CHARACTER*(MAX_LEN_FNAM) thetaClimFile
71          CHARACTER*(MAX_LEN_FNAM) saltClimFile
72          CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
73    
74  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
75  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        - Maximum number of iterations in the
# Line 96  C     implicitFreeSurface - Set to true Line 131  C     implicitFreeSurface - Set to true
131  C     rigidLid            - Set to true to use rigid lid  C     rigidLid            - Set to true to use rigid lid
132  C     momStepping   - Turns momentum equation time-stepping off  C     momStepping   - Turns momentum equation time-stepping off
133  C     tempStepping  - Turns temperature equation time-stepping off  C     tempStepping  - Turns temperature equation time-stepping off
134    C     saltStepping  - Turns salinity equation time-stepping off
135  C     useConstantF  - Coriolis parameter set to f0  C     useConstantF  - Coriolis parameter set to f0
136  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
137  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
138  C     implicitDiffusion - Turns implicit vertical diffusion on  C     implicitDiffusion - Turns implicit vertical diffusion on
139    C     doThetaClimRelax - Set true if relaxation to temperature
140    C                        climatology is required.
141    C     doSaltClimRelax  - Set true if relaxation to salinity
142    C                        climatology is required.
143    C     periodicExternalForcing - Set true if forcing is time-dependant
144        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
145       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,
146       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
147       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
148       & implicitFreeSurface, rigidLid, momStepping, tempStepping,       & implicitFreeSurface, rigidLid,
149         & momStepping, tempStepping, saltStepping,
150       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
151       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
152       & implicitDiffusion       & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,
153         & periodicExternalForcing
154        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
155        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
156        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
# Line 126  C     implicitDiffusion - Turns implicit Line 169  C     implicitDiffusion - Turns implicit
169        LOGICAL rigidLid        LOGICAL rigidLid
170        LOGICAL momStepping        LOGICAL momStepping
171        LOGICAL tempStepping        LOGICAL tempStepping
172          LOGICAL saltStepping
173        LOGICAL metricTerms        LOGICAL metricTerms
174        LOGICAL useConstantF        LOGICAL useConstantF
175        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
176        LOGICAL useSphereF        LOGICAL useSphereF
177        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
178          LOGICAL doThetaClimRelax
179          LOGICAL doSaltClimRelax
180          LOGICAL periodicExternalForcing
181    
182  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
183  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 149  C           number of iterations for con Line 196  C           number of iterations for con
196  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
197  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
198  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
199  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     delP      - Vertical grid spacing ( Pa ).
200  C                 between "w" surfaces.  C     delZ      - Vertical grid spacing ( m  ).
201    C     delR      - Vertical grid spacing ( units of r ).
202  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
203  C     delY        on input flags.  C     delY        on input flags.
204  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
205  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 )
206  C     ronil     - Reference density  C     ronil     - Reference density
207    C     rhoConst  - Vertically constant reference density
208  C     startTime - Start time for model ( s )  C     startTime - Start time for model ( s )
209  C     phiMin    - Latitude of southern most cell face.  C     phiMin    - Latitude of southern most cell face.
210  C     thetaMin  - Longitude of western most cell face (this  C     thetaMin  - Longitude of western most cell face (this
211  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
212  C                 to make geographical references simple.)  C                 to make geographical references simple.)
213  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).
214  C     rRSphere  - Reciprocal radius of sphere for a spherical polar grid ( m ).  C     recip_RSphere  - Reciprocal radius of sphere ( m ).
215  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        - Reference coriolis parameter ( 1/s )
216  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
217  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      - df/dy ( s^-1.m^-1 )
# Line 171  C     viscAh    - Eddy viscosity coeff. Line 220  C     viscAh    - Eddy viscosity coeff.
220  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
221  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    - Eddy viscosity coeff. for mixing of
222  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
223    C     viscAp    - Eddy viscosity coeff. for mixing of
224    C                 momentum vertically ( Pa^2/s )
225    C     viscAr    - Eddy viscosity coeff. for mixing of
226    C                 momentum vertically ( units of r^2/s )
227  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscA4    - Biharmonic viscosity coeff. for mixing of
228  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
229  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   - Laplacian diffusion coeff. for mixing of
230  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
231  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   - Laplacian diffusion coeff. for mixing of
232  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
233    C     diffKpT   - Laplacian diffusion coeff. for mixing of
234    C                 heat vertically ( Pa^2/s )
235    C     diffKrT   - Laplacian diffusion coeff. for mixing of
236    C                 heat vertically ( units of r^2/s )
237  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   - Biharmonic diffusion coeff. for mixing of
238  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
239  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  -  Laplacian diffusion coeff. for mixing of
240  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
241  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   - Laplacian diffusion coeff. for mixing of
242  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
243    C     diffKpS   - Laplacian diffusion coeff. for mixing of
244    C                 salt vertically ( Pa^2/s )
245    C     diffKrS   - Laplacian diffusion coeff. for mixing of
246    C                 salt vertically ( units of r^2/s )
247  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   - Biharmonic diffusion coeff. for mixing of
248  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
249  C     deltaT    - Default timestep ( s )  C     deltaT    - Default timestep ( s )
# Line 197  C     deltaTtracer - Timestep for tracer Line 258  C     deltaTtracer - Timestep for tracer
258  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     freesurfFac  - Parameter to turn implicit free surface term on or off
259  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
260  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
261  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
262  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
263  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
264  C     GMlength  - Length to use in Visbeck et al. formula for K (m)  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
265  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C     tauCD        - CD scheme coupling timescale ( 1/s )
266  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
267  C     GMkbackground - background value of GM/Redi coefficient  C     GMmaxslope    - max. slope allowed in GM/Redi tensor
268  C     startTime - Starting time for this integration ( s ).  C     GMlength      - Length to use in Visbeck et al. formula for K (m)
269  C     endTime   - Ending time for this integration ( s ).  C     GMalpha       - alpha to use in Visbeck et al. formula for K
270  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     GMdepth       - Depth over which to integrate Richardson # (Visbeck et al.)
271  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s )
272  C     dumpFreq  - Frequency with which model state is written to  C     GMmaxval      - max. value of KapGM allowed in GM/Redi scheme ( m^2/s )
273  C                 post-processing files ( s ).  C     startTime     - Starting time for this integration ( s ).
274  C     afFacMom  - Advection of momentum term scaling parameter  C     endTime       - Ending time for this integration ( s ).
275  C     vfFacMom  - Momentum viscosity scaling parameter  C     chkPtFreq     - Frequency of rolling check pointing ( s ).
276  C     pfFacMom  - Momentum pressure forcing parameter  C     pChkPtFreq    - Frequency of permanent check pointing ( s ).
277  C     cfFacMom  - Coriolis term scaling parameter  C     dumpFreq      - Frequency with which model state is written to
278  C     foFacMom  - Momentum forcing scaling parameter  C                     post-processing files ( s ).
279  C     mtFacMom  - Metric terms scaling parameter  C     afFacMom      - Advection of momentum term tracer parameter
280  C     cAdjFreq  - Frequency of convective adjustment  C     vfFacMom      - Momentum viscosity tracer parameter
281        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,  C     pfFacMom      - Momentum pressure forcing tracer parameter
282    C     cfFacMom      - Coriolis term tracer parameter
283    C     foFacMom      - Momentum forcing tracer parameter
284    C     mtFacMom      - Metric terms tracer parameter
285    C     cAdjFreq      - Frequency of convective adjustment
286    C
287    C     taveFreq      - Frequency with which time-averaged model state is written to
288    C                     post-processing files ( s ).
289    C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).
290    C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
291    C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
292    C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
293    C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
294    C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
295    C                          (note: externForcingCycle must be an integer
296    C                           number times externForcingPeriod)
297          COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
298         & delP, delZ, delR, delX, delY,
299       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
300       & thetaMin, rSphere, rRSphere, f0, fCori, beta, viscAh, viscAz, viscA4,       & thetaMin, rSphere, recip_RSphere, f0, fCori, beta,
301       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,       & viscAh,  viscAz,  viscA4,  viscAr,
302       & tauCD, rCD, freeSurfFac,       & diffKhT, diffKzT, diffK4T, diffKrT,
303       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,       & diffKhS, diffKzS, diffK4S, diffKrS,
304       & gravity, gBaro, rhonil, tRef, sRef,       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
305       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
306         & gravity, gBaro, rhonil, recip_rhonil,
307         & recip_rhoConst, rhoConst, tRef, sRef,
308         & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
309       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
310       & cAdjFreq, omega       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
311         & tauSaltClimRelax, lambdaSaltClimRelax,
312         & externForcingCycle, externForcingPeriod,
313         & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
314         & theta_S, specVol_S
315    
316        _RL cg2dTargetResidual        _RL cg2dTargetResidual
317        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
318        _RL delZ(Nz)        _RL delZ(Nr)
319          _RL delP(Nr)
320          _RL delR(Nr)
321        _RL delX(Nx)        _RL delX(Nx)
322        _RL delY(Ny)        _RL delY(Ny)
323        _RL deltaT        _RL deltaT
# Line 240  C     cAdjFreq  - Frequency of convectiv Line 328  C     cAdjFreq  - Frequency of convectiv
328        _RL phiMin        _RL phiMin
329        _RL thetaMin        _RL thetaMin
330        _RL rSphere        _RL rSphere
331        _RL rRSphere        _RL recip_RSphere
332        _RL f0        _RL f0
333        _RL freeSurfFac        _RL freeSurfFac
334          _RL hFacMin
335          _RL hFacMinDz
336          _RL hFacMinDp
337          _RL hFacMinDr
338        _RL beta        _RL beta
339        _RL viscAh        _RL viscAh
340        _RL viscAz        _RL viscAz
341          _RL viscAp
342          _RL viscAr
343        _RL viscA4        _RL viscA4
344        _RL diffKhT        _RL diffKhT
345          _RL diffKrT
346        _RL diffKzT        _RL diffKzT
347          _RL diffKpT
348        _RL diffK4T        _RL diffK4T
349        _RL diffKhS        _RL diffKhS
350          _RL diffKrS
351        _RL diffKzS        _RL diffKzS
352          _RL diffKpS
353        _RL diffK4S        _RL diffK4S
354        _RL delt        _RL delt
355        _RL tauCD        _RL tauCD
# Line 261  C     cAdjFreq  - Frequency of convectiv Line 359  C     cAdjFreq  - Frequency of convectiv
359        _RL GMalpha        _RL GMalpha
360        _RL GMdepth        _RL GMdepth
361        _RL GMkbackground        _RL GMkbackground
362          _RL GMmaxval
363        _RL gravity        _RL gravity
364        _RL gBaro        _RL gBaro
365        _RL rhonil        _RL rhonil
366        _RL tRef(Nz)        _RL recip_rhonil
367        _RL sRef(Nz)        _RL rhoConst
368          _RL recip_rhoConst
369          _RL specVol_S(Nr)
370          _RL tRef(Nr)
371          _RL theta_S(Nr)
372          _RL sRef(Nr)
373        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
374        _RL startTime        _RL startTime
375        _RL endTime        _RL endTime
376        _RL chkPtFreq        _RL chkPtFreq
377        _RL pChkPtFreq        _RL pChkPtFreq
378        _RL dumpFreq        _RL dumpFreq
379          _RL taveFreq
380        _RL afFacMom        _RL afFacMom
381        _RL vfFacMom        _RL vfFacMom
382        _RL pfFacMom        _RL pfFacMom
# Line 280  C     cAdjFreq  - Frequency of convectiv Line 385  C     cAdjFreq  - Frequency of convectiv
385        _RL mTFacMom        _RL mTFacMom
386        _RL cAdjFreq        _RL cAdjFreq
387        _RL omega        _RL omega
388          _RL tauThetaClimRelax
389          _RL lambdaThetaClimRelax
390          _RL tauSaltClimRelax
391          _RL lambdaSaltClimRelax
392          _RL externForcingCycle
393          _RL externForcingPeriod
394    
395        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,
396       &                Lamba_theta       &                Lamba_theta
# Line 288  C     cAdjFreq  - Frequency of convectiv Line 399  C     cAdjFreq  - Frequency of convectiv
399    
400  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
401        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
402        _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)
403  C Linear equation of state  C Linear equation of state
404  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
405  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     - Linear EOS haline contraction coefficient.
Legend:
Removed from v.1.15  
changed lines
  Added in v.1.28
  ViewVC Help
Powered by ViewVC 1.1.22