/[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.13 by cnh, Sat May 30 02:10:16 1998 UTC revision 1.29 by cnh, Sun Sep 6 14:45:10 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 77  C     momForcing    - Flag which turns e Line 112  C     momForcing    - Flag which turns e
112  C                     and off.  C                     and off.
113  C     momPressureForcing - Flag which turns pressure term in momentum equation  C     momPressureForcing - Flag which turns pressure term in momentum equation
114  C                          on and off.  C                          on and off.
115    C     metricTerms   - Flag which turns metric terms on or off.
116    C     usingSphericalPolarMTerms - If TRUE use spherical polar metric terms.
117  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     useCoriolis   - Flag which turns the coriolis terms on and off.
118  C     tempDiffusion - Flag which turns diffusion of temperature on  C     tempDiffusion - Flag which turns diffusion of temperature on
119  C                     and off.  C                     and off.
# Line 93  C                     and off. Line 130  C                     and off.
130  C     implicitFreeSurface - Set to true to use implcit free surface  C     implicitFreeSurface - Set to true to use implcit free surface
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     momStepping   - 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
136    C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
137    C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
138    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    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,
151       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
152       & implicitFreeSurface, rigidLid, momStepping, tempStepping       & implicitFreeSurface, rigidLid,
153         & momStepping, tempStepping, saltStepping,
154         & metricTerms, usingSphericalPolarMTerms,
155         & useConstantF, useBetaPlaneF, useSphereF,
156         & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,
157         & periodicExternalForcing, usingPCoords, usingZCoords
158        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
159        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
160          LOGICAL usingSphericalPolarMTerms
161        LOGICAL momViscosity        LOGICAL momViscosity
162        LOGICAL momAdvection        LOGICAL momAdvection
163        LOGICAL momForcing        LOGICAL momForcing
# Line 116  C     momStepping   - Turns temperature Line 173  C     momStepping   - Turns temperature
173        LOGICAL rigidLid        LOGICAL rigidLid
174        LOGICAL momStepping        LOGICAL momStepping
175        LOGICAL tempStepping        LOGICAL tempStepping
176          LOGICAL saltStepping
177          LOGICAL metricTerms
178          LOGICAL useConstantF
179          LOGICAL useBetaPlaneF
180          LOGICAL useSphereF
181          LOGICAL implicitDiffusion
182          LOGICAL doThetaClimRelax
183          LOGICAL doSaltClimRelax
184          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 134  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     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 )
224    C     omega     - Angular velocity ( rad/s )
225  C     viscAh    - Eddy viscosity coeff. for mixing of  C     viscAh    - Eddy viscosity coeff. for mixing of
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 180  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     startTime - Starting time for this integration ( s ).  C     GMlength      - Length to use in Visbeck et al. formula for K (m)
275  C     endTime   - Ending time for this integration ( s ).  C     GMalpha       - alpha to use in Visbeck et al. formula for K
276  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     GMdepth       - Depth over which to integrate Richardson # (Visbeck et al.)
277  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s )
278  C     dumpFreq  - Frequency with which model state is written to  C     GMmaxval      - max. value of KapGM allowed in GM/Redi scheme ( m^2/s )
279  C                 post-processing files ( s ).  C     startTime     - Starting time for this integration ( s ).
280  C     afFacMom  - Advection of momentum term scaling parameter  C     endTime       - Ending time for this integration ( s ).
281  C     vfFacMom  - Momentum viscosity scaling parameter  C     chkPtFreq     - Frequency of rolling check pointing ( s ).
282  C     pfFacMom  - Momentum pressure forcing parameter  C     pChkPtFreq    - Frequency of permanent check pointing ( s ).
283  C     cfFacMom  - Coriolis term scaling parameter  C     dumpFreq      - Frequency with which model state is written to
284  C     foFacMom  - Momentum forcing scaling parameter  C                     post-processing files ( s ).
285  C     cAdjFreq  - Frequency of convective adjustment  C     afFacMom      - Advection of momentum term tracer parameter
286        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,  C     vfFacMom      - Momentum viscosity tracer parameter
287    C     pfFacMom      - Momentum pressure forcing tracer parameter
288    C     cfFacMom      - Coriolis term tracer parameter
289    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 ).
296    C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
297    C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
298    C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
299    C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
300    C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
301    C                          (note: externForcingCycle must be an integer
302    C                           number times externForcingPeriod)
303          COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
304         & delP, delZ, delR, delX, delY,
305       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
306       & thetaMin, rSphere, f0, fCori, beta, viscAh, viscAz, viscA4,       & thetaMin, rSphere, recip_RSphere, f0, fCori, beta,
307       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,       & viscAh,  viscAz,  viscA4,  viscAr,
308       & tauCD, rCD, freeSurfFac,       & diffKhT, diffKzT, diffK4T, diffKrT,
309       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,       & diffKhS, diffKzS, diffK4S, diffKrS,
310       & gravity, gBaro, rhonil, tRef, sRef,       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
311       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
312       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom,       & gravity, gBaro, rhonil, recip_rhonil,
313       & cAdjFreq       & recip_rhoConst, rhoConst, tRef, sRef,
314         & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
315         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
316         & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
317         & tauSaltClimRelax, lambdaSaltClimRelax,
318         & externForcingCycle, externForcingPeriod,
319         & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
320         & theta_S, specVol_S
321    
322        _RL cg2dTargetResidual        _RL cg2dTargetResidual
323        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
324        _RL delZ(Nz)        _RL delZ(Nr)
325          _RL delP(Nr)
326          _RL delR(Nr)
327        _RL delX(Nx)        _RL delX(Nx)
328        _RL delY(Ny)        _RL delY(Ny)
329        _RL deltaT        _RL deltaT
# Line 222  C     cAdjFreq  - Frequency of convectiv Line 334  C     cAdjFreq  - Frequency of convectiv
334        _RL phiMin        _RL phiMin
335        _RL thetaMin        _RL thetaMin
336        _RL rSphere        _RL rSphere
337          _RL recip_RSphere
338        _RL f0        _RL f0
339        _RL freeSurfFac        _RL freeSurfFac
340          _RL hFacMin
341          _RL hFacMinDz
342          _RL hFacMinDp
343          _RL hFacMinDr
344        _RL beta        _RL beta
345        _RL viscAh        _RL viscAh
346        _RL viscAz        _RL viscAz
347          _RL viscAp
348          _RL viscAr
349        _RL viscA4        _RL viscA4
350        _RL diffKhT        _RL diffKhT
351          _RL diffKrT
352        _RL diffKzT        _RL diffKzT
353          _RL diffKpT
354        _RL diffK4T        _RL diffK4T
355        _RL diffKhS        _RL diffKhS
356          _RL diffKrS
357        _RL diffKzS        _RL diffKzS
358          _RL diffKpS
359        _RL diffK4S        _RL diffK4S
360        _RL delt        _RL delt
361        _RL tauCD        _RL tauCD
# Line 242  C     cAdjFreq  - Frequency of convectiv Line 365  C     cAdjFreq  - Frequency of convectiv
365        _RL GMalpha        _RL GMalpha
366        _RL GMdepth        _RL GMdepth
367        _RL GMkbackground        _RL GMkbackground
368          _RL GMmaxval
369        _RL gravity        _RL gravity
370        _RL gBaro        _RL gBaro
371        _RL rhonil        _RL rhonil
372        _RL tRef(Nz)        _RL recip_rhonil
373        _RL sRef(Nz)        _RL rhoConst
374          _RL recip_rhoConst
375          _RL specVol_S(Nr)
376          _RL tRef(Nr)
377          _RL theta_S(Nr)
378          _RL sRef(Nr)
379        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
380        _RL startTime        _RL startTime
381        _RL endTime        _RL endTime
382        _RL chkPtFreq        _RL chkPtFreq
383        _RL pChkPtFreq        _RL pChkPtFreq
384        _RL dumpFreq        _RL dumpFreq
385          _RL taveFreq
386        _RL afFacMom        _RL afFacMom
387        _RL vfFacMom        _RL vfFacMom
388        _RL pfFacMom        _RL pfFacMom
389        _RL cfFacMom        _RL cfFacMom
390        _RL foFacMom        _RL foFacMom
391          _RL mTFacMom
392        _RL cAdjFreq        _RL cAdjFreq
393          _RL omega
394          _RL tauThetaClimRelax
395          _RL lambdaThetaClimRelax
396          _RL tauSaltClimRelax
397          _RL lambdaSaltClimRelax
398          _RL externForcingCycle
399          _RL externForcingPeriod
400    
401        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,
402       &                Lamba_theta       &                Lamba_theta
# Line 267  C     cAdjFreq  - Frequency of convectiv Line 405  C     cAdjFreq  - Frequency of convectiv
405    
406  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
407        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
408        _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)
409  C Linear equation of state  C Linear equation of state
410  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
411  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     - Linear EOS haline contraction coefficient.
Legend:
Removed from v.1.13  
changed lines
  Added in v.1.29
  ViewVC Help
Powered by ViewVC 1.1.22