/[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.23 by cnh, Sat Aug 15 16:55:48 1998 UTC revision 1.92 by heimbach, Tue Jul 8 15:00:26 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  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 water to freeze and form ice
241    C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
242        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
243       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,       & usingCurvilinearGrid,
244         & no_slip_sides,no_slip_bottom,
245         & staggerTimeStep,
246         & momViscosity, momAdvection, momForcing, useCoriolis,
247         & momPressureForcing, vectorInvariantMomentum,
248       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
249       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
250       & implicitFreeSurface, rigidLid,       & useRealFreshWaterFlux,
251       & momStepping, tempStepping, saltStepping,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
252       & metricTerms, usingSphericalPolarMTerms,       & momStepping, tempStepping, saltStepping, tr1Stepping,
253         & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
254       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
255       & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,       & useCDscheme,
256       & periodicExternalForcing       & useEnergyConservingCoriolis, useJamartWetPoints,
257         & implicitDiffusion, implicitViscosity,
258         & multiDimAdvection, forcing_In_AB,
259         & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
260         & periodicExternalForcing,
261         & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
262         & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
263         & allowFreezing, groundAtK1,
264         & usePickupBeforeC35, debugMode,
265         & readPickupWithTracer, writePickupWithTracer
266        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
267        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
268          LOGICAL usingCurvilinearGrid
269        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
270          LOGICAL useNHMTerms
271          LOGICAL no_slip_sides
272          LOGICAL no_slip_bottom
273          LOGICAL staggerTimeStep
274        LOGICAL momViscosity        LOGICAL momViscosity
275        LOGICAL momAdvection        LOGICAL momAdvection
276        LOGICAL momForcing        LOGICAL momForcing
277        LOGICAL momPressureForcing        LOGICAL momPressureForcing
278        LOGICAL useCoriolis        LOGICAL useCoriolis
279          LOGICAL vectorInvariantMomentum
280        LOGICAL tempDiffusion        LOGICAL tempDiffusion
281        LOGICAL tempAdvection        LOGICAL tempAdvection
282        LOGICAL tempForcing        LOGICAL tempForcing
283        LOGICAL saltDiffusion        LOGICAL saltDiffusion
284        LOGICAL saltAdvection        LOGICAL saltAdvection
285        LOGICAL saltForcing        LOGICAL saltForcing
286        LOGICAL implicitFreeSurface        LOGICAL useRealFreshWaterFlux
287        LOGICAL rigidLid        LOGICAL rigidLid
288          LOGICAL implicitFreeSurface
289          LOGICAL exactConserv
290          LOGICAL uniformLin_PhiSurf
291        LOGICAL momStepping        LOGICAL momStepping
292        LOGICAL tempStepping        LOGICAL tempStepping
293        LOGICAL saltStepping        LOGICAL saltStepping
294          LOGICAL tr1Stepping
295        LOGICAL metricTerms        LOGICAL metricTerms
296        LOGICAL useConstantF        LOGICAL useConstantF
297        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
298        LOGICAL useSphereF        LOGICAL useSphereF
299          LOGICAL useCDscheme
300          LOGICAL useEnergyConservingCoriolis
301          LOGICAL useJamartWetPoints
302        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
303          LOGICAL implicitViscosity
304          LOGICAL multiDimAdvection
305          LOGICAL forcing_In_AB
306        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
307        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
308          LOGICAL doTr1ClimRelax
309        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
310          LOGICAL usingPCoords
311          LOGICAL usingZCoords
312          LOGICAL useDynP_inEos_Zc
313          LOGICAL setCenterDr
314          LOGICAL nonHydrostatic
315          LOGICAL quasiHydrostatic
316          LOGICAL globalFiles
317          LOGICAL useSingleCpuIO
318          LOGICAL allowFreezing
319          LOGICAL groundAtK1
320          LOGICAL usePickupBeforeC35
321          LOGICAL debugMode
322          LOGICAL readPickupWithTracer
323          LOGICAL writePickupWithTracer
324    
325  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
326  C     cg2dTargetResidual  C     gg2dTargetResidual
327  C               - Target residual for cg2d solver.  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
328  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dTargetResWunit
329    C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
330    C     cg3dTargetResidual
331    C               :: Target residual for cg3d solver.
332    C     cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
333  C     Note. 20th May 1998  C     Note. 20th May 1998
334  C           I made a weird discovery! In the model paper we argue  C           I made a weird discovery! In the model paper we argue
335  C           for the form of the preconditioner used here ( see  C           for the form of the preconditioner used here ( see
# Line 182  C           number of iterations for con Line 343  C           number of iterations for con
343  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
344  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
345  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
346  C     delR      - Vertical grid spacing ( units of r ).  C     delP      :: Vertical grid spacing ( Pa ).
347  C     delX      - Separation between cell faces (m) or (deg), depending  C     delZ      :: Vertical grid spacing ( m  ).
348    C     delR      :: Vertical grid spacing ( units of r ).
349    C     delRc     :: Vertical grid spacing between cell centers (r unit).
350    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     viscAz    :: Eddy viscosity coeff. for mixing of
373  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
374  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscAp    :: Eddy viscosity coeff. for mixing of
375    C                 momentum vertically ( Pa^2/s )
376    C     viscAr    :: Eddy viscosity coeff. for mixing of
377    C                 momentum vertically ( units of r^2/s )
378    C     viscA4    :: Biharmonic viscosity coeff. for mixing of
379  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
380  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
381  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
382  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   :: Laplacian diffusion coeff. for mixing of
383  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
384  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffKpT   :: Laplacian diffusion coeff. for mixing of
385    C                 heat vertically ( Pa^2/s )
386    C     diffKrT   :: Laplacian diffusion coeff. for mixing of
387    C                 heat vertically ( units of r^2/s )
388    C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
389  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
390  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
391  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
392  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   :: Laplacian diffusion coeff. for mixing of
393  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
394  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffKpS   :: Laplacian diffusion coeff. for mixing of
395    C                 salt vertically ( Pa^2/s )
396    C     diffKrS   :: Laplacian diffusion coeff. for mixing of
397    C                 salt vertically ( units of r^2/s )
398    C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
399  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
400  C     deltaT    - Default timestep ( s )  C     deltaT    :: Default timestep ( s )
401  C     deltaTClock  - Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
402  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
403  C                    be totally different to the dynamical time. Typically  C                    be totally different to the dynamical time. Typically
404  C                    it will be the deep-water timestep for accelerated runs.  C                    it will be the deep-water timestep for accelerated runs.
405  C                    Frequency of checkpointing and dumping of the model state  C                    Frequency of checkpointing and dumping of the model state
406  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
407  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
408  C     deltaTtracer - Timestep for tracer equations ( s )  C     deltaTtracer :: Timestep for tracer equations ( s )
409  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
410    C     freesurfFac  :: Parameter to turn implicit free surface term on or off
411  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
412  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
413  C     hFacMin   - Minimum fraction size of a cell (affects hFacC etc...)  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
414  C     hFacMinDz - Minimum dimesional size of a cell (affects hFacC etc...)  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
415  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
416  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C                     Implicit part of barotropic flow Divergence ( 0-1 )
417  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
418  C     GMlength  - Length to use in Visbeck et al. formula for K (m)  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)
419  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
420  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
421  C     GMkbackground - background value of GM/Redi coefficient  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
422  C     GMmaxval  - max. value of KapGM allowed in GM/Redi scheme  C     hFacSup        that control vanishing and creating levels
423  C     startTime - Starting time for this integration ( s ).  C     tauCD        :: CD scheme coupling timescale ( 1/s )
424  C     endTime   - Ending time for this integration ( s ).  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
425  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     startTime     :: Starting time for this integration ( s ).
426  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     endTime       :: Ending time for this integration ( s ).
427  C     dumpFreq  - Frequency with which model state is written to  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
428  C                 post-processing files ( s ).  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
429  C     taveFreq  - Frequency with which time-averaged model state is written to  C     dumpFreq      :: Frequency with which model state is written to
430  C                 post-processing files ( s ).  C                     post-processing files ( s ).
431  C     afFacMom  - Advection of momentum term scaling parameter  C     diagFreq      :: Frequency with which model writes diagnostic output
432  C     vfFacMom  - Momentum viscosity scaling parameter  C                     of intermediate quantities.
433  C     pfFacMom  - Momentum pressure forcing parameter  C     afFacMom      :: Advection of momentum term tracer parameter
434  C     cfFacMom  - Coriolis term scaling parameter  C     vfFacMom      :: Momentum viscosity tracer parameter
435  C     foFacMom  - Momentum forcing scaling parameter  C     pfFacMom      :: Momentum pressure forcing tracer parameter
436  C     mtFacMom  - Metric terms scaling parameter  C     cfFacMom      :: Coriolis term tracer parameter
437  C     cAdjFreq  - Frequency of convective adjustment  C     foFacMom      :: Momentum forcing tracer parameter
438  C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).  C     mtFacMom      :: Metric terms tracer parameter
439  C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).  C     cosPower      :: Power of cosine of latitude to multiply viscosity
440  C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).  C     cAdjFreq      :: Frequency of convective adjustment
441  C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).  C
442  C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)  C     taveFreq      :: Frequency with which time-averaged model state
443  C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)  C                      is written to post-processing files ( s ).
444    C     tave_lastIter :: (for state variable only) fraction of the last time
445    C                      step (of each taveFreq period) put in the time average.
446    C                      (fraction for 1rst iter = 1 - tave_lastIter)
447    C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
448    C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
449    C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
450    C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
451    C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
452    C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
453  C                          (note: externForcingCycle must be an integer  C                          (note: externForcingCycle must be an integer
454  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
455        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delR, delX, delY,  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
456       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,  C                       (use model surface (local) value if set to -1)
457       & thetaMin, rSphere, rRSphere, f0, fCori, beta, viscAh, viscAz, viscA4,  C     temp_EvPrRn :: temperature of Rain & Evap.
458       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,  C     salt_EvPrRn :: salinity of Rain & Evap.
459       & tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,  C     trac_EvPrRn :: tracer concentration in Rain & Evap.
460       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,  C        (notes: a) tracer content of Rain/Evap only used if both
461       & gravity, gBaro, rhonil, tRef, sRef,  C                     NonLin_FrSurf & useRealFreshWater are set.
462       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,  C                b) use model surface (local) value if set to UNSET_RL)
463    C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.
464    C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
465    C                          ( g*rho if horiz in m and vertical in Pa ).
466    C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as
467    C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
468    C     bottomDragLinear   :: Drag coefficient built in to core dynamics
469    C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
470          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
471         & cg2dpcOffDFac, cg3dTargetResidual,
472         & delP, delZ, delR, delRc, delX, delY,
473         & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
474         & abeps, startTime,
475         & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
476         & fCori, fCoriG, fCoriCos,
477         & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,
478         & diffKhT, diffKzT, diffK4T, diffKrT,
479         & diffKhS, diffKzS, diffK4S, diffKrS,
480         & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
481         & hFacMin, hFacMinDz, hFacInf, hFacSup,
482         & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
483         & recip_rhoConst, rhoConst,
484         & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
485         & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
486         & diagFreq, taveFreq, tave_lastIter, monitorFreq,
487       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
488       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,       & cosPower, cAdjFreq, omega, rotationPeriod,
489         & tauThetaClimRelax, lambdaThetaClimRelax,
490       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
491       & externForcingCycle, externForcingPeriod       & tauTr1ClimRelax, lambdaTr1ClimRelax,
492         & externForcingCycle, externForcingPeriod,
493         & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
494         & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
495         & horiVertRatio, recip_horiVertRatio,
496         & ivdc_kappa, Ro_SeaLevel,
497         & bottomDragLinear,bottomDragQuadratic
498    
499        _RL cg2dTargetResidual        _RL cg2dTargetResidual
500          _RL cg2dTargetResWunit
501          _RL cg3dTargetResidual
502        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
503        _RL delR(Nz)        _RL delZ(Nr)
504          _RL delP(Nr)
505          _RL delR(Nr)
506          _RL delRc(Nr+1)
507        _RL delX(Nx)        _RL delX(Nx)
508        _RL delY(Ny)        _RL delY(Ny)
509        _RL deltaT        _RL deltaT
510        _RL deltaTClock        _RL deltaTClock
511        _RL deltaTmom        _RL deltaTmom
512        _RL deltaTtracer        _RL deltaTtracer
513          _RL deltaTfreesurf
514        _RL abeps        _RL abeps
515        _RL phiMin        _RL phiMin
516        _RL thetaMin        _RL thetaMin
517        _RL rSphere        _RL rSphere
518        _RL rRSphere        _RL recip_RSphere
519        _RL f0        _RL f0
520        _RL freeSurfFac        _RL freeSurfFac
521          _RL implicSurfPress
522          _RL implicDiv2Dflow
523        _RL hFacMin        _RL hFacMin
524        _RL hFacMinDz        _RL hFacMinDz
525          _RL hFacMinDp
526          _RL hFacMinDr
527          _RL hFacInf
528          _RL hFacSup
529        _RL beta        _RL beta
530        _RL viscAh        _RL viscAh
531          _RL viscAstrain
532          _RL viscAtension
533        _RL viscAz        _RL viscAz
534          _RL viscAp
535          _RL viscAr
536        _RL viscA4        _RL viscA4
537        _RL diffKhT        _RL diffKhT
538          _RL diffKrT
539        _RL diffKzT        _RL diffKzT
540          _RL diffKpT
541        _RL diffK4T        _RL diffK4T
542        _RL diffKhS        _RL diffKhS
543          _RL diffKrS
544        _RL diffKzS        _RL diffKzS
545          _RL diffKpS
546        _RL diffK4S        _RL diffK4S
547        _RL delt        _RL delt
548        _RL tauCD        _RL tauCD
549        _RL rCD        _RL rCD
       _RL GMmaxslope  
       _RL GMlength  
       _RL GMalpha  
       _RL GMdepth  
       _RL GMkbackground  
       _RL GMmaxval  
550        _RL gravity        _RL gravity
551          _RL recip_gravity
552        _RL gBaro        _RL gBaro
553        _RL rhonil        _RL rhonil
554        _RL tRef(Nz)        _RL recip_rhonil
555        _RL sRef(Nz)        _RL rhoConst
556        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL recip_rhoConst
557          _RL rhoConstFresh
558          _RL convertEmP2rUnit
559          _RL tRef(Nr)
560          _RL sRef(Nr)
561          _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
562          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
563          _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
564        _RL startTime        _RL startTime
565        _RL endTime        _RL endTime
566        _RL chkPtFreq        _RL chkPtFreq
567        _RL pChkPtFreq        _RL pChkPtFreq
568        _RL dumpFreq        _RL dumpFreq
569          _RL diagFreq
570        _RL taveFreq        _RL taveFreq
571          _RL tave_lastIter
572          _RL monitorFreq
573        _RL afFacMom        _RL afFacMom
574        _RL vfFacMom        _RL vfFacMom
575        _RL pfFacMom        _RL pfFacMom
576        _RL cfFacMom        _RL cfFacMom
577        _RL foFacMom        _RL foFacMom
578        _RL mTFacMom        _RL mTFacMom
579          _RL cosPower
580        _RL cAdjFreq        _RL cAdjFreq
581        _RL omega        _RL omega
582          _RL rotationPeriod
583        _RL tauThetaClimRelax        _RL tauThetaClimRelax
584        _RL lambdaThetaClimRelax        _RL lambdaThetaClimRelax
585        _RL tauSaltClimRelax        _RL tauSaltClimRelax
586        _RL lambdaSaltClimRelax        _RL lambdaSaltClimRelax
587          _RL tauTr1ClimRelax
588          _RL lambdaTr1ClimRelax
589        _RL externForcingCycle        _RL externForcingCycle
590        _RL externForcingPeriod        _RL externForcingPeriod
591          _RL convertFW2Salt
592          _RL temp_EvPrRn
593          _RL salt_EvPrRn
594          _RL trac_EvPrRn
595          _RL horiVertRatio
596          _RL recip_horiVertRatio
597          _RL ivdc_kappa
598          _RL Ro_SeaLevel
599          _RL bottomDragLinear
600          _RL bottomDragQuadratic
601    
602        COMMON /PARM_A/ HeatCapacity_Cp,  C--   COMMON /PARM_A/ Thermodynamics constants ?
603       &                Lamba_theta        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
604        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
605        _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  
606    
607    C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
608    C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
609    C     atm_Po    :: standard reference pressure
610    C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
611    C     atm_Rd    :: gas constant for dry air
612    C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
613    C     integr_GeoPot :: option to select the way we integrate the geopotential
614    C                     (still a subject of discussions ...)
615    C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
616    C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
617          COMMON /PARM_ATM/
618         &            celsius2K,
619         &            atm_Cp, atm_Rd, atm_kappa, atm_Po,
620         &            integr_GeoPot, selectFindRoSurf
621          _RL celsius2K
622          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa
623          INTEGER integr_GeoPot, selectFindRoSurf
624    
625    C Logical flags for selecting packages
626          LOGICAL useKPP
627          LOGICAL useGMRedi
628          LOGICAL useOBCS
629          LOGICAL useAIM
630          LOGICAL useLand
631          LOGICAL useGrdchk
632          LOGICAL useECCO
633          LOGICAL useSHAP_FILT
634          LOGICAL useZONAL_FILT
635          LOGICAL useFLT
636          LOGICAL usePTRACERS
637          LOGICAL useSBO
638          LOGICAL useSEAICE
639    cswdblk -- add ---
640          LOGICAL useBulkforce
641          LOGICAL useThermSEAICE
642    cswdblk --- end add ---
643          COMMON /PARM_PACKAGES/
644         &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
645         &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
646         &        usePTRACERS,  useSBO, useSEAICE,
647    cswdblk -- add ---
648         &        useThermSEAICE, useBulkforce
649    cswdblk --- end add ---
Legend:
Removed from v.1.23  
changed lines
  Added in v.1.92
  ViewVC Help
Powered by ViewVC 1.1.22