/[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.21 by adcroft, Thu Jul 16 15:23:43 1998 UTC revision 1.31 by cnh, Wed Sep 9 15:04:43 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 44  C     thetaClimFile   - File containing Line 55  C     thetaClimFile   - File containing
55  C                       in relaxation term -lambda(theta-theta*)  C                       in relaxation term -lambda(theta-theta*)
56  C     saltClimFile    - File containing salt climataology used  C     saltClimFile    - File containing salt climataology used
57  C                       in relaxation term -lambda(salt-salt*)  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,        COMMON /PARM_C/ checkPtSuff,
61       &                bathyFile, hydrogThetaFile, hydrogSaltFile,       &                bathyFile, hydrogThetaFile, hydrogSaltFile,
62       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
63       &                saltClimFile       &                saltClimFile, buoyancyRelation
64        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
65        CHARACTER*(MAX_LEN_FNAM) bathyFile        CHARACTER*(MAX_LEN_FNAM) bathyFile
66        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
# Line 56  C                       in relaxation te Line 69  C                       in relaxation te
69        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
70        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
71        CHARACTER*(MAX_LEN_FNAM) saltClimFile        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 127  C                        climatology is Line 141  C                        climatology is
141  C     doSaltClimRelax  - Set true if relaxation to salinity  C     doSaltClimRelax  - Set true if relaxation to salinity
142  C                        climatology is required.  C                        climatology is required.
143  C     periodicExternalForcing - Set true if forcing is time-dependant  C     periodicExternalForcing - Set true if forcing is time-dependant
144    C     usingPCoords     - Set to indicate that we are working in pressure
145    C                        coords.
146    C     usingZCoords     - Set to indicate that we are working in height
147    C                        coords.
148        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
149       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,
150       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
# Line 136  C     periodicExternalForcing - Set true Line 154  C     periodicExternalForcing - Set true
154       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
155       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
156       & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,       & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,
157       & periodicExternalForcing       & periodicExternalForcing, usingPCoords, usingZCoords
158        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
159        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
160        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
# Line 164  C     periodicExternalForcing - Set true Line 182  C     periodicExternalForcing - Set true
182        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
183        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
184        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
185          LOGICAL usingPCoords
186          LOGICAL usingZCoords
187    
188  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
189  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 182  C           number of iterations for con Line 202  C           number of iterations for con
202  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
203  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
204  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
205  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     delP      - Vertical grid spacing ( Pa ).
206  C                 between "w" surfaces.  C     delZ      - Vertical grid spacing ( m  ).
207    C     delR      - Vertical grid spacing ( units of r ).
208  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
209  C     delY        on input flags.  C     delY        on input flags.
210  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
211  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 )
212  C     ronil     - Reference density  C     ronil     - Reference density
213    C     rhoConst  - Vertically constant reference density
214  C     startTime - Start time for model ( s )  C     startTime - Start time for model ( s )
215  C     phiMin    - Latitude of southern most cell face.  C     phiMin    - Latitude of southern most cell face.
216  C     thetaMin  - Longitude of western most cell face (this  C     thetaMin  - Longitude of western most cell face (this
217  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
218  C                 to make geographical references simple.)  C                 to make geographical references simple.)
219  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).
220  C     rRSphere  - Reciprocal radius of sphere for a spherical polar grid ( m ).  C     recip_RSphere  - Reciprocal radius of sphere ( m ).
221  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        - Reference coriolis parameter ( 1/s )
222  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
223  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      - df/dy ( s^-1.m^-1 )
# Line 204  C     viscAh    - Eddy viscosity coeff. Line 226  C     viscAh    - Eddy viscosity coeff.
226  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
227  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    - Eddy viscosity coeff. for mixing of
228  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
229    C     viscAp    - Eddy viscosity coeff. for mixing of
230    C                 momentum vertically ( Pa^2/s )
231    C     viscAr    - Eddy viscosity coeff. for mixing of
232    C                 momentum vertically ( units of r^2/s )
233  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscA4    - Biharmonic viscosity coeff. for mixing of
234  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
235  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   - Laplacian diffusion coeff. for mixing of
236  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
237  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   - Laplacian diffusion coeff. for mixing of
238  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
239    C     diffKpT   - Laplacian diffusion coeff. for mixing of
240    C                 heat vertically ( Pa^2/s )
241    C     diffKrT   - Laplacian diffusion coeff. for mixing of
242    C                 heat vertically ( units of r^2/s )
243  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   - Biharmonic diffusion coeff. for mixing of
244  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
245  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  -  Laplacian diffusion coeff. for mixing of
246  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
247  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   - Laplacian diffusion coeff. for mixing of
248  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
249    C     diffKpS   - Laplacian diffusion coeff. for mixing of
250    C                 salt vertically ( Pa^2/s )
251    C     diffKrS   - Laplacian diffusion coeff. for mixing of
252    C                 salt vertically ( units of r^2/s )
253  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   - Biharmonic diffusion coeff. for mixing of
254  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
255  C     deltaT    - Default timestep ( s )  C     deltaT    - Default timestep ( s )
# Line 230  C     deltaTtracer - Timestep for tracer Line 264  C     deltaTtracer - Timestep for tracer
264  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     freesurfFac  - Parameter to turn implicit free surface term on or off
265  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
266  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
267  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
268  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
269  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
270  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)
271  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C     tauCD        - CD scheme coupling timescale ( 1/s )
272  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
273  C     GMkbackground - background value of GM/Redi coefficient  C     GMmaxslope    - max. slope allowed in GM/Redi tensor
274  C     GMmaxval  - max. value of KapGM allowed in GM/Redi scheme  C     GMlength      - Length to use in Visbeck et al. formula for K (m)
275  C     startTime - Starting time for this integration ( s ).  C     GMalpha       - alpha to use in Visbeck et al. formula for K
276  C     endTime   - Ending time for this integration ( s ).  C     GMdepth       - Depth over which to integrate Richardson # (Visbeck et al.)
277  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s )
278  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     GMmaxval      - max. value of KapGM allowed in GM/Redi scheme ( m^2/s )
279  C     dumpFreq  - Frequency with which model state is written to  C     startTime     - Starting time for this integration ( s ).
280  C                 post-processing files ( s ).  C     endTime       - Ending time for this integration ( s ).
281  C     taveFreq  - Frequency with which time-averaged model state is written to  C     chkPtFreq     - Frequency of rolling check pointing ( s ).
282  C                 post-processing files ( s ).  C     pChkPtFreq    - Frequency of permanent check pointing ( s ).
283  C     afFacMom  - Advection of momentum term scaling parameter  C     dumpFreq      - Frequency with which model state is written to
284  C     vfFacMom  - Momentum viscosity scaling parameter  C                     post-processing files ( s ).
285  C     pfFacMom  - Momentum pressure forcing parameter  C     afFacMom      - Advection of momentum term tracer parameter
286  C     cfFacMom  - Coriolis term scaling parameter  C     vfFacMom      - Momentum viscosity tracer parameter
287  C     foFacMom  - Momentum forcing scaling parameter  C     pfFacMom      - Momentum pressure forcing tracer parameter
288  C     mtFacMom  - Metric terms scaling parameter  C     cfFacMom      - Coriolis term tracer parameter
289  C     cAdjFreq  - Frequency of convective adjustment  C     foFacMom      - Momentum forcing tracer parameter
290    C     mtFacMom      - Metric terms tracer parameter
291    C     cAdjFreq      - Frequency of convective adjustment
292    C
293    C     taveFreq      - Frequency with which time-averaged model state is written to
294    C                     post-processing files ( s ).
295  C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).
296  C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).  C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
297  C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
# Line 261  C     externForcingPeriod - Is the perio Line 300  C     externForcingPeriod - Is the perio
300  C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)  C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
301  C                          (note: externForcingCycle must be an integer  C                          (note: externForcingCycle must be an integer
302  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
303        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,  C     horiVertRatio      - Ratio on units in vertical to units in horizontal.
304    C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
305    C                          ( g*rho if horiz in m and vertical in Pa ).
306          COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
307         & delP, delZ, delR, delX, delY,
308       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
309       & thetaMin, rSphere, rRSphere, f0, fCori, beta, viscAh, viscAz, viscA4,       & thetaMin, rSphere, recip_RSphere, f0, fCori, beta,
310       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,       & viscAh,  viscAz,  viscA4,  viscAr,
311       & tauCD, rCD, freeSurfFac,       & diffKhT, diffKzT, diffK4T, diffKrT,
312         & diffKhS, diffKzS, diffK4S, diffKrS,
313         & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
314       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
315       & gravity, gBaro, rhonil, tRef, sRef,       & gravity, gBaro, rhonil, recip_rhonil,
316         & recip_rhoConst, rhoConst, tRef, sRef,
317       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
318       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
319       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
320       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
321       & externForcingCycle, externForcingPeriod       & externForcingCycle, externForcingPeriod,
322         & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
323         & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio
324    
325        _RL cg2dTargetResidual        _RL cg2dTargetResidual
326        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
327        _RL delZ(Nz)        _RL delZ(Nr)
328          _RL delP(Nr)
329          _RL delR(Nr)
330        _RL delX(Nx)        _RL delX(Nx)
331        _RL delY(Ny)        _RL delY(Ny)
332        _RL deltaT        _RL deltaT
# Line 286  C                           number times Line 337  C                           number times
337        _RL phiMin        _RL phiMin
338        _RL thetaMin        _RL thetaMin
339        _RL rSphere        _RL rSphere
340        _RL rRSphere        _RL recip_RSphere
341        _RL f0        _RL f0
342        _RL freeSurfFac        _RL freeSurfFac
343          _RL hFacMin
344          _RL hFacMinDz
345          _RL hFacMinDp
346          _RL hFacMinDr
347        _RL beta        _RL beta
348        _RL viscAh        _RL viscAh
349        _RL viscAz        _RL viscAz
350          _RL viscAp
351          _RL viscAr
352        _RL viscA4        _RL viscA4
353        _RL diffKhT        _RL diffKhT
354          _RL diffKrT
355        _RL diffKzT        _RL diffKzT
356          _RL diffKpT
357        _RL diffK4T        _RL diffK4T
358        _RL diffKhS        _RL diffKhS
359          _RL diffKrS
360        _RL diffKzS        _RL diffKzS
361          _RL diffKpS
362        _RL diffK4S        _RL diffK4S
363        _RL delt        _RL delt
364        _RL tauCD        _RL tauCD
# Line 311  C                           number times Line 372  C                           number times
372        _RL gravity        _RL gravity
373        _RL gBaro        _RL gBaro
374        _RL rhonil        _RL rhonil
375        _RL tRef(Nz)        _RL recip_rhonil
376        _RL sRef(Nz)        _RL rhoConst
377          _RL recip_rhoConst
378          _RL specVol_S(Nr)
379          _RL tRef(Nr)
380          _RL theta_S(Nr)
381          _RL sRef(Nr)
382        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
383        _RL startTime        _RL startTime
384        _RL endTime        _RL endTime
# Line 334  C                           number times Line 400  C                           number times
400        _RL lambdaSaltClimRelax        _RL lambdaSaltClimRelax
401        _RL externForcingCycle        _RL externForcingCycle
402        _RL externForcingPeriod        _RL externForcingPeriod
403          _RL horiVertRatio
404          _RL recip_horiVertRatio
405    
406        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,
407       &                Lamba_theta       &                Lamba_theta
# Line 342  C                           number times Line 410  C                           number times
410    
411  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
412        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
413        _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)
414  C Linear equation of state  C Linear equation of state
415  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
416  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     - Linear EOS haline contraction coefficient.
Legend:
Removed from v.1.21  
changed lines
  Added in v.1.31
  ViewVC Help
Powered by ViewVC 1.1.22