/[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.45 by heimbach, Mon Sep 11 23:12:20 2000 UTC
# Line 4  C     /================================= Line 4  C     /=================================
4  C     | PARAMS.h                                                 |  C     | PARAMS.h                                                 |
5  C     | o Header file defining model "parameters".               |  C     | o Header file defining model "parameters".               |
6  C     |==========================================================|  C     |==========================================================|
7  C     | The values from the model's standard input file are      |  C     | The values from the model standard input file are        |
8  C     | stored into the variables held here. Notes describing    |  C     | stored into the variables held here. Notes describing    |
9  C     | the parameters can also be found here.                   |  C     | the parameters can also be found here.                   |
10  C     \==========================================================/  C     \==========================================================/
11    
12    C     Macros for special grid options
13    #include "PARAMS_MACROS.h"
14    
15  C--   Contants  C--   Contants
 C     nOBands - No. of offline data time bands  
       INTEGER nOBands  
       PARAMETER ( nOBands = 12 )  
16  C     Useful physical values  C     Useful physical values
17        Real*8 PI        Real*8 PI
18        PARAMETER ( PI    = 3.14159265358979323844D0   )        PARAMETER ( PI    = 3.14159265358979323844D0   )
19        Real*8 deg2rad        Real*8 deg2rad
20        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
21    
22    C     Symbolic values
23    C     precXXXX - Used to indicate what precision to use for
24    C                dumping model state.
25          INTEGER precFloat32
26          PARAMETER ( precFloat32 = 32 )
27          INTEGER precFloat64
28          PARAMETER ( precFloat64 = 64 )
29    C     UNSET_xxx - Used to indicate variables that have not been given a value
30          Real*8 UNSET_FLOAT8
31          PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
32          Real*4 UNSET_FLOAT4
33          PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
34          _RL    UNSET_RL    
35          PARAMETER ( UNSET_RL     = 1.234567D5 )
36          _RS    UNSET_RS    
37          PARAMETER ( UNSET_RS     = 1.234567E5 )
38          INTEGER UNSET_I
39          PARAMETER ( UNSET_I      = 123456789  )
40    
41    C     Checkpoint data
42          INTEGER maxNoChkptLev
43          PARAMETER ( maxNoChkptLev = 2 )
44    
45  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
46  C     oBandId  - Offline dataset identifiers for different periods.  C     checkPtSuff - List of checkpoint file suffices
47        COMMON /PARM_C/ oBandId  C     bathyFile   - File containing bathymetry. If not defined bathymetry
48        CHARACTER*3 oBandId(nOBands)  C                   is taken from inline function.
49    C     hydrogThetaFile - File containing initial hydrographic data for potential
50    C                       temperature.
51    C     hydrogSaltFile  - File containing initial hydrographic data for salinity.
52    C     zonalWindFile   - File containing zonal wind data
53    C     meridWindFile   - File containing meridional wind data
54    C     thetaClimFile   - File containing theta climataology used
55    C                       in relaxation term -lambda(theta-theta*)
56    C     saltClimFile    - File containing salt climataology used
57    C                       in relaxation term -lambda(salt-salt*)
58    C     surfQfile       - File containing surface heat flux
59    C     surfQswfile     - File containing surface shortwave radiation
60    C     EmPmRfile       - File containing surface fresh water flux
61    C     buoyancyRelation - Flag used to indicate which relation to use to
62    C                        get buoyancy.
63          COMMON /PARM_C/ checkPtSuff,
64         &                bathyFile, hydrogThetaFile, hydrogSaltFile,
65         &                zonalWindFile, meridWindFile, thetaClimFile,
66         &                saltClimFile, buoyancyRelation,
67         &                EmPmRfile, surfQfile, surfQswfile,
68         &                uVelInitFile, vVelInitFile, pSurfInitFile
69          CHARACTER*(5) checkPtSuff(maxNoChkptLev)
70          CHARACTER*(MAX_LEN_FNAM) bathyFile
71          CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
72          CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
73          CHARACTER*(MAX_LEN_FNAM) zonalWindFile
74          CHARACTER*(MAX_LEN_FNAM) meridWindFile
75          CHARACTER*(MAX_LEN_FNAM) thetaClimFile
76          CHARACTER*(MAX_LEN_FNAM) saltClimFile
77          CHARACTER*(MAX_LEN_FNAM) surfQfile
78          CHARACTER*(MAX_LEN_FNAM) surfQswfile
79          CHARACTER*(MAX_LEN_FNAM) EmPmRfile
80          CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
81          CHARACTER*(MAX_LEN_FNAM) uVelInitFile
82          CHARACTER*(MAX_LEN_FNAM) vVelInitFile
83          CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
84    
85  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
86  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        - Maximum number of iterations in the
87  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
88  C     cg2dChkResFreq      - Frequency with which to check residual  C     cg2dChkResFreq      - Frequency with which to check residual
89  C                           in con. grad solver.  C                           in con. grad solver.
90    C     cg3dMaxIters        - Maximum number of iterations in the
91    C                           three-dimensional con. grad solver.
92    C     cg3dChkResFreq      - Frequency with which to check residual
93    C                           in con. grad solver.
94  C     nIter0              - Start time-step number of for this run  C     nIter0              - Start time-step number of for this run
95  C     nTimeSteps          - Number of timesteps to execute  C     nTimeSteps          - Number of timesteps to execute
96  C     numStepsPerPickup   - For offline setup. Frequency of pickup  C     numStepsPerPickup   - For offline setup. Frequency of pickup
97  C                           of flow fields.  C                           of flow fields.
98    C     writeStatePrec      - Precision used for writing model state.
99    C     writeBinaryPrec     - Precision used for writing binary files
100    C     readBinaryPrec      - Precision used for reading binary files
101    C     nCheckLev           - Holds current checkpoint level
102    C     nShap               - "Order" of shapiro filter to apply to
103    C                           model prognositic fields.
104    C                           nShap == 1 => del2
105    C                           nShap == 2 => del4
106    C                           nShap == 3 => del6
107    C                           etc...
108    
109        COMMON /PARM_I/        COMMON /PARM_I/
110       &        cg2dMaxIters,       &        cg2dMaxIters,
111       &        cg2dChkResFreq,       &        cg2dChkResFreq,
112       &        nIter0, nTimeSteps,       &        cg3dMaxIters,
113       &        numStepsPerPickup       &        cg3dChkResFreq,
114         &        nIter0, nTimeSteps, nEndIter,
115         &        numStepsPerPickup,
116         &        writeStatePrec, nCheckLev,
117         &        writeBinaryPrec, readBinaryPrec,
118         &        nShap
119        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
120        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
121          INTEGER cg3dMaxIters
122          INTEGER cg3dChkResFreq
123        INTEGER nIter0        INTEGER nIter0
124        INTEGER nTimeSteps        INTEGER nTimeSteps
125          INTEGER nEndIter
126        INTEGER numStepsPerPickup        INTEGER numStepsPerPickup
127          INTEGER writeStatePrec
128          INTEGER writeBinaryPrec
129          INTEGER readBinaryPrec
130          INTEGER nCheckLev
131          INTEGER nShap
132    
133  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
134  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian
135  C                          coordinate frame.  C                          coordinate frame.
136  C     usingSphericalPolarGrid - If TRUE grid generation will be in a  C     usingSphericalPolarGrid - If TRUE grid generation will be in a
137  C                               spherical polar frame.  C                               spherical polar frame.
138    C     no_slip_sides - Impose "no-slip" at lateral boundaries.
139    C     no_slip_bottom- Impose "no-slip" at bottom boundary.
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     implicitFreeSurface - Set to true to use implcit free surface
162    C     rigidLid            - Set to true to use rigid lid
163    C     momStepping   - Turns momentum equation time-stepping off
164    C     tempStepping  - Turns temperature equation time-stepping off
165    C     saltStepping  - Turns salinity equation time-stepping off
166    C     useConstantF  - Coriolis parameter set to f0
167    C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
168    C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
169    C     implicitDiffusion - Turns implicit vertical diffusion on
170    C     implicitViscosity - Turns implicit vertical viscosity on
171    C     doThetaClimRelax - Set true if relaxation to temperature
172    C                        climatology is required.
173    C     doSaltClimRelax  - Set true if relaxation to salinity
174    C                        climatology is required.
175    C     periodicExternalForcing - Set true if forcing is time-dependant
176    C     usingPCoords     - Set to indicate that we are working in pressure
177    C                        coords.
178    C     usingZCoords     - Set to indicate that we are working in height
179    C                        coords.
180    C     openBoundaries - Using open-boundaries
181    C     nonHydrostatic - Using non-hydrostatic terms
182    C     globalFiles    - Selects between "global" and "tiled" files
183    C     allowFreezing  - Allows water to freeze and form ice
184        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
185       & momViscosity, momAdvection, momForcing, useCoriolis,       & no_slip_sides,no_slip_bottom,
186       & tempDiffusion, tempAdvection, tempForcing,       & momViscosity, momAdvection, momForcing, useCoriolis,
187       & saltDiffusion, saltAdvection, saltForcing       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,
188         & saltDiffusion, saltAdvection, saltForcing,
189         & implicitFreeSurface, rigidLid,
190         & momStepping, tempStepping, saltStepping,
191         & metricTerms, usingSphericalPolarMTerms,
192         & useConstantF, useBetaPlaneF, useSphereF,
193         & implicitDiffusion, implicitViscosity,
194         & doThetaClimRelax, doSaltClimRelax,
195         & periodicExternalForcing, usingPCoords, usingZCoords,
196         & openBoundaries, nonHydrostatic, globalFiles,
197         & allowFreezing
198        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
199        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
200          LOGICAL usingSphericalPolarMTerms
201          LOGICAL no_slip_sides
202          LOGICAL no_slip_bottom
203        LOGICAL momViscosity        LOGICAL momViscosity
204        LOGICAL momAdvection        LOGICAL momAdvection
205        LOGICAL momForcing        LOGICAL momForcing
206          LOGICAL momPressureForcing
207        LOGICAL useCoriolis        LOGICAL useCoriolis
208        LOGICAL tempDiffusion        LOGICAL tempDiffusion
209        LOGICAL tempAdvection        LOGICAL tempAdvection
# Line 81  C                     and off. Line 211  C                     and off.
211        LOGICAL saltDiffusion        LOGICAL saltDiffusion
212        LOGICAL saltAdvection        LOGICAL saltAdvection
213        LOGICAL saltForcing        LOGICAL saltForcing
214          LOGICAL implicitFreeSurface
215          LOGICAL rigidLid
216          LOGICAL momStepping
217          LOGICAL tempStepping
218          LOGICAL saltStepping
219          LOGICAL metricTerms
220          LOGICAL useConstantF
221          LOGICAL useBetaPlaneF
222          LOGICAL useSphereF
223          LOGICAL implicitDiffusion
224          LOGICAL implicitViscosity
225          LOGICAL doThetaClimRelax
226          LOGICAL doSaltClimRelax
227          LOGICAL periodicExternalForcing
228          LOGICAL usingPCoords
229          LOGICAL usingZCoords
230          LOGICAL openBoundaries
231          LOGICAL nonHydrostatic
232          LOGICAL globalFiles
233          LOGICAL allowFreezing
234    
235  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
236  C     cg2dTargetResidual  C     cg2dTargetResidual
237  C               - Target residual for cg2d solver.  C               - Target residual for cg2d solver.
238  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     cg3dTargetResidual
239  C                 between "w" surfaces.  C               - Target residual for cg3d solver.
240    C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
241    C     Note. 20th May 1998
242    C           I made a weird discovery! In the model paper we argue
243    C           for the form of the preconditioner used here ( see
244    C           A Finite-volume, Incompressible Navier-Stokes Model
245    C           ...., Marshall et. al ). The algebra gives a simple
246    C           0.5 factor for the averaging of ac and aCw to get a
247    C           symmettric pre-conditioner. By using a factor of 0.51
248    C           i.e. scaling the off-diagonal terms in the
249    C           preconditioner down slightly I managed to get the
250    C           number of iterations for convergence in a test case to
251    C           drop form 192 -> 134! Need to investigate this further!
252    C           For now I have introduced a parameter cg2dpcOffDFac which
253    C           defaults to 0.51 but can be set at runtime.
254    C     delP      - Vertical grid spacing ( Pa ).
255    C     delZ      - Vertical grid spacing ( m  ).
256    C     delR      - Vertical grid spacing ( units of r ).
257  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
258  C     delY        on input flags.  C     delY        on input flags.
259  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
260    C     recip_gravity and its inverse
261    C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )
262  C     ronil     - Reference density  C     ronil     - Reference density
263    C     rhoConst  - Vertically constant reference density
264  C     startTime - Start time for model ( s )  C     startTime - Start time for model ( s )
265  C     phiMin    - Latitude of southern most cell face.  C     phiMin    - Latitude of southern most cell face.
266  C     thetaMin  - Longitude of western most cell face (this  C     thetaMin  - Longitude of western most cell face (this
267  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
268  C                 to make geographical references simple.)  C                 to make geographical references simple.)
269  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).
270    C     recip_RSphere  - Reciprocal radius of sphere ( m ).
271  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        - Reference coriolis parameter ( 1/s )
272  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
273  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      - df/dy ( s^-1.m^-1 )
274    C     omega     - Angular velocity ( rad/s )
275  C     viscAh    - Eddy viscosity coeff. for mixing of  C     viscAh    - Eddy viscosity coeff. for mixing of
276  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
277  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    - Eddy viscosity coeff. for mixing of
278  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
279    C     viscAp    - Eddy viscosity coeff. for mixing of
280    C                 momentum vertically ( Pa^2/s )
281    C     viscAr    - Eddy viscosity coeff. for mixing of
282    C                 momentum vertically ( units of r^2/s )
283  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscA4    - Biharmonic viscosity coeff. for mixing of
284  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
285  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   - Laplacian diffusion coeff. for mixing of
286  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
287  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   - Laplacian diffusion coeff. for mixing of
288  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
289    C     diffKpT   - Laplacian diffusion coeff. for mixing of
290    C                 heat vertically ( Pa^2/s )
291    C     diffKrT   - Laplacian diffusion coeff. for mixing of
292    C                 heat vertically ( units of r^2/s )
293  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   - Biharmonic diffusion coeff. for mixing of
294  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
295  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  -  Laplacian diffusion coeff. for mixing of
296  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
297  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   - Laplacian diffusion coeff. for mixing of
298  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
299    C     diffKpS   - Laplacian diffusion coeff. for mixing of
300    C                 salt vertically ( Pa^2/s )
301    C     diffKrS   - Laplacian diffusion coeff. for mixing of
302    C                 salt vertically ( units of r^2/s )
303  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   - Biharmonic diffusion coeff. for mixing of
304  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
305  C     deltaT    - Default timestep ( s )  C     deltaT    - Default timestep ( s )
306    C     deltaTClock  - Timestep used as model "clock". This determines the
307    C                    IO frequencies and is used in tagging output. It can
308    C                    be totally different to the dynamical time. Typically
309    C                    it will be the deep-water timestep for accelerated runs.
310    C                    Frequency of checkpointing and dumping of the model state
311    C                    are referenced to this clock. ( s )
312  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    - Timestep for momemtum equations ( s )
313  C     deltaTtracer - Timestep for tracer equations ( s )  C     deltaTtracer - Timestep for tracer equations ( s )
314  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     freesurfFac  - Parameter to turn implicit free surface term on or off
315  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C                    freesurfac = 1. uses implicit free surface
316  C     startTime - Starting time for this integration ( s ).  C                    freesurfac = 0. uses rigid lid
317  C     endTime   - Ending time for this integration ( s ).  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
318  C     chkPtFreq - Frequency of check pointing ( s ).  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
319  C     dumpFreq  - Frequency with which model state is written to  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
320  C                 post-processing files ( s ).  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
321        COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY, deltaT,  C     tauCD        - CD scheme coupling timescale ( 1/s )
322       & deltaTmom, deltaTtracer, abeps, startTime, phiMin, thetaMin,  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
323       & rSphere, f0, fCori, beta, viscAh, viscAz, viscA4, diffKhT, diffKzT,  C     startTime     - Starting time for this integration ( s ).
324       & diffK4T, diffKhS, diffKzS, diffK4S, delT, tauCD, rCD,  C     endTime       - Ending time for this integration ( s ).
325       & gravity, rhonil, tRef, sRef,  C     chkPtFreq     - Frequency of rolling check pointing ( s ).
326       & endTime, chkPtFreq, dumpFreq  C     pChkPtFreq    - Frequency of permanent check pointing ( s ).
327        REAL cg2dTargetResidual  C     dumpFreq      - Frequency with which model state is written to
328        REAL delZ(Nz)  C                     post-processing files ( s ).
329        REAL delX(Nx)  C     afFacMom      - Advection of momentum term tracer parameter
330        REAL delY(Ny)  C     vfFacMom      - Momentum viscosity tracer parameter
331        REAL deltaT  C     pfFacMom      - Momentum pressure forcing tracer parameter
332        REAL deltaTmom  C     cfFacMom      - Coriolis term tracer parameter
333        REAL deltaTtracer  C     foFacMom      - Momentum forcing tracer parameter
334        REAL abeps  C     mtFacMom      - Metric terms tracer parameter
335        REAL phiMin  C     cosPower      - Power of cosine of latitude to multiply viscosity
336        REAL thetaMin  C     cAdjFreq      - Frequency of convective adjustment
337        REAL rSphere  C
338        REAL f0  C     taveFreq      - Frequency with which time-averaged model state is written to
339        _RL  beta  C                     post-processing files ( s ).
340        REAL viscAh  C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).
341        REAL viscAz  C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
342        REAL viscA4  C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
343        REAL diffKhT  C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
344        REAL diffKzT  C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
345        REAL diffK4T  C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
346        REAL diffKhS  C                          (note: externForcingCycle must be an integer
347        REAL diffKzS  C                           number times externForcingPeriod)
348        REAL diffK4S  C     horiVertRatio      - Ratio on units in vertical to units in horizontal.
349        REAL delt  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
350        REAL tauCD  C                          ( g*rho if horiz in m and vertical in Pa ).
351        REAL rCD  C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
352        REAL gravity  C                          circles ( see filter*.F )
353        REAL rhonil        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
354        REAL tRef(Nz)       & cg3dTargetResidual,
355        REAL sRef(Nz)       & delP, delZ, delR, delX, delY,
356        real Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
357        REAL startTime       & phiMin, thetaMin, rSphere, recip_RSphere, f0, fCori, beta,
358        REAL endTime       & viscAh,  viscAz,  viscA4,  viscAr,
359        REAL chkPtFreq       & diffKhT, diffKzT, diffK4T, diffKrT,
360        REAL dumpFreq       & diffKhS, diffKzS, diffK4S, diffKrS,
361        COMMON /PARM_A/ HeatCapacity_Cp,       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
362         & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
363         & recip_rhoConst, rhoConst, tRef, sRef,
364         & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
365         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
366         & cosPower,
367         & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
368         & tauSaltClimRelax, lambdaSaltClimRelax,
369         & externForcingCycle, externForcingPeriod,
370         & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
371         & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
372         & latFFTFiltLo, ivdc_kappa
373    
374          _RL cg2dTargetResidual
375          _RL cg3dTargetResidual
376          _RL cg2dpcOffDFac
377          _RL delZ(Nr)
378          _RL delP(Nr)
379          _RL delR(Nr)
380          _RL delX(Nx)
381          _RL delY(Ny)
382          _RL deltaT
383          _RL deltaTClock
384          _RL deltaTmom
385          _RL deltaTtracer
386          _RL abeps
387          _RL phiMin
388          _RL thetaMin
389          _RL rSphere
390          _RL recip_RSphere
391          _RL f0
392          _RL freeSurfFac
393          _RL hFacMin
394          _RL hFacMinDz
395          _RL hFacMinDp
396          _RL hFacMinDr
397          _RL beta
398          _RL viscAh
399          _RL viscAz
400          _RL viscAp
401          _RL viscAr
402          _RL viscA4
403          _RL diffKhT
404          _RL diffKrT
405          _RL diffKzT
406          _RL diffKpT
407          _RL diffK4T
408          _RL diffKhS
409          _RL diffKrS
410          _RL diffKzS
411          _RL diffKpS
412          _RL diffK4S
413          _RL delt
414          _RL tauCD
415          _RL rCD
416          _RL gravity
417          _RL recip_gravity
418          _RL gBaro
419          _RL rhonil
420          _RL recip_rhonil
421          _RL rhoConst
422          _RL recip_rhoConst
423          _RL specVol_S(Nr)
424          _RL tRef(Nr)
425          _RL theta_S(Nr)
426          _RL sRef(Nr)
427          _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
428          _RL startTime
429          _RL endTime
430          _RL chkPtFreq
431          _RL pChkPtFreq
432          _RL dumpFreq
433          _RL taveFreq
434          _RL afFacMom
435          _RL vfFacMom
436          _RL pfFacMom
437          _RL cfFacMom
438          _RL foFacMom
439          _RL mTFacMom
440          _RL cosPower
441          _RL cAdjFreq
442          _RL omega
443          _RL tauThetaClimRelax
444          _RL lambdaThetaClimRelax
445          _RL tauSaltClimRelax
446          _RL lambdaSaltClimRelax
447          _RL externForcingCycle
448          _RL externForcingPeriod
449          _RL horiVertRatio
450          _RL recip_horiVertRatio
451          _RL latFFTFiltLo
452          _RL ivdc_kappa
453    
454          COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
455       &                Lamba_theta       &                Lamba_theta
456        REAL HeatCapacity_Cp        _RL HeatCapacity_Cp
457        REAL Lamba_theta        _RL Lamba_theta
458          _RL recip_Cp
459    
460  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
461        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
462        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)
463  C Linear equation of state  C Linear equation of state
464  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
465  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     - Linear EOS haline contraction coefficient.
466        COMMON /PARM_EOS_LIN/ tAlpha,sBeta        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
467        REAL tAlpha        _RL tAlpha
468        REAL sBeta        _RL sBeta
469          character*(6) eosType
470    
471    C These are input arrays (of integers) that contain the *absolute*
472    C computational index of an open-boundary (OB) point.
473    C A zero (0) element means there is no corresponding OB in that column/row.
474    C The computational coordinate refers to "tracer" cells.
475    C For a northern/southern OB, the OB V point is to the south/north.
476    C For an eastern/western OB, the OB U point is to the west/east.
477    C eg.
478    C     OB_Jnorth(3)=34  means that:
479    C          T( 3 ,34) is a an OB point
480    C          U(3:4,34) is a an OB point
481    C          V( 4 ,34) is a an OB point
482    C while
483    C     OB_Jsouth(3)=1  means that:
484    C          T( 3 ,1) is a an OB point
485    C          U(3:4,1) is a an OB point
486    C          V( 4 ,2) is a an OB point
487    C
488    C For convenience, negative values for Jnorth/Ieast refer to
489    C points relative to the Northern/Eastern edges of the model
490    C eg. OB_Jnorth(3)=-1  means that the point (3,Ny-1) is a northern O-B.
491    C
492          COMMON /PARM_OB/
493         & OB_Jnorth,OB_Jsouth,OB_Ieast,OB_Iwest
494          INTEGER OB_Jnorth(Nx)
495          INTEGER OB_Jsouth(Nx)
496          INTEGER OB_Ieast(Ny)
497          INTEGER OB_Iwest(Ny)
498    
499    C Logical flags for selecting packages
500          LOGICAL useKPP
501          LOGICAL useGMRedi
502          LOGICAL useECCO
503          COMMON /PARM_PACKAGES/
504         &        useKPP, useGMRedi, useECCO

Legend:
Removed from v.1.5  
changed lines
  Added in v.1.45

  ViewVC Help
Powered by ViewVC 1.1.22