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