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

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.43

  ViewVC Help
Powered by ViewVC 1.1.22