/[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.61 by adcroft, Mon Sep 10 01:22:48 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         & multiDimAdvection
219        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
220        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
221          LOGICAL usingCurvilinearGrid
222          LOGICAL usingSphericalPolarMTerms
223          LOGICAL no_slip_sides
224          LOGICAL no_slip_bottom
225          LOGICAL staggerTimeStep
226        LOGICAL momViscosity        LOGICAL momViscosity
227        LOGICAL momAdvection        LOGICAL momAdvection
228        LOGICAL momForcing        LOGICAL momForcing
229          LOGICAL momPressureForcing
230        LOGICAL useCoriolis        LOGICAL useCoriolis
231          LOGICAL vectorInvariantMomentum
232        LOGICAL tempDiffusion        LOGICAL tempDiffusion
233        LOGICAL tempAdvection        LOGICAL tempAdvection
234        LOGICAL tempForcing        LOGICAL tempForcing
235        LOGICAL saltDiffusion        LOGICAL saltDiffusion
236        LOGICAL saltAdvection        LOGICAL saltAdvection
237        LOGICAL saltForcing        LOGICAL saltForcing
238          LOGICAL rigidLid
239          LOGICAL implicitFreeSurface
240          LOGICAL exactConserv
241          LOGICAL uniformLin_PhiSurf
242          LOGICAL momStepping
243          LOGICAL tempStepping
244          LOGICAL saltStepping
245          LOGICAL tr1Stepping
246          LOGICAL metricTerms
247          LOGICAL useConstantF
248          LOGICAL useBetaPlaneF
249          LOGICAL useSphereF
250          LOGICAL implicitDiffusion
251          LOGICAL implicitViscosity
252          LOGICAL doThetaClimRelax
253          LOGICAL doSaltClimRelax
254          LOGICAL doTr1ClimRelax
255          LOGICAL periodicExternalForcing
256          LOGICAL usingPCoords
257          LOGICAL usingZCoords
258          LOGICAL nonHydrostatic
259          LOGICAL globalFiles
260          LOGICAL allowFreezing
261          LOGICAL groundAtK1
262          LOGICAL usePickupBeforeC35
263          LOGICAL debugMode
264          LOGICAL readPickupWithTracer
265          LOGICAL writePickupWithTracer
266          LOGICAL multiDimAdvection
267    
268  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
269  C     cg2dTargetResidual  C     gg2dTargetResidual
270  C               - Target residual for cg2d solver.  C          - Target residual for cg2d solver; no unit (RHS normalisation)
271  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     cg2dTargetResWunit
272  C                 between "w" surfaces.  C          - Target residual for cg2d solver; W unit (No RHS normalisation)
273    C     cg3dTargetResidual
274    C               - Target residual for cg3d solver.
275    C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
276    C     Note. 20th May 1998
277    C           I made a weird discovery! In the model paper we argue
278    C           for the form of the preconditioner used here ( see
279    C           A Finite-volume, Incompressible Navier-Stokes Model
280    C           ...., Marshall et. al ). The algebra gives a simple
281    C           0.5 factor for the averaging of ac and aCw to get a
282    C           symmettric pre-conditioner. By using a factor of 0.51
283    C           i.e. scaling the off-diagonal terms in the
284    C           preconditioner down slightly I managed to get the
285    C           number of iterations for convergence in a test case to
286    C           drop form 192 -> 134! Need to investigate this further!
287    C           For now I have introduced a parameter cg2dpcOffDFac which
288    C           defaults to 0.51 but can be set at runtime.
289    C     delP      - Vertical grid spacing ( Pa ).
290    C     delZ      - Vertical grid spacing ( m  ).
291    C     delR      - Vertical grid spacing ( units of r ).
292  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
293  C     delY        on input flags.  C     delY        on input flags.
294  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
295    C     recip_gravity and its inverse
296    C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )
297  C     ronil     - Reference density  C     ronil     - Reference density
298    C     rhoConst  - Vertically constant reference density
299  C     startTime - Start time for model ( s )  C     startTime - Start time for model ( s )
300  C     phiMin    - Latitude of southern most cell face.  C     phiMin    - Latitude of southern most cell face.
301  C     thetaMin  - Longitude of western most cell face (this  C     thetaMin  - Longitude of western most cell face (this
302  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
303  C                 to make geographical references simple.)  C                 to make geographical references simple.)
304  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).
305    C     recip_RSphere  - Reciprocal radius of sphere ( m ).
306  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        - Reference coriolis parameter ( 1/s )
307  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
308  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      - df/dy ( s^-1.m^-1 )
309    C     omega     - Angular velocity ( rad/s )
310  C     viscAh    - Eddy viscosity coeff. for mixing of  C     viscAh    - Eddy viscosity coeff. for mixing of
311  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
312  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    - Eddy viscosity coeff. for mixing of
313  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
314    C     viscAp    - Eddy viscosity coeff. for mixing of
315    C                 momentum vertically ( Pa^2/s )
316    C     viscAr    - Eddy viscosity coeff. for mixing of
317    C                 momentum vertically ( units of r^2/s )
318  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscA4    - Biharmonic viscosity coeff. for mixing of
319  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
320  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   - Laplacian diffusion coeff. for mixing of
321  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
322  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   - Laplacian diffusion coeff. for mixing of
323  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
324    C     diffKpT   - Laplacian diffusion coeff. for mixing of
325    C                 heat vertically ( Pa^2/s )
326    C     diffKrT   - Laplacian diffusion coeff. for mixing of
327    C                 heat vertically ( units of r^2/s )
328  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   - Biharmonic diffusion coeff. for mixing of
329  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
330  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  -  Laplacian diffusion coeff. for mixing of
331  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
332  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   - Laplacian diffusion coeff. for mixing of
333  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
334    C     diffKpS   - Laplacian diffusion coeff. for mixing of
335    C                 salt vertically ( Pa^2/s )
336    C     diffKrS   - Laplacian diffusion coeff. for mixing of
337    C                 salt vertically ( units of r^2/s )
338  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   - Biharmonic diffusion coeff. for mixing of
339  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
340  C     deltaT    - Default timestep ( s )  C     deltaT    - Default timestep ( s )
341    C     deltaTClock  - Timestep used as model "clock". This determines the
342    C                    IO frequencies and is used in tagging output. It can
343    C                    be totally different to the dynamical time. Typically
344    C                    it will be the deep-water timestep for accelerated runs.
345    C                    Frequency of checkpointing and dumping of the model state
346    C                    are referenced to this clock. ( s )
347  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    - Timestep for momemtum equations ( s )
348  C     deltaTtracer - Timestep for tracer equations ( s )  C     deltaTtracer - Timestep for tracer equations ( s )
349  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     freesurfFac  - Parameter to turn implicit free surface term on or off
350  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C                    freesurfac = 1. uses implicit free surface
351  C     startTime - Starting time for this integration ( s ).  C                    freesurfac = 0. uses rigid lid
352  C     endTime   - Ending time for this integration ( s ).  C     implicSurfPress - parameter of the Crank-Nickelson time stepping :
353  C     chkPtFreq - Frequency of check pointing ( s ).  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
354  C     dumpFreq  - Frequency with which model state is written to  C     implicDiv2Dflow - parameter of the Crank-Nickelson time stepping :
355  C                 post-processing files ( s ).  C                     Implicit part of barotropic flow Divergence ( 0-1 )
356        COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY, deltaT,  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
357       & deltaTmom, deltaTtracer, abeps, startTime, phiMin, thetaMin,  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
358       & rSphere, f0, fCori, beta, viscAh, viscAz, viscA4, diffKhT, diffKzT,  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
359       & diffK4T, diffKhS, diffKzS, diffK4S, delT, tauCD, rCD,  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
360       & tAlpha, sBeta, gravity, rhonil, tRef, sRef,  C     hFacInf      - Threshold (inf and sup) for fraction size of surface cell
361       & endTime, chkPtFreq, dumpFreq  C     hFacSup        that control vanishing and creating levels
362        REAL cg2dTargetResidual  C     tauCD        - CD scheme coupling timescale ( 1/s )
363        REAL delZ(Nz)  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
364        REAL delX(Nx)  C     startTime     - Starting time for this integration ( s ).
365        REAL delY(Ny)  C     endTime       - Ending time for this integration ( s ).
366        REAL deltaT  C     chkPtFreq     - Frequency of rolling check pointing ( s ).
367        REAL deltaTmom  C     pChkPtFreq    - Frequency of permanent check pointing ( s ).
368        REAL deltaTtracer  C     dumpFreq      - Frequency with which model state is written to
369        REAL abeps  C                     post-processing files ( s ).
370        REAL phiMin  C     diagFreq      - Frequency with which model writes diagnostic output
371        REAL thetaMin  C                     of intermediate quantities.
372        REAL rSphere  C     afFacMom      - Advection of momentum term tracer parameter
373        REAL f0  C     vfFacMom      - Momentum viscosity tracer parameter
374        _RL  beta  C     pfFacMom      - Momentum pressure forcing tracer parameter
375        REAL viscAh  C     cfFacMom      - Coriolis term tracer parameter
376        REAL viscAz  C     foFacMom      - Momentum forcing tracer parameter
377        REAL viscA4  C     mtFacMom      - Metric terms tracer parameter
378        REAL diffKhT  C     cosPower      - Power of cosine of latitude to multiply viscosity
379        REAL diffKzT  C     cAdjFreq      - Frequency of convective adjustment
380        REAL diffK4T  C
381        REAL diffKhS  C     taveFreq      - Frequency with which time-averaged model state is written to
382        REAL diffKzS  C                     post-processing files ( s ).
383        REAL diffK4S  C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).
384        REAL delt  C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
385        REAL tauCD  C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
386        REAL rCD  C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
387        REAL tAlpha  C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
388        REAL sBeta  C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
389        REAL gravity  C                          (note: externForcingCycle must be an integer
390        REAL rhonil  C                           number times externForcingPeriod)
391        REAL tRef(Nz)  C     horiVertRatio      - Ratio on units in vertical to units in horizontal.
392        REAL sRef(Nz)  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
393        real Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  C                          ( g*rho if horiz in m and vertical in Pa ).
394        REAL startTime  C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
395        REAL endTime  C                          circles ( see filter*.F )
396        REAL chkPtFreq  C     Ro_SeaLevel        - standard position of Sea-Level in "R" coordinate, used as
397        REAL dumpFreq  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
398        COMMON /PARM_A/ HeatCapacity_Cp,  C     bottomDragLinear   - Drag coefficient built in to core dynamics
399    C         "     Quadratic  ( linear: 1/s, quadratic: 1/m )
400          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
401         & cg2dpcOffDFac, cg3dTargetResidual,
402         & delP, delZ, delR, delX, delY,
403         & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
404         & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
405         & fCori, fCoriG,
406         & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,
407         & diffKhT, diffKzT, diffK4T, diffKrT,
408         & diffKhS, diffKzS, diffK4S, diffKrS,
409         & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
410         & hFacMin, hFacMinDz, hFacInf, hFacSup,
411         & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
412         & recip_rhoConst, rhoConst, tRef, sRef,
413         & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
414         & diagFreq, taveFreq, monitorFreq,
415         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
416         & cosPower, cAdjFreq, omega,
417         & tauThetaClimRelax, lambdaThetaClimRelax,
418         & tauSaltClimRelax, lambdaSaltClimRelax,
419         & tauTr1ClimRelax, lambdaTr1ClimRelax,
420         & externForcingCycle, externForcingPeriod,
421         & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
422         & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
423         & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,
424         & bottomDragLinear,bottomDragQuadratic
425    
426          _RL cg2dTargetResidual
427          _RL cg2dTargetResWunit
428          _RL cg3dTargetResidual
429          _RL cg2dpcOffDFac
430          _RL delZ(Nr)
431          _RL delP(Nr)
432          _RL delR(Nr)
433          _RL delX(Nx)
434          _RL delY(Ny)
435          _RL deltaT
436          _RL deltaTClock
437          _RL deltaTmom
438          _RL deltaTtracer
439          _RL abeps
440          _RL phiMin
441          _RL thetaMin
442          _RL rSphere
443          _RL recip_RSphere
444          _RL f0
445          _RL freeSurfFac
446          _RL implicSurfPress
447          _RL implicDiv2Dflow
448          _RL hFacMin
449          _RL hFacMinDz
450          _RL hFacMinDp
451          _RL hFacMinDr
452          _RL hFacInf
453          _RL hFacSup
454          _RL beta
455          _RL viscAh
456          _RL viscAstrain
457          _RL viscAtension
458          _RL viscAz
459          _RL viscAp
460          _RL viscAr
461          _RL viscA4
462          _RL diffKhT
463          _RL diffKrT
464          _RL diffKzT
465          _RL diffKpT
466          _RL diffK4T
467          _RL diffKhS
468          _RL diffKrS
469          _RL diffKzS
470          _RL diffKpS
471          _RL diffK4S
472          _RL delt
473          _RL tauCD
474          _RL rCD
475          _RL gravity
476          _RL recip_gravity
477          _RL gBaro
478          _RL rhonil
479          _RL recip_rhonil
480          _RL rhoConst
481          _RL recip_rhoConst
482          _RL specVol_S(Nr)
483          _RL tRef(Nr)
484          _RL theta_S(Nr)
485          _RL sRef(Nr)
486          _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
487          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
488          _RL startTime
489          _RL endTime
490          _RL chkPtFreq
491          _RL pChkPtFreq
492          _RL dumpFreq
493          _RL diagFreq
494          _RL taveFreq
495          _RL monitorFreq
496          _RL afFacMom
497          _RL vfFacMom
498          _RL pfFacMom
499          _RL cfFacMom
500          _RL foFacMom
501          _RL mTFacMom
502          _RL cosPower
503          _RL cAdjFreq
504          _RL omega
505          _RL tauThetaClimRelax
506          _RL lambdaThetaClimRelax
507          _RL tauSaltClimRelax
508          _RL lambdaSaltClimRelax
509          _RL tauTr1ClimRelax
510          _RL lambdaTr1ClimRelax
511          _RL externForcingCycle
512          _RL externForcingPeriod
513          _RL horiVertRatio
514          _RL recip_horiVertRatio
515          _RL latFFTFiltLo
516          _RL ivdc_kappa
517          _RL Ro_SeaLevel
518          _RL zonal_filt_lat
519          _RL bottomDragLinear
520          _RL bottomDragQuadratic
521    
522          COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
523       &                Lamba_theta       &                Lamba_theta
524        REAL HeatCapacity_Cp        _RL HeatCapacity_Cp
525        REAL Lamba_theta        _RL Lamba_theta
526          _RL recip_Cp
527    
528    C Equation of State (polynomial coeffients)
529          COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
530          _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
531    C Linear equation of state
532    C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
533    C     sBeta     - Linear EOS haline contraction coefficient.
534          COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
535          _RL tAlpha
536          _RL sBeta
537          character*(6) eosType
538    
539    C Atmospheric physical parameters (Ideal Gas EOS, ...)
540    C     atm_po    - standard reference pressure
541    C     atm_cp    - specific heat (Cp) of the (dry) air at constant pressure
542    C     atm_kappa - kappa = R/Cp (R: constant of Ideal Gas EOS)
543    C     Integr_GeoPot - option to select the way we integrate the geopotential
544    C                     (still a subject of discussions ...)
545          COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,
546         &                  Integr_GeoPot
547          _RL atm_cp, atm_kappa, atm_po
548          INTEGER Integr_GeoPot
549    
550    C Logical flags for selecting packages
551          LOGICAL useKPP
552          LOGICAL useGMRedi
553          LOGICAL useOBCS
554          LOGICAL useAIM
555          LOGICAL useGrdchk
556          LOGICAL useECCO
557          LOGICAL useSHAP_FILT
558          COMMON /PARM_PACKAGES/
559         &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
560         &        useSHAP_FILT, useGrdchk
561    

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

  ViewVC Help
Powered by ViewVC 1.1.22