/[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.12 by adcroft, Thu May 28 16:19:50 1998 UTC revision 1.85 by dimitri, Tue Feb 18 05:33:53 2003 UTC
# Line 1  Line 1 
1  C $Header$  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
24  C     Useful physical values  C     Useful physical values
# Line 17  C     Useful physical values Line 28  C     Useful physical values
28        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
29    
30  C     Symbolic values  C     Symbolic values
31  C     precXXXX - Used to indicate what precision to use for  C     precXXXX :: Used to indicate what precision to use for
32  C                dumping model state.  C                dumping model state.
33        INTEGER precFloat32        INTEGER precFloat32
34        PARAMETER ( precFloat32 = 0 )        PARAMETER ( precFloat32 = 32 )
35        INTEGER precFloat64        INTEGER precFloat64
36        PARAMETER ( precFloat64 = 1 )        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  C     Checkpoint data
50        INTEGER maxNoChkptLev        INTEGER maxNoChkptLev
51        PARAMETER ( maxNoChkptLev = 2 )        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     checkPtSuff - List of checkpoint file suffices  C     checkPtSuff :: List of checkpoint file suffices
55        COMMON /PARM_C/ checkPtSuff  C     bathyFile   :: File containing bathymetry. If not defined bathymetry
56    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     pLoadFile       :: File containing pressure loading
73    C     buoyancyRelation :: Flag used to indicate which relation to use to
74    C                        get buoyancy.
75    C     eosType         :: choose the equation of state:
76    C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P
77          COMMON /PARM_C/ checkPtSuff,
78         &                bathyFile, topoFile,
79         &                hydrogThetaFile, hydrogSaltFile,
80         &                zonalWindFile, meridWindFile, thetaClimFile,
81         &                saltClimFile, buoyancyRelation,
82         &                EmPmRfile, surfQfile, surfQswfile,
83         &                uVelInitFile, vVelInitFile, pSurfInitFile,
84         &                dQdTfile, ploadFile,
85         &                eosType
86        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
87          CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
88          CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
89          CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
90          CHARACTER*(MAX_LEN_FNAM) zonalWindFile
91          CHARACTER*(MAX_LEN_FNAM) meridWindFile
92          CHARACTER*(MAX_LEN_FNAM) thetaClimFile
93          CHARACTER*(MAX_LEN_FNAM) saltClimFile
94          CHARACTER*(MAX_LEN_FNAM) surfQfile
95          CHARACTER*(MAX_LEN_FNAM) surfQswfile
96          CHARACTER*(MAX_LEN_FNAM) EmPmRfile
97          CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
98          CHARACTER*(MAX_LEN_FNAM) uVelInitFile
99          CHARACTER*(MAX_LEN_FNAM) vVelInitFile
100          CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
101          CHARACTER*(MAX_LEN_FNAM) dQdTfile
102          CHARACTER*(MAX_LEN_FNAM) ploadFile
103          CHARACTER*(6) eosType
104    
105  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
106  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
107  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
108  C     cg2dChkResFreq      - Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
109    C                           in con. grad solver.
110    C     cg3dMaxIters        :: Maximum number of iterations in the
111    C                           three-dimensional con. grad solver.
112    C     cg3dChkResFreq      :: Frequency with which to check residual
113  C                           in con. grad solver.  C                           in con. grad solver.
114  C     nIter0              - Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
115  C     nTimeSteps          - Number of timesteps to execute  C     nTimeSteps          :: Number of timesteps to execute
116  C     numStepsPerPickup   - For offline setup. Frequency of pickup  C     numStepsPerPickup   :: For offline setup. Frequency of pickup
117  C                           of flow fields.  C                           of flow fields.
118  C     writeStatePrec      - Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
119  C     writeBinaryPrec     - Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
120  C     readBinaryPrec      - Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
121  C     nCheckLev           - Holds current checkpoint level  C     nCheckLev           :: Holds current checkpoint level
122    C     nonlinFreeSurf      :: option related to non-linear free surface
123    C                           =0 Linear free surface ; >0 Non-linear
124    C     select_rStar        :: option related to r* vertical coordinate
125    C                           =0 (default) use r coord. ; > 0 use r*
126    
127        COMMON /PARM_I/        COMMON /PARM_I/
128       &        cg2dMaxIters,       &        cg2dMaxIters,
129       &        cg2dChkResFreq,       &        cg2dChkResFreq,
130       &        nIter0, nTimeSteps,       &        cg3dMaxIters,
131         &        cg3dChkResFreq,
132         &        nIter0, nTimeSteps, nEndIter,
133       &        numStepsPerPickup,       &        numStepsPerPickup,
134       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
135       &        writeBinaryPrec, readBinaryPrec       &        writeBinaryPrec, readBinaryPrec,
136         &        nonlinFreeSurf, select_rStar,
137         &        tempAdvScheme, saltAdvScheme, tracerAdvScheme
138        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
139        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
140          INTEGER cg3dMaxIters
141          INTEGER cg3dChkResFreq
142        INTEGER nIter0        INTEGER nIter0
143        INTEGER nTimeSteps        INTEGER nTimeSteps
144          INTEGER nEndIter
145        INTEGER numStepsPerPickup        INTEGER numStepsPerPickup
146        INTEGER writeStatePrec        INTEGER writeStatePrec
147        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
148        INTEGER readBinaryPrec        INTEGER readBinaryPrec
149        INTEGER nCheckLev        INTEGER nCheckLev
150          INTEGER nonlinFreeSurf
151          INTEGER select_rStar
152          INTEGER tempAdvScheme
153          INTEGER saltAdvScheme
154          INTEGER tracerAdvScheme
155    
156  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
157  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
158  C                          coordinate frame.  C                          coordinate frame.
159  C     usingSphericalPolarGrid - If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
160  C                               spherical polar frame.  C                               spherical polar frame.
161  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
162  C     momAdvection  - Flag which turns advection of momentum on and off.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
163  C     momForcing    - Flag which turns external forcing of momentum on  C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
164    C     momViscosity  :: Flag which turns momentum friction terms on and off.
165    C     momAdvection  :: Flag which turns advection of momentum on and off.
166    C     momForcing    :: Flag which turns external forcing of momentum on
167  C                     and off.  C                     and off.
168  C     momPressureForcing - Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
169  C                          on and off.  C                          on and off.
170  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     metricTerms   :: Flag which turns metric terms on or off.
171  C     tempDiffusion - Flag which turns diffusion of temperature on  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
172    C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.
173    C     useCoriolis   :: Flag which turns the coriolis terms on and off.
174    C     tempDiffusion :: Flag which turns diffusion of temperature on
175  C                     and off.  C                     and off.
176  C     tempAdvection - Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
177  C                     and off.  C                     and off.
178  C     tempForcing   - Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
179  C                     and off.  C                     and off.
180  C     saltDiffusion - Flag which turns diffusion of salinit on  C     saltDiffusion :: Flag which turns diffusion of salinity on
181  C                     and off.  C                     and off.
182  C     saltAdvection - Flag which turns advection of salinit on  C     saltAdvection :: Flag which turns advection of salinity on
183  C                     and off.  C                     and off.
184  C     saltForcing   - Flag which turns external forcing of salinit on  C     saltForcing   :: Flag which turns external forcing of salinity on
185  C                     and off.  C                     and off.
186  C     implicitFreeSurface - Set to true to use implcit free surface  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
187  C     rigidLid            - Set to true to use rigid lid  C                         as a real Fresh Water (=> changes the Sea Level)
188  C     momStepping   - Turns momentum equation time-stepping off  C                         if F, converts P+R-E to salt flux (no SL effect)
189  C     momStepping   - Turns temperature equation time-stepping off  C     rigidLid            :: Set to true to use rigid lid
190    C     implicitFreeSurface :: Set to true to use implcit free surface
191    C     exactConserv        :: Set to true to conserve exactly the total Volume
192    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
193    C                           linear relation Phi_surf = Bo_surf*eta
194    C     momStepping   :: Turns momentum equation time-stepping off
195    C     tempStepping  :: Turns temperature equation time-stepping off
196    C     saltStepping  :: Turns salinity equation time-stepping off
197    C     tr1Stepping   :: Turns passive tracer 1 time-stepping on/off
198    C     useConstantF  :: Coriolis parameter set to f0
199    C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
200    C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
201    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
202    C     implicitDiffusion :: Turns implicit vertical diffusion on
203    C     implicitViscosity :: Turns implicit vertical viscosity on
204    C     multiDimAdvection :: Flag that enable multi-dimension advection
205    C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
206    C                      out off Adams-Bashforth time stepping.
207    C     doThetaClimRelax :: Set true if relaxation to temperature
208    C                        climatology is required.
209    C     doSaltClimRelax  :: Set true if relaxation to salinity
210    C                        climatology is required.
211    C     periodicExternalForcing :: Set true if forcing is time-dependant
212    C     usingPCoords     :: Set to indicate that we are working in pressure
213    C                        coords.
214    C     usingZCoords     :: Set to indicate that we are working in height
215    C                        coords.
216    C     setCenterDr    :: set cell Center depth and put Interface at the middle
217    C     nonHydrostatic :: Using non-hydrostatic terms
218    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
219    C     globalFiles    :: Selects between "global" and "tiled" files
220    C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
221    C                       slow (f77) or does not work (f90).  When
222    C                       useSingleCpuIO is set, mdsio_writefield.F
223    C                       outputs from master mpi process only.
224    C     allowFreezing  :: Allows water to freeze and form ice
225    C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
226        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
227       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,       & usingCurvilinearGrid,
228         & no_slip_sides,no_slip_bottom,
229         & staggerTimeStep,
230         & momViscosity, momAdvection, momForcing, useCoriolis,
231         & momPressureForcing, vectorInvariantMomentum,
232       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
233       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
234       & implicitFreeSurface, rigidLid, momStepping, tempStepping       & useRealFreshWaterFlux,
235         & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
236         & momStepping, tempStepping, saltStepping, tr1Stepping,
237         & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
238         & useConstantF, useBetaPlaneF, useSphereF,
239         & useEnergyConservingCoriolis, useJamartWetPoints,
240         & implicitDiffusion, implicitViscosity,
241         & multiDimAdvection, forcing_In_AB,
242         & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
243         & periodicExternalForcing,
244         & usingPCoords, usingZCoords, setCenterDr,
245         & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
246         & allowFreezing, groundAtK1,
247         & usePickupBeforeC35, debugMode,
248         & readPickupWithTracer, writePickupWithTracer
249        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
250        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
251          LOGICAL usingCurvilinearGrid
252          LOGICAL usingSphericalPolarMTerms
253          LOGICAL useNHMTerms
254          LOGICAL no_slip_sides
255          LOGICAL no_slip_bottom
256          LOGICAL staggerTimeStep
257        LOGICAL momViscosity        LOGICAL momViscosity
258        LOGICAL momAdvection        LOGICAL momAdvection
259        LOGICAL momForcing        LOGICAL momForcing
260        LOGICAL momPressureForcing        LOGICAL momPressureForcing
261        LOGICAL useCoriolis        LOGICAL useCoriolis
262          LOGICAL vectorInvariantMomentum
263        LOGICAL tempDiffusion        LOGICAL tempDiffusion
264        LOGICAL tempAdvection        LOGICAL tempAdvection
265        LOGICAL tempForcing        LOGICAL tempForcing
266        LOGICAL saltDiffusion        LOGICAL saltDiffusion
267        LOGICAL saltAdvection        LOGICAL saltAdvection
268        LOGICAL saltForcing        LOGICAL saltForcing
269        LOGICAL implicitFreeSurface        LOGICAL useRealFreshWaterFlux
270        LOGICAL rigidLid        LOGICAL rigidLid
271          LOGICAL implicitFreeSurface
272          LOGICAL exactConserv
273          LOGICAL uniformLin_PhiSurf
274        LOGICAL momStepping        LOGICAL momStepping
275        LOGICAL tempStepping        LOGICAL tempStepping
276          LOGICAL saltStepping
277          LOGICAL tr1Stepping
278          LOGICAL metricTerms
279          LOGICAL useConstantF
280          LOGICAL useBetaPlaneF
281          LOGICAL useSphereF
282          LOGICAL useEnergyConservingCoriolis
283          LOGICAL useJamartWetPoints
284          LOGICAL implicitDiffusion
285          LOGICAL implicitViscosity
286          LOGICAL multiDimAdvection
287          LOGICAL forcing_In_AB
288          LOGICAL doThetaClimRelax
289          LOGICAL doSaltClimRelax
290          LOGICAL doTr1ClimRelax
291          LOGICAL periodicExternalForcing
292          LOGICAL usingPCoords
293          LOGICAL usingZCoords
294          LOGICAL setCenterDr
295          LOGICAL nonHydrostatic
296          LOGICAL quasiHydrostatic
297          LOGICAL globalFiles
298          LOGICAL useSingleCpuIO
299          LOGICAL allowFreezing
300          LOGICAL groundAtK1
301          LOGICAL usePickupBeforeC35
302          LOGICAL debugMode
303          LOGICAL readPickupWithTracer
304          LOGICAL writePickupWithTracer
305    
306  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
307  C     cg2dTargetResidual  C     gg2dTargetResidual
308  C               - Target residual for cg2d solver.  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
309  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dTargetResWunit
310    C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
311    C     cg3dTargetResidual
312    C               :: Target residual for cg3d solver.
313    C     cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
314  C     Note. 20th May 1998  C     Note. 20th May 1998
315  C           I made a weird discovery! In the model paper we argue  C           I made a weird discovery! In the model paper we argue
316  C           for the form of the preconditioner used here ( see  C           for the form of the preconditioner used here ( see
# Line 131  C           number of iterations for con Line 324  C           number of iterations for con
324  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
325  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
326  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
327  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     delP      :: Vertical grid spacing ( Pa ).
328  C                 between "w" surfaces.  C     delZ      :: Vertical grid spacing ( m  ).
329  C     delX      - Separation between cell faces (m) or (deg), depending  C     delR      :: Vertical grid spacing ( units of r ).
330    C     delRc     :: Vertical grid spacing between cell centers (r unit).
331    C     delX      :: Separation between cell faces (m) or (deg), depending
332  C     delY        on input flags.  C     delY        on input flags.
333  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
334  C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )  C     recip_gravity and its inverse
335  C     ronil     - Reference density  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
336  C     startTime - Start time for model ( s )  C     rhoNil    :: Reference density for the linear equation of state
337  C     phiMin    - Latitude of southern most cell face.  C     rhoConst  :: Vertically constant reference density
338  C     thetaMin  - Longitude of western most cell face (this  C     rhoConstFresh :: Constant reference density for fresh water (rain)
339    C     startTime :: Start time for model ( s )
340    C     phiMin    :: Latitude of southern most cell face.
341    C     thetaMin  :: Longitude of western most cell face (this
342  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
343  C                 to make geographical references simple.)  C                 to make geographical references simple.)
344  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).
345  C     f0        - Reference coriolis parameter ( 1/s )  C     recip_RSphere  :: Reciprocal radius of sphere ( m ).
346    C     f0        :: Reference coriolis parameter ( 1/s )
347  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
348  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
349  C     viscAh    - Eddy viscosity coeff. for mixing of  C     omega     :: Angular velocity ( rad/s )
350    C     viscAh    :: Eddy viscosity coeff. for mixing of
351  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
352  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    :: Eddy viscosity coeff. for mixing of
353  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
354  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscAp    :: Eddy viscosity coeff. for mixing of
355    C                 momentum vertically ( Pa^2/s )
356    C     viscAr    :: Eddy viscosity coeff. for mixing of
357    C                 momentum vertically ( units of r^2/s )
358    C     viscA4    :: Biharmonic viscosity coeff. for mixing of
359  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
360  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
361  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
362  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   :: Laplacian diffusion coeff. for mixing of
363  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
364  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffKpT   :: Laplacian diffusion coeff. for mixing of
365    C                 heat vertically ( Pa^2/s )
366    C     diffKrT   :: Laplacian diffusion coeff. for mixing of
367    C                 heat vertically ( units of r^2/s )
368    C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
369  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
370  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
371  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
372  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   :: Laplacian diffusion coeff. for mixing of
373  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
374  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffKpS   :: Laplacian diffusion coeff. for mixing of
375    C                 salt vertically ( Pa^2/s )
376    C     diffKrS   :: Laplacian diffusion coeff. for mixing of
377    C                 salt vertically ( units of r^2/s )
378    C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
379  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
380  C     deltaT    - Default timestep ( s )  C     deltaT    :: Default timestep ( s )
381  C     deltaTClock  - Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
382  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
383  C                    be totally different to the dynamical time. Typically  C                    be totally different to the dynamical time. Typically
384  C                    it will be the deep-water timestep for accelerated runs.  C                    it will be the deep-water timestep for accelerated runs.
385  C                    Frequency of checkpointing and dumping of the model state  C                    Frequency of checkpointing and dumping of the model state
386  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
387  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
388  C     deltaTtracer - Timestep for tracer equations ( s )  C     deltaTtracer :: Timestep for tracer equations ( s )
389  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
390    C     freesurfFac  :: Parameter to turn implicit free surface term on or off
391  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
392  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
393  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
394  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
395  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
396  C     GMlength  - Length to use in Visbeck et al. formula for K (m)  C                     Implicit part of barotropic flow Divergence ( 0-1 )
397  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
398  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)
399  C     GMkbackground - background value of GM/Redi coefficient  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
400  C     startTime - Starting time for this integration ( s ).  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
401  C     endTime   - Ending time for this integration ( s ).  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
402  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     hFacSup        that control vanishing and creating levels
403  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     tauCD        :: CD scheme coupling timescale ( 1/s )
404  C     dumpFreq  - Frequency with which model state is written to  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
405  C                 post-processing files ( s ).  C     startTime     :: Starting time for this integration ( s ).
406  C     afFacMom  - Advection of momentum term scaling parameter  C     endTime       :: Ending time for this integration ( s ).
407  C     vfFacMom  - Momentum viscosity scaling parameter  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
408  C     pfFacMom  - Momentum pressure forcing parameter  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
409  C     cfFacMom  - Coriolis term scaling parameter  C     dumpFreq      :: Frequency with which model state is written to
410  C     foFacMom  - Momentum forcing scaling parameter  C                     post-processing files ( s ).
411  C     cAdjFreq  - Frequency of convective adjustment  C     diagFreq      :: Frequency with which model writes diagnostic output
412        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,  C                     of intermediate quantities.
413       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,  C     afFacMom      :: Advection of momentum term tracer parameter
414       & thetaMin, rSphere, f0, fCori, beta, viscAh, viscAz, viscA4,  C     vfFacMom      :: Momentum viscosity tracer parameter
415       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,  C     pfFacMom      :: Momentum pressure forcing tracer parameter
416       & tauCD, rCD, freeSurfFac,  C     cfFacMom      :: Coriolis term tracer parameter
417       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,  C     foFacMom      :: Momentum forcing tracer parameter
418       & gravity, gBaro, rhonil, tRef, sRef,  C     mtFacMom      :: Metric terms tracer parameter
419    C     cosPower      :: Power of cosine of latitude to multiply viscosity
420    C     cAdjFreq      :: Frequency of convective adjustment
421    C
422    C     taveFreq      :: Frequency with which time-averaged model state
423    C                      is written to post-processing files ( s ).
424    C     tave_lastIter :: (for state variable only) fraction of the last time
425    C                      step (of each taveFreq period) put in the time average.
426    C                      (fraction for 1rst iter = 1 - tave_lastIter)
427    C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
428    C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
429    C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
430    C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
431    C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
432    C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
433    C                          (note: externForcingCycle must be an integer
434    C                           number times externForcingPeriod)
435    C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
436    C                       (use model surface (local) value if set to -1)
437    C     temp_EvPrRn :: temperature of Rain & Evap.
438    C     salt_EvPrRn :: salinity of Rain & Evap.
439    C     trac_EvPrRn :: tracer concentration in Rain & Evap.
440    C        (notes: a) tracer content of Rain/Evap only used if both
441    C                     NonLin_FrSurf & useRealFreshWater are set.
442    C                b) use model surface (local) value if set to UNSET_RL)
443    C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.
444    C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
445    C                          ( g*rho if horiz in m and vertical in Pa ).
446    C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as
447    C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
448    C     bottomDragLinear   :: Drag coefficient built in to core dynamics
449    C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
450          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
451         & cg2dpcOffDFac, cg3dTargetResidual,
452         & delP, delZ, delR, delRc, delX, delY,
453         & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
454         & abeps, startTime,
455         & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
456         & fCori, fCoriG, fCoriCos,
457         & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,
458         & diffKhT, diffKzT, diffK4T, diffKrT,
459         & diffKhS, diffKzS, diffK4S, diffKrS,
460         & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
461         & hFacMin, hFacMinDz, hFacInf, hFacSup,
462         & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
463         & recip_rhoConst, rhoConst,
464         & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
465       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
466       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom,       & diagFreq, taveFreq, tave_lastIter, monitorFreq,
467       & cAdjFreq       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
468         & cosPower, cAdjFreq, omega,
469         & tauThetaClimRelax, lambdaThetaClimRelax,
470         & tauSaltClimRelax, lambdaSaltClimRelax,
471         & tauTr1ClimRelax, lambdaTr1ClimRelax,
472         & externForcingCycle, externForcingPeriod,
473         & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
474         & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
475         & horiVertRatio, recip_horiVertRatio,
476         & ivdc_kappa, Ro_SeaLevel,
477         & bottomDragLinear,bottomDragQuadratic
478    
479        _RL cg2dTargetResidual        _RL cg2dTargetResidual
480          _RL cg2dTargetResWunit
481          _RL cg3dTargetResidual
482        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
483        _RL delZ(Nz)        _RL delZ(Nr)
484          _RL delP(Nr)
485          _RL delR(Nr)
486          _RL delRc(Nr+1)
487        _RL delX(Nx)        _RL delX(Nx)
488        _RL delY(Ny)        _RL delY(Ny)
489        _RL deltaT        _RL deltaT
490        _RL deltaTClock        _RL deltaTClock
491        _RL deltaTmom        _RL deltaTmom
492        _RL deltaTtracer        _RL deltaTtracer
493          _RL deltaTfreesurf
494        _RL abeps        _RL abeps
495        _RL phiMin        _RL phiMin
496        _RL thetaMin        _RL thetaMin
497        _RL rSphere        _RL rSphere
498          _RL recip_RSphere
499        _RL f0        _RL f0
500        _RL freeSurfFac        _RL freeSurfFac
501          _RL implicSurfPress
502          _RL implicDiv2Dflow
503          _RL hFacMin
504          _RL hFacMinDz
505          _RL hFacMinDp
506          _RL hFacMinDr
507          _RL hFacInf
508          _RL hFacSup
509        _RL beta        _RL beta
510        _RL viscAh        _RL viscAh
511          _RL viscAstrain
512          _RL viscAtension
513        _RL viscAz        _RL viscAz
514          _RL viscAp
515          _RL viscAr
516        _RL viscA4        _RL viscA4
517        _RL diffKhT        _RL diffKhT
518          _RL diffKrT
519        _RL diffKzT        _RL diffKzT
520          _RL diffKpT
521        _RL diffK4T        _RL diffK4T
522        _RL diffKhS        _RL diffKhS
523          _RL diffKrS
524        _RL diffKzS        _RL diffKzS
525          _RL diffKpS
526        _RL diffK4S        _RL diffK4S
527        _RL delt        _RL delt
528        _RL tauCD        _RL tauCD
529        _RL rCD        _RL rCD
       _RL GMmaxslope  
       _RL GMlength  
       _RL GMalpha  
       _RL GMdepth  
       _RL GMkbackground  
530        _RL gravity        _RL gravity
531          _RL recip_gravity
532        _RL gBaro        _RL gBaro
533        _RL rhonil        _RL rhonil
534        _RL tRef(Nz)        _RL recip_rhonil
535        _RL sRef(Nz)        _RL rhoConst
536        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL recip_rhoConst
537          _RL rhoConstFresh
538          _RL convertEmP2rUnit
539          _RL tRef(Nr)
540          _RL sRef(Nr)
541          _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
542          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
543          _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
544        _RL startTime        _RL startTime
545        _RL endTime        _RL endTime
546        _RL chkPtFreq        _RL chkPtFreq
547        _RL pChkPtFreq        _RL pChkPtFreq
548        _RL dumpFreq        _RL dumpFreq
549          _RL diagFreq
550          _RL taveFreq
551          _RL tave_lastIter
552          _RL monitorFreq
553        _RL afFacMom        _RL afFacMom
554        _RL vfFacMom        _RL vfFacMom
555        _RL pfFacMom        _RL pfFacMom
556        _RL cfFacMom        _RL cfFacMom
557        _RL foFacMom        _RL foFacMom
558          _RL mTFacMom
559          _RL cosPower
560        _RL cAdjFreq        _RL cAdjFreq
561          _RL omega
562          _RL tauThetaClimRelax
563          _RL lambdaThetaClimRelax
564          _RL tauSaltClimRelax
565          _RL lambdaSaltClimRelax
566          _RL tauTr1ClimRelax
567          _RL lambdaTr1ClimRelax
568          _RL externForcingCycle
569          _RL externForcingPeriod
570          _RL convertFW2Salt
571          _RL temp_EvPrRn
572          _RL salt_EvPrRn
573          _RL trac_EvPrRn
574          _RL horiVertRatio
575          _RL recip_horiVertRatio
576          _RL ivdc_kappa
577          _RL Ro_SeaLevel
578          _RL bottomDragLinear
579          _RL bottomDragQuadratic
580    
581        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
582       &                Lamba_theta       &                Lamba_theta
583        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
584        _RL Lamba_theta        _RL Lamba_theta
585          _RL recip_Cp
586    
587    CmlC Equation of State (polynomial coeffients)
588    Cml      COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
589    Cml      _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
590    CmlC Linear equation of state
591    CmlC     tAlpha    :: Linear EOS thermal expansion coefficient ( 1/degree ).
592    CmlC     sBeta     :: Linear EOS haline contraction coefficient.
593    Cml      COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
594    Cml      _RL tAlpha
595    Cml      _RL sBeta
596    
597  C Equation of State (polynomial coeffients)  C Atmospheric physical parameters (Ideal Gas EOS, ...)
598        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS  C     atm_Po    :: standard reference pressure
599        _RL eosC(9,Nz+1),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)  C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
600  C Linear equation of state  C     atm_Rd    :: gas constant for dry air
601  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
602  C     sBeta     - Linear EOS haline contraction coefficient.  C     integr_GeoPot :: option to select the way we integrate the geopotential
603        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType  C                     (still a subject of discussions ...)
604        _RL tAlpha  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
605        _RL sBeta  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
606        character*(6) eosType        COMMON /PARM_ATM/ atm_Cp, atm_Rd, atm_kappa, atm_Po,
607         &                  integr_GeoPot, selectFindRoSurf
608          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa
609          INTEGER integr_GeoPot, selectFindRoSurf
610    
611    C Logical flags for selecting packages
612          LOGICAL useKPP
613          LOGICAL useGMRedi
614          LOGICAL useOBCS
615          LOGICAL useAIM
616          LOGICAL useGrdchk
617          LOGICAL useECCO
618          LOGICAL useSHAP_FILT
619          LOGICAL useZONAL_FILT
620          LOGICAL useFLT
621          LOGICAL usePTRACERS
622          LOGICAL useSEAICE
623    cswdblk -- add ---
624          LOGICAL useBulkforce
625          LOGICAL useThermSEAICE
626    cswdblk --- end add ---
627          COMMON /PARM_PACKAGES/
628         &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
629         &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
630         &        usePTRACERS, useSEAICE,
631    cswdblk -- add ---
632         &        useThermSEAICE, useBulkforce
633    cswdblk --- end add ---

Legend:
Removed from v.1.12  
changed lines
  Added in v.1.85

  ViewVC Help
Powered by ViewVC 1.1.22