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