/[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.3 by cnh, Sun Apr 26 23:41:54 1998 UTC revision 1.59 by adcroft, Fri Aug 17 18:40:30 2001 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2    C $Name$
3  C  C
4  C     /==========================================================\  C     /==========================================================\
5  C     | PARAMS.h                                                 |  C     | PARAMS.h                                                 |
6  C     | o Header file defining model "parameters".               |  C     | o Header file defining model "parameters".               |
7  C     |==========================================================|  C     |==========================================================|
8  C     | The values from the model's standard input file are      |  C     | The values from the model standard input file are        |
9  C     | stored into the variables held here. Notes describing    |  C     | stored into the variables held here. Notes describing    |
10  C     | the parameters can also be found here.                   |  C     | the parameters can also be found here.                   |
11  C     \==========================================================/  C     \==========================================================/
12    
13    C     Macros for special grid options
14    #include "PARAMS_MACROS.h"
15    
16  C--   Contants  C--   Contants
 C     nOBands - No. of offline data time bands  
       INTEGER nOBands  
       PARAMETER ( nOBands = 12 )  
17  C     Useful physical values  C     Useful physical values
18        Real*8 PI        Real*8 PI
19        PARAMETER ( PI    = 3.14159265358979323844D0   )        PARAMETER ( PI    = 3.14159265358979323844D0   )
20        Real*8 deg2rad        Real*8 deg2rad
21        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
22    
23    C     Symbolic values
24    C     precXXXX - Used to indicate what precision to use for
25    C                dumping model state.
26          INTEGER precFloat32
27          PARAMETER ( precFloat32 = 32 )
28          INTEGER precFloat64
29          PARAMETER ( precFloat64 = 64 )
30    C     UNSET_xxx - Used to indicate variables that have not been given a value
31          Real*8 UNSET_FLOAT8
32          PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
33          Real*4 UNSET_FLOAT4
34          PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
35          _RL    UNSET_RL    
36          PARAMETER ( UNSET_RL     = 1.234567D5 )
37          _RS    UNSET_RS    
38          PARAMETER ( UNSET_RS     = 1.234567E5 )
39          INTEGER UNSET_I
40          PARAMETER ( UNSET_I      = 123456789  )
41    
42    C     Checkpoint data
43          INTEGER maxNoChkptLev
44          PARAMETER ( maxNoChkptLev = 2 )
45    
46  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
47  C     oBandId  - Offline dataset identifiers for different periods.  C     checkPtSuff - List of checkpoint file suffices
48        COMMON /PARM_C/ oBandId  C     bathyFile   - File containing bathymetry. If not defined bathymetry
49        CHARACTER*3 oBandId(nOBands)  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
53    C                       temperature.
54    C     hydrogSaltFile  - File containing initial hydrographic data for salinity.
55    C     zonalWindFile   - File containing zonal wind data
56    C     meridWindFile   - File containing meridional wind data
57    C     thetaClimFile   - File containing theta climataology used
58    C                       in relaxation term -lambda(theta-theta*)
59    C     saltClimFile    - File containing salt climataology used
60    C                       in relaxation term -lambda(salt-salt*)
61    C     surfQfile       - File containing surface heat flux
62    C     surfQswfile     - File containing surface shortwave radiation
63    C     dQdTfile        - File containing thermal relaxation coefficient
64    C     EmPmRfile       - File containing surface fresh water flux
65    C     buoyancyRelation - Flag used to indicate which relation to use to
66    C                        get buoyancy.
67          COMMON /PARM_C/ checkPtSuff,
68         &                bathyFile, topoFile,
69         &                hydrogThetaFile, hydrogSaltFile,
70         &                zonalWindFile, meridWindFile, thetaClimFile,
71         &                saltClimFile, buoyancyRelation,
72         &                EmPmRfile, surfQfile, surfQswfile,
73         &                uVelInitFile, vVelInitFile, pSurfInitFile,
74         &                dQdTfile
75          CHARACTER*(5) checkPtSuff(maxNoChkptLev)
76          CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
77          CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
78          CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
79          CHARACTER*(MAX_LEN_FNAM) zonalWindFile
80          CHARACTER*(MAX_LEN_FNAM) meridWindFile
81          CHARACTER*(MAX_LEN_FNAM) thetaClimFile
82          CHARACTER*(MAX_LEN_FNAM) saltClimFile
83          CHARACTER*(MAX_LEN_FNAM) surfQfile
84          CHARACTER*(MAX_LEN_FNAM) surfQswfile
85          CHARACTER*(MAX_LEN_FNAM) EmPmRfile
86          CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
87          CHARACTER*(MAX_LEN_FNAM) uVelInitFile
88          CHARACTER*(MAX_LEN_FNAM) vVelInitFile
89          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
94  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
95  C     cg2dChkResFreq      - Frequency with which to check residual  C     cg2dChkResFreq      - Frequency with which to check residual
96  C                           in con. grad solver.  C                           in con. grad solver.
97    C     cg3dMaxIters        - Maximum number of iterations in the
98    C                           three-dimensional con. grad solver.
99    C     cg3dChkResFreq      - Frequency with which to check residual
100    C                           in con. grad solver.
101  C     nIter0              - Start time-step number of for this run  C     nIter0              - Start time-step number of for this run
102  C     nTimeSteps          - Number of timesteps to execute  C     nTimeSteps          - Number of timesteps to execute
103  C     numStepsPerPickup   - For offline setup. Frequency of pickup  C     numStepsPerPickup   - For offline setup. Frequency of pickup
104  C                           of flow fields.  C                           of flow fields.
105    C     writeStatePrec      - Precision used for writing model state.
106    C     writeBinaryPrec     - Precision used for writing binary files
107    C     readBinaryPrec      - Precision used for reading binary files
108    C     nCheckLev           - Holds current checkpoint level
109    C     nonlinFreeSurf      - option related to non-linear free surface
110    C                           =0 Linear free surface ; >0 Non-linear
111    
112        COMMON /PARM_I/        COMMON /PARM_I/
113       &        cg2dMaxIters,       &        cg2dMaxIters,
114       &        cg2dChkResFreq,       &        cg2dChkResFreq,
115       &        nIter0, nTimeSteps,       &        cg3dMaxIters,
116       &        numStepsPerPickup       &        cg3dChkResFreq,
117         &        nIter0, nTimeSteps, nEndIter,
118         &        numStepsPerPickup,
119         &        writeStatePrec, nCheckLev,
120         &        writeBinaryPrec, readBinaryPrec,
121         &        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
127          INTEGER cg3dChkResFreq
128        INTEGER nIter0        INTEGER nIter0
129        INTEGER nTimeSteps        INTEGER nTimeSteps
130          INTEGER nEndIter
131        INTEGER numStepsPerPickup        INTEGER numStepsPerPickup
132          INTEGER writeStatePrec
133          INTEGER writeBinaryPrec
134          INTEGER readBinaryPrec
135          INTEGER nCheckLev
136          INTEGER nonlinFreeSurf
137          INTEGER zonal_filt_sinpow
138          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
145  C                          coordinate frame.  C                          coordinate frame.
146  C     usingSphericalPolarGrid - If TRUE grid generation will be in a  C     usingSphericalPolarGrid - If TRUE grid generation will be in a
147  C                               spherical polar frame.  C                               spherical polar frame.
148    C     no_slip_sides - Impose "no-slip" at lateral boundaries.
149    C     no_slip_bottom- Impose "no-slip" at bottom boundary.
150    C     staggerTimeStep - enable a Stagger time stepping T,S Rho then U,V
151  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     momViscosity  - Flag which turns momentum friction terms on and off.
152  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momAdvection  - Flag which turns advection of momentum on and off.
153  C     momForcing    - Flag which turns external forcing of momentum on  C     momForcing    - Flag which turns external forcing of momentum on
154  C                     and off.  C                     and off.
155    C     momPressureForcing - Flag which turns pressure term in momentum equation
156    C                          on and off.
157    C     metricTerms   - Flag which turns metric terms on or off.
158    C     usingSphericalPolarMTerms - If TRUE use spherical polar metric terms.
159  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     useCoriolis   - Flag which turns the coriolis terms on and off.
160  C     tempDiffusion - Flag which turns diffusion of temperature on  C     tempDiffusion - Flag which turns diffusion of temperature on
161  C                     and off.  C                     and off.
# Line 65  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.
172    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
178    C     tempStepping  - Turns temperature equation time-stepping off
179    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
182    C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
183    C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
184    C     implicitDiffusion - Turns implicit vertical diffusion on
185    C     implicitViscosity - Turns implicit vertical viscosity on
186    C     doThetaClimRelax - Set true if relaxation to temperature
187    C                        climatology is required.
188    C     doSaltClimRelax  - Set true if relaxation to salinity
189    C                        climatology is required.
190    C     periodicExternalForcing - Set true if forcing is time-dependant
191    C     usingPCoords     - Set to indicate that we are working in pressure
192    C                        coords.
193    C     usingZCoords     - Set to indicate that we are working in height
194    C                        coords.
195    C     nonHydrostatic - Using non-hydrostatic terms
196    C     globalFiles    - Selects between "global" and "tiled" files
197    C     allowFreezing  - Allows water to freeze and form ice
198    C     groundAtK1  - put the surface(k=1) at the Lower Boundary (=ground)
199        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
200       & momViscosity, momAdvection, momForcing, useCoriolis,       & usingCurvilinearGrid,
201         & no_slip_sides,no_slip_bottom,
202         & staggerTimeStep,
203         & momViscosity, momAdvection, momForcing, useCoriolis,
204         & momPressureForcing, vectorInvariantMomentum,
205       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
206       & saltDiffusion, saltAdvection, saltForcing       & saltDiffusion, saltAdvection, saltForcing,
207         & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
208         & momStepping, tempStepping, saltStepping, tr1Stepping,
209         & metricTerms, usingSphericalPolarMTerms,
210         & useConstantF, useBetaPlaneF, useSphereF,
211         & implicitDiffusion, implicitViscosity,
212         & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
213         & periodicExternalForcing, usingPCoords, usingZCoords,
214         & nonHydrostatic, globalFiles,
215         & allowFreezing, groundAtK1,
216         & usePickupBeforeC35, debugMode,
217         & readPickupWithTracer, writePickupWithTracer
218        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
219        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
220          LOGICAL usingCurvilinearGrid
221          LOGICAL usingSphericalPolarMTerms
222          LOGICAL no_slip_sides
223          LOGICAL no_slip_bottom
224          LOGICAL staggerTimeStep
225        LOGICAL momViscosity        LOGICAL momViscosity
226        LOGICAL momAdvection        LOGICAL momAdvection
227        LOGICAL momForcing        LOGICAL momForcing
228          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
237          LOGICAL rigidLid
238          LOGICAL implicitFreeSurface
239          LOGICAL exactConserv
240          LOGICAL uniformLin_PhiSurf
241          LOGICAL momStepping
242          LOGICAL tempStepping
243          LOGICAL saltStepping
244          LOGICAL tr1Stepping
245          LOGICAL metricTerms
246          LOGICAL useConstantF
247          LOGICAL useBetaPlaneF
248          LOGICAL useSphereF
249          LOGICAL implicitDiffusion
250          LOGICAL implicitViscosity
251          LOGICAL doThetaClimRelax
252          LOGICAL doSaltClimRelax
253          LOGICAL doTr1ClimRelax
254          LOGICAL periodicExternalForcing
255          LOGICAL usingPCoords
256          LOGICAL usingZCoords
257          LOGICAL nonHydrostatic
258          LOGICAL globalFiles
259          LOGICAL allowFreezing
260          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     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     cg2dTargetResWunit
270  C                 between "w" surfaces.  C          - Target residual for cg2d solver; W unit (No RHS normalisation)
271    C     cg3dTargetResidual
272    C               - Target residual for cg3d solver.
273    C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
274    C     Note. 20th May 1998
275    C           I made a weird discovery! In the model paper we argue
276    C           for the form of the preconditioner used here ( see
277    C           A Finite-volume, Incompressible Navier-Stokes Model
278    C           ...., Marshall et. al ). The algebra gives a simple
279    C           0.5 factor for the averaging of ac and aCw to get a
280    C           symmettric pre-conditioner. By using a factor of 0.51
281    C           i.e. scaling the off-diagonal terms in the
282    C           preconditioner down slightly I managed to get the
283    C           number of iterations for convergence in a test case to
284    C           drop form 192 -> 134! Need to investigate this further!
285    C           For now I have introduced a parameter cg2dpcOffDFac which
286    C           defaults to 0.51 but can be set at runtime.
287    C     delP      - Vertical grid spacing ( Pa ).
288    C     delZ      - Vertical grid spacing ( m  ).
289    C     delR      - Vertical grid spacing ( units of r ).
290  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
291  C     delY        on input flags.  C     delY        on input flags.
292  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
293    C     recip_gravity and its inverse
294    C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )
295  C     ronil     - Reference density  C     ronil     - Reference density
296    C     rhoConst  - Vertically constant reference density
297  C     startTime - Start time for model ( s )  C     startTime - Start time for model ( s )
298  C     phiMin    - Latitude of southern most cell face.  C     phiMin    - Latitude of southern most cell face.
299  C     thetaMin  - Longitude of western most cell face (this  C     thetaMin  - Longitude of western most cell face (this
300  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
301  C                 to make geographical references simple.)  C                 to make geographical references simple.)
302  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).
303    C     recip_RSphere  - Reciprocal radius of sphere ( m ).
304  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        - Reference coriolis parameter ( 1/s )
305  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
306  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      - df/dy ( s^-1.m^-1 )
307    C     omega     - Angular velocity ( rad/s )
308  C     viscAh    - Eddy viscosity coeff. for mixing of  C     viscAh    - Eddy viscosity coeff. for mixing of
309  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
310  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    - Eddy viscosity coeff. for mixing of
311  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
312    C     viscAp    - Eddy viscosity coeff. for mixing of
313    C                 momentum vertically ( Pa^2/s )
314    C     viscAr    - Eddy viscosity coeff. for mixing of
315    C                 momentum vertically ( units of r^2/s )
316  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscA4    - Biharmonic viscosity coeff. for mixing of
317  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
318  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   - Laplacian diffusion coeff. for mixing of
319  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
320  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   - Laplacian diffusion coeff. for mixing of
321  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
322    C     diffKpT   - Laplacian diffusion coeff. for mixing of
323    C                 heat vertically ( Pa^2/s )
324    C     diffKrT   - Laplacian diffusion coeff. for mixing of
325    C                 heat vertically ( units of r^2/s )
326  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   - Biharmonic diffusion coeff. for mixing of
327  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
328  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  -  Laplacian diffusion coeff. for mixing of
329  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
330  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   - Laplacian diffusion coeff. for mixing of
331  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
332    C     diffKpS   - Laplacian diffusion coeff. for mixing of
333    C                 salt vertically ( Pa^2/s )
334    C     diffKrS   - Laplacian diffusion coeff. for mixing of
335    C                 salt vertically ( units of r^2/s )
336  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   - Biharmonic diffusion coeff. for mixing of
337  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
338  C     deltaT    - Default timestep ( s )  C     deltaT    - Default timestep ( s )
339    C     deltaTClock  - Timestep used as model "clock". This determines the
340    C                    IO frequencies and is used in tagging output. It can
341    C                    be totally different to the dynamical time. Typically
342    C                    it will be the deep-water timestep for accelerated runs.
343    C                    Frequency of checkpointing and dumping of the model state
344    C                    are referenced to this clock. ( s )
345  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    - Timestep for momemtum equations ( s )
346  C     deltaTtracer - Timestep for tracer equations ( s )  C     deltaTtracer - Timestep for tracer equations ( s )
347  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     freesurfFac  - Parameter to turn implicit free surface term on or off
348  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C                    freesurfac = 1. uses implicit free surface
349  C     startTime - Starting time for this integration ( s ).  C                    freesurfac = 0. uses rigid lid
350  C     endTime   - Ending time for this integration ( s ).  C     implicSurfPress - parameter of the Crank-Nickelson time stepping :
351  C     chkPtFreq - Frequency of check pointing ( s ).  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
352  C     dumpFreq  - Frequency with which model state is written to  C     implicDiv2Dflow - parameter of the Crank-Nickelson time stepping :
353  C                 post-processing files ( s ).  C                     Implicit part of barotropic flow Divergence ( 0-1 )
354        COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY, deltaT,  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
355       & deltaTmom, deltaTtracer, abeps, startTime, phiMin, thetaMin,  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
356       & rSphere, f0, fCori, beta, viscAh, viscAz, viscA4, diffKhT, diffKzT,  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
357       & diffK4T, diffKhS, diffKzS, diffK4S, delT, tauCD, rCD,  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
358       & tAlpha, sBeta, gravity, rhonil, tRef, sRef,  C     hFacInf      - Threshold (inf and sup) for fraction size of surface cell
359       & endTime, chkPtFreq, dumpFreq  C     hFacSup        that control vanishing and creating levels
360        REAL cg2dTargetResidual  C     tauCD        - CD scheme coupling timescale ( 1/s )
361        REAL delZ(Nz)  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
362        REAL delX(Nx)  C     startTime     - Starting time for this integration ( s ).
363        REAL delY(Ny)  C     endTime       - Ending time for this integration ( s ).
364        REAL deltaT  C     chkPtFreq     - Frequency of rolling check pointing ( s ).
365        REAL deltaTmom  C     pChkPtFreq    - Frequency of permanent check pointing ( s ).
366        REAL deltaTtracer  C     dumpFreq      - Frequency with which model state is written to
367        REAL abeps  C                     post-processing files ( s ).
368        REAL phiMin  C     diagFreq      - Frequency with which model writes diagnostic output
369        REAL thetaMin  C                     of intermediate quantities.
370        REAL rSphere  C     afFacMom      - Advection of momentum term tracer parameter
371        REAL f0  C     vfFacMom      - Momentum viscosity tracer parameter
372        _RL  beta  C     pfFacMom      - Momentum pressure forcing tracer parameter
373        REAL viscAh  C     cfFacMom      - Coriolis term tracer parameter
374        REAL viscAz  C     foFacMom      - Momentum forcing tracer parameter
375        REAL viscA4  C     mtFacMom      - Metric terms tracer parameter
376        REAL diffKhT  C     cosPower      - Power of cosine of latitude to multiply viscosity
377        REAL diffKzT  C     cAdjFreq      - Frequency of convective adjustment
378        REAL diffK4T  C
379        REAL diffKhS  C     taveFreq      - Frequency with which time-averaged model state is written to
380        REAL diffKzS  C                     post-processing files ( s ).
381        REAL diffK4S  C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).
382        REAL delt  C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
383        REAL tauCD  C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
384        REAL rCD  C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
385        REAL tAlpha  C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
386        REAL sBeta  C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
387        REAL gravity  C                          (note: externForcingCycle must be an integer
388        REAL rhonil  C                           number times externForcingPeriod)
389        REAL tRef(Nz)  C     horiVertRatio      - Ratio on units in vertical to units in horizontal.
390        REAL sRef(Nz)  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
391        real Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  C                          ( g*rho if horiz in m and vertical in Pa ).
392        REAL startTime  C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
393        REAL endTime  C                          circles ( see filter*.F )
394        REAL chkPtFreq  C     Ro_SeaLevel        - standard position of Sea-Level in "R" coordinate, used as
395        REAL dumpFreq  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
396        COMMON /PARM_A/ HeatCapacity_Cp,  C     bottomDragLinear   - Drag coefficient built in to core dynamics
397    C         "     Quadratic  ( linear: 1/s, quadratic: 1/m )
398          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
399         & cg2dpcOffDFac, cg3dTargetResidual,
400         & delP, delZ, delR, delX, delY,
401         & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
402         & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
403         & fCori, fCoriG,
404         & viscAh,  viscAz,  viscA4,  viscAr,
405         & diffKhT, diffKzT, diffK4T, diffKrT,
406         & diffKhS, diffKzS, diffK4S, diffKrS,
407         & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
408         & hFacMin, hFacMinDz, hFacInf, hFacSup,
409         & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
410         & recip_rhoConst, rhoConst, tRef, sRef,
411         & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
412         & diagFreq, taveFreq, monitorFreq,
413         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
414         & cosPower, cAdjFreq, omega,
415         & tauThetaClimRelax, lambdaThetaClimRelax,
416         & tauSaltClimRelax, lambdaSaltClimRelax,
417         & tauTr1ClimRelax, lambdaTr1ClimRelax,
418         & externForcingCycle, externForcingPeriod,
419         & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
420         & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
421         & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,
422         & bottomDragLinear,bottomDragQuadratic
423    
424          _RL cg2dTargetResidual
425          _RL cg2dTargetResWunit
426          _RL cg3dTargetResidual
427          _RL cg2dpcOffDFac
428          _RL delZ(Nr)
429          _RL delP(Nr)
430          _RL delR(Nr)
431          _RL delX(Nx)
432          _RL delY(Ny)
433          _RL deltaT
434          _RL deltaTClock
435          _RL deltaTmom
436          _RL deltaTtracer
437          _RL abeps
438          _RL phiMin
439          _RL thetaMin
440          _RL rSphere
441          _RL recip_RSphere
442          _RL f0
443          _RL freeSurfFac
444          _RL implicSurfPress
445          _RL implicDiv2Dflow
446          _RL hFacMin
447          _RL hFacMinDz
448          _RL hFacMinDp
449          _RL hFacMinDr
450          _RL hFacInf
451          _RL hFacSup
452          _RL beta
453          _RL viscAh
454          _RL viscAz
455          _RL viscAp
456          _RL viscAr
457          _RL viscA4
458          _RL diffKhT
459          _RL diffKrT
460          _RL diffKzT
461          _RL diffKpT
462          _RL diffK4T
463          _RL diffKhS
464          _RL diffKrS
465          _RL diffKzS
466          _RL diffKpS
467          _RL diffK4S
468          _RL delt
469          _RL tauCD
470          _RL rCD
471          _RL gravity
472          _RL recip_gravity
473          _RL gBaro
474          _RL rhonil
475          _RL recip_rhonil
476          _RL rhoConst
477          _RL recip_rhoConst
478          _RL specVol_S(Nr)
479          _RL tRef(Nr)
480          _RL theta_S(Nr)
481          _RL sRef(Nr)
482          _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
483          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
484          _RL startTime
485          _RL endTime
486          _RL chkPtFreq
487          _RL pChkPtFreq
488          _RL dumpFreq
489          _RL diagFreq
490          _RL taveFreq
491          _RL monitorFreq
492          _RL afFacMom
493          _RL vfFacMom
494          _RL pfFacMom
495          _RL cfFacMom
496          _RL foFacMom
497          _RL mTFacMom
498          _RL cosPower
499          _RL cAdjFreq
500          _RL omega
501          _RL tauThetaClimRelax
502          _RL lambdaThetaClimRelax
503          _RL tauSaltClimRelax
504          _RL lambdaSaltClimRelax
505          _RL tauTr1ClimRelax
506          _RL lambdaTr1ClimRelax
507          _RL externForcingCycle
508          _RL externForcingPeriod
509          _RL horiVertRatio
510          _RL recip_horiVertRatio
511          _RL latFFTFiltLo
512          _RL ivdc_kappa
513          _RL Ro_SeaLevel
514          _RL zonal_filt_lat
515          _RL bottomDragLinear
516          _RL bottomDragQuadratic
517    
518          COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
519       &                Lamba_theta       &                Lamba_theta
520        REAL HeatCapacity_Cp        _RL HeatCapacity_Cp
521        REAL Lamba_theta        _RL Lamba_theta
522          _RL recip_Cp
523    
524    C Equation of State (polynomial coeffients)
525          COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
526          _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
527    C Linear equation of state
528    C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
529    C     sBeta     - Linear EOS haline contraction coefficient.
530          COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
531          _RL tAlpha
532          _RL sBeta
533          character*(6) eosType
534    
535    C Atmospheric physical parameters (Ideal Gas EOS, ...)
536    C     atm_po    - standard reference pressure
537    C     atm_cp    - specific heat (Cp) of the (dry) air at constant pressure
538    C     atm_kappa - kappa = R/Cp (R: constant of Ideal Gas EOS)
539    C     Integr_GeoPot - option to select the way we integrate the geopotential
540    C                     (still a subject of discussions ...)
541          COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,
542         &                  Integr_GeoPot
543          _RL atm_cp, atm_kappa, atm_po
544          INTEGER Integr_GeoPot
545    
546    C Logical flags for selecting packages
547          LOGICAL useKPP
548          LOGICAL useGMRedi
549          LOGICAL useOBCS
550          LOGICAL useAIM
551          LOGICAL useGrdchk
552          LOGICAL useECCO
553          LOGICAL useSHAP_FILT
554          COMMON /PARM_PACKAGES/
555         &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
556         &        useSHAP_FILT, useGrdchk
557    

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.59

  ViewVC Help
Powered by ViewVC 1.1.22