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