/[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.49 by jmc, Tue Feb 20 19:38:24 2001 UTC revision 1.65.2.6 by dimitri, Tue Feb 18 07:32:01 2003 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  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 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 21  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 = 32 )        PARAMETER ( precFloat32 = 32 )
35        INTEGER precFloat64        INTEGER precFloat64
36        PARAMETER ( precFloat64 = 64 )        PARAMETER ( precFloat64 = 64 )
37  C     UNSET_xxx - Used to indicate variables that have not been given a value  C     UNSET_xxx :: Used to indicate variables that have not been given a value
38        Real*8 UNSET_FLOAT8        Real*8 UNSET_FLOAT8
39        PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )        PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
40        Real*4 UNSET_FLOAT4        Real*4 UNSET_FLOAT4
# Line 44  C     Checkpoint data Line 51  C     Checkpoint data
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  C     surfQfile       :: File containing surface heat flux
69  C     surfQswfile     - File containing surface shortwave radiation  C     surfQswfile     :: File containing surface shortwave radiation
70  C     EmPmRfile       - File containing surface fresh water flux  C     dQdTfile        :: File containing thermal relaxation coefficient
71  C     buoyancyRelation - Flag used to indicate which relation to use to  C     EmPmRfile       :: File containing surface fresh water flux
72    C     buoyancyRelation :: Flag used to indicate which relation to use to
73  C                        get buoyancy.  C                        get buoyancy.
74        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
75       &                bathyFile, hydrogThetaFile, hydrogSaltFile,       &                bathyFile, topoFile,
76         &                hydrogThetaFile, hydrogSaltFile,
77       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
78       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
79       &                EmPmRfile, surfQfile, surfQswfile,       &                EmPmRfile, surfQfile, surfQswfile,
80       &                uVelInitFile, vVelInitFile, pSurfInitFile       &                uVelInitFile, vVelInitFile, pSurfInitFile,
81         &                dQdTfile
82        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
83        CHARACTER*(MAX_LEN_FNAM) bathyFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
84        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
85        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
86        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
# Line 82  C                        get buoyancy. Line 94  C                        get buoyancy.
94        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
95        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
96        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
97          CHARACTER*(MAX_LEN_FNAM) dQdTfile
98    
99  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
100  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
101  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
102  C     cg2dChkResFreq      - Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
103  C                           in con. grad solver.  C                           in con. grad solver.
104  C     cg3dMaxIters        - Maximum number of iterations in the  C     cg3dMaxIters        :: Maximum number of iterations in the
105  C                           three-dimensional con. grad solver.  C                           three-dimensional con. grad solver.
106  C     cg3dChkResFreq      - Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
107  C                           in con. grad solver.  C                           in con. grad solver.
108  C     nIter0              - Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
109  C     nTimeSteps          - Number of timesteps to execute  C     nTimeSteps          :: Number of timesteps to execute
110  C     numStepsPerPickup   - For offline setup. Frequency of pickup  C     numStepsPerPickup   :: For offline setup. Frequency of pickup
111  C                           of flow fields.  C                           of flow fields.
112  C     writeStatePrec      - Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
113  C     writeBinaryPrec     - Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
114  C     readBinaryPrec      - Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
115  C     nCheckLev           - Holds current checkpoint level  C     nCheckLev           :: Holds current checkpoint level
116  C     nShap               - "Order" of shapiro filter to apply to  C     nonlinFreeSurf      :: option related to non-linear free surface
117  C                           model prognositic fields.  C                           =0 Linear free surface ; >0 Non-linear
 C                           nShap == 1 => del2  
 C                           nShap == 2 => del4  
 C                           nShap == 3 => del6  
 C                           etc...  
118    
119        COMMON /PARM_I/        COMMON /PARM_I/
120       &        cg2dMaxIters,       &        cg2dMaxIters,
# Line 116  C                           etc... Line 125  C                           etc...
125       &        numStepsPerPickup,       &        numStepsPerPickup,
126       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
127       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
128       &        nShap, zonal_filt_sinpow, zonal_filt_cospow       &        nonlinFreeSurf,
129         &        tempAdvScheme, saltAdvScheme, tracerAdvScheme
130        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
131        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
132        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
# Line 129  C                           etc... Line 139  C                           etc...
139        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
140        INTEGER readBinaryPrec        INTEGER readBinaryPrec
141        INTEGER nCheckLev        INTEGER nCheckLev
142        INTEGER nShap        INTEGER nonlinFreeSurf
143        INTEGER zonal_filt_sinpow        INTEGER tempAdvScheme
144        INTEGER zonal_filt_cospow        INTEGER saltAdvScheme
145          INTEGER tracerAdvScheme
146    
147  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
148  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
149  C                          coordinate frame.  C                          coordinate frame.
150  C     usingSphericalPolarGrid - If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
151  C                               spherical polar frame.  C                               spherical polar frame.
152  C     no_slip_sides - Impose "no-slip" at lateral boundaries.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
153  C     no_slip_bottom- Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
154  C     staggerTimeStep - enable a Stagger time stepping T,S Rho then U,V  C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
155  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
156  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momAdvection  :: Flag which turns advection of momentum on and off.
157  C     momForcing    - Flag which turns external forcing of momentum on  C     momForcing    :: Flag which turns external forcing of momentum on
158  C                     and off.  C                     and off.
159  C     momPressureForcing - Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
160  C                          on and off.  C                          on and off.
161  C     metricTerms   - Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
162  C     usingSphericalPolarMTerms - If TRUE use spherical polar metric terms.  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
163  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
164  C     tempDiffusion - Flag which turns diffusion of temperature on  C     tempDiffusion :: Flag which turns diffusion of temperature on
165  C                     and off.  C                     and off.
166  C     tempAdvection - Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
167  C                     and off.  C                     and off.
168  C     tempForcing   - Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
169  C                     and off.  C                     and off.
170  C     saltDiffusion - Flag which turns diffusion of salinit on  C     saltDiffusion :: Flag which turns diffusion of salinity on
171  C                     and off.  C                     and off.
172  C     saltAdvection - Flag which turns advection of salinit on  C     saltAdvection :: Flag which turns advection of salinity on
173  C                     and off.  C                     and off.
174  C     saltForcing   - Flag which turns external forcing of salinit on  C     saltForcing   :: Flag which turns external forcing of salinity on
175  C                     and off.  C                     and off.
176  C     implicitFreeSurface - Set to true to use implcit free surface  C     useRealFreshWaterFlux :: if true (=Natural BCS), treats P+R-E flux
177  C     rigidLid            - Set to true to use rigid lid  C                         as a real Fresh Water (=> changes the seal level)
178  C     momStepping   - Turns momentum equation time-stepping off  C                              if false, converts P+R-E to virtual salt flux
179  C     tempStepping  - Turns temperature equation time-stepping off  C     rigidLid            :: Set to true to use rigid lid
180  C     saltStepping  - Turns salinity equation time-stepping off  C     implicitFreeSurface :: Set to true to use implcit free surface
181  C     useConstantF  - Coriolis parameter set to f0  C     exactConserv        :: Set to true to conserve exactly the total Volume
182  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y  C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
183  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)  C                           linear relation Phi_surf = Bo_surf*eta
184  C     implicitDiffusion - Turns implicit vertical diffusion on  C     momStepping   :: Turns momentum equation time-stepping off
185  C     implicitViscosity - Turns implicit vertical viscosity on  C     tempStepping  :: Turns temperature equation time-stepping off
186  C     doThetaClimRelax - Set true if relaxation to temperature  C     saltStepping  :: Turns salinity equation time-stepping off
187    C     tr1Stepping   :: Turns passive tracer 1 time-stepping on/off
188    C     useConstantF  :: Coriolis parameter set to f0
189    C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
190    C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
191    C     implicitDiffusion :: Turns implicit vertical diffusion on
192    C     implicitViscosity :: Turns implicit vertical viscosity on
193    C     doThetaClimRelax :: Set true if relaxation to temperature
194  C                        climatology is required.  C                        climatology is required.
195  C     doSaltClimRelax  - Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
196  C                        climatology is required.  C                        climatology is required.
197  C     periodicExternalForcing - Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
198  C     usingPCoords     - Set to indicate that we are working in pressure  C     usingPCoords     :: Set to indicate that we are working in pressure
199  C                        coords.  C                        coords.
200  C     usingZCoords     - Set to indicate that we are working in height  C     usingZCoords     :: Set to indicate that we are working in height
201  C                        coords.  C                        coords.
202  C     nonHydrostatic - Using non-hydrostatic terms  C     nonHydrostatic :: Using non-hydrostatic terms
203  C     globalFiles    - Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
204  C     allowFreezing  - Allows water to freeze and form ice  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
205  C     groundAtK1  - put the surface(k=1) at the Lower Boundary (=ground)  C                       slow (f77) or does not work (f90).  When
206    C                       useSingleCpuIO is set, mdsio_writefield.F
207    C                       outputs from master mpi process only.
208    C     allowFreezing  :: Allows water to freeze and form ice
209    C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
210    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
211        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
212         & usingCurvilinearGrid,
213       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
214       & staggerTimeStep,       & staggerTimeStep,
215       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
216       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,       & momPressureForcing, vectorInvariantMomentum,
217         & tempDiffusion, tempAdvection, tempForcing,
218       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
219       & implicitFreeSurface, rigidLid,       & useRealFreshWaterFlux,
220       & momStepping, tempStepping, saltStepping,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
221         & momStepping, tempStepping, saltStepping, tr1Stepping,
222       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
223       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
224       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
225       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
226       & periodicExternalForcing, usingPCoords, usingZCoords,       & periodicExternalForcing, usingPCoords, usingZCoords,
227       & nonHydrostatic, globalFiles,       & nonHydrostatic, globalFiles, useSingleCpuIO,
228       & allowFreezing, groundAtK1       & allowFreezing, groundAtK1,
229         & usePickupBeforeC35, debugMode,
230         & readPickupWithTracer, writePickupWithTracer,
231         & multiDimAdvection, useEnergyConservingCoriolis,
232         & useJamartWetPoints
233        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
234        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
235          LOGICAL usingCurvilinearGrid
236        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
237        LOGICAL no_slip_sides        LOGICAL no_slip_sides
238        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
# Line 211  C     groundAtK1  - put the surface(k=1) Line 242  C     groundAtK1  - put the surface(k=1)
242        LOGICAL momForcing        LOGICAL momForcing
243        LOGICAL momPressureForcing        LOGICAL momPressureForcing
244        LOGICAL useCoriolis        LOGICAL useCoriolis
245          LOGICAL vectorInvariantMomentum
246        LOGICAL tempDiffusion        LOGICAL tempDiffusion
247        LOGICAL tempAdvection        LOGICAL tempAdvection
248        LOGICAL tempForcing        LOGICAL tempForcing
249        LOGICAL saltDiffusion        LOGICAL saltDiffusion
250        LOGICAL saltAdvection        LOGICAL saltAdvection
251        LOGICAL saltForcing        LOGICAL saltForcing
252        LOGICAL implicitFreeSurface        LOGICAL useRealFreshWaterFlux
253        LOGICAL rigidLid        LOGICAL rigidLid
254          LOGICAL implicitFreeSurface
255          LOGICAL exactConserv
256          LOGICAL uniformLin_PhiSurf
257        LOGICAL momStepping        LOGICAL momStepping
258        LOGICAL tempStepping        LOGICAL tempStepping
259        LOGICAL saltStepping        LOGICAL saltStepping
260          LOGICAL tr1Stepping
261        LOGICAL metricTerms        LOGICAL metricTerms
262        LOGICAL useConstantF        LOGICAL useConstantF
263        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
# Line 230  C     groundAtK1  - put the surface(k=1) Line 266  C     groundAtK1  - put the surface(k=1)
266        LOGICAL implicitViscosity        LOGICAL implicitViscosity
267        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
268        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
269          LOGICAL doTr1ClimRelax
270        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
271        LOGICAL usingPCoords        LOGICAL usingPCoords
272        LOGICAL usingZCoords        LOGICAL usingZCoords
273        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
274        LOGICAL globalFiles        LOGICAL globalFiles
275          LOGICAL useSingleCpuIO
276        LOGICAL allowFreezing        LOGICAL allowFreezing
277        LOGICAL groundAtK1        LOGICAL groundAtK1
278          LOGICAL usePickupBeforeC35
279          LOGICAL debugMode
280          LOGICAL readPickupWithTracer
281          LOGICAL writePickupWithTracer
282          LOGICAL multiDimAdvection
283          LOGICAL useEnergyConservingCoriolis
284          LOGICAL useJamartWetPoints
285    
286  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
287  C     cg2dTargetResidual  C     gg2dTargetResidual
288  C               - Target residual for cg2d solver.  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
289    C     cg2dTargetResWunit
290    C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
291  C     cg3dTargetResidual  C     cg3dTargetResidual
292  C               - Target residual for cg3d solver.  C               :: Target residual for cg3d solver.
293  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
294  C     Note. 20th May 1998  C     Note. 20th May 1998
295  C           I made a weird discovery! In the model paper we argue  C           I made a weird discovery! In the model paper we argue
296  C           for the form of the preconditioner used here ( see  C           for the form of the preconditioner used here ( see
# Line 257  C           number of iterations for con Line 304  C           number of iterations for con
304  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
305  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
306  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
307  C     delP      - Vertical grid spacing ( Pa ).  C     delP      :: Vertical grid spacing ( Pa ).
308  C     delZ      - Vertical grid spacing ( m  ).  C     delZ      :: Vertical grid spacing ( m  ).
309  C     delR      - Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
310  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
311  C     delY        on input flags.  C     delY        on input flags.
312  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
313  C     recip_gravity and its inverse  C     recip_gravity and its inverse
314  C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
315  C     ronil     - Reference density  C     ronil     :: Reference density
316  C     rhoConst  - Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
317  C     startTime - Start time for model ( s )  C     startTime :: Start time for model ( s )
318  C     phiMin    - Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
319  C     thetaMin  - Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
320  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
321  C                 to make geographical references simple.)  C                 to make geographical references simple.)
322  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).
323  C     recip_RSphere  - Reciprocal radius of sphere ( m ).  C     recip_RSphere  :: Reciprocal radius of sphere ( m ).
324  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        :: Reference coriolis parameter ( 1/s )
325  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
326  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
327  C     omega     - Angular velocity ( rad/s )  C     omega     :: Angular velocity ( rad/s )
328  C     viscAh    - Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
329  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
330  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    :: Eddy viscosity coeff. for mixing of
331  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
332  C     viscAp    - Eddy viscosity coeff. for mixing of  C     viscAp    :: Eddy viscosity coeff. for mixing of
333  C                 momentum vertically ( Pa^2/s )  C                 momentum vertically ( Pa^2/s )
334  C     viscAr    - Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
335  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
336  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
337  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
338  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
339  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
340  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   :: Laplacian diffusion coeff. for mixing of
341  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
342  C     diffKpT   - Laplacian diffusion coeff. for mixing of  C     diffKpT   :: Laplacian diffusion coeff. for mixing of
343  C                 heat vertically ( Pa^2/s )  C                 heat vertically ( Pa^2/s )
344  C     diffKrT   - Laplacian diffusion coeff. for mixing of  C     diffKrT   :: Laplacian diffusion coeff. for mixing of
345  C                 heat vertically ( units of r^2/s )  C                 heat vertically ( units of r^2/s )
346  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
347  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
348  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
349  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
350  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   :: Laplacian diffusion coeff. for mixing of
351  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
352  C     diffKpS   - Laplacian diffusion coeff. for mixing of  C     diffKpS   :: Laplacian diffusion coeff. for mixing of
353  C                 salt vertically ( Pa^2/s )  C                 salt vertically ( Pa^2/s )
354  C     diffKrS   - Laplacian diffusion coeff. for mixing of  C     diffKrS   :: Laplacian diffusion coeff. for mixing of
355  C                 salt vertically ( units of r^2/s )  C                 salt vertically ( units of r^2/s )
356  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
357  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
358  C     deltaT    - Default timestep ( s )  C     deltaT    :: Default timestep ( s )
359  C     deltaTClock  - Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
360  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
361  C                    be totally different to the dynamical time. Typically  C                    be totally different to the dynamical time. Typically
362  C                    it will be the deep-water timestep for accelerated runs.  C                    it will be the deep-water timestep for accelerated runs.
363  C                    Frequency of checkpointing and dumping of the model state  C                    Frequency of checkpointing and dumping of the model state
364  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
365  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
366  C     deltaTtracer - Timestep for tracer equations ( s )  C     deltaTtracer :: Timestep for tracer equations ( s )
367  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
368  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
369  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
370  C     implicSurfPress - parameter of the Crank-Nickelson time stepping :  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
371  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
372  C     implicDiv2Dflow - parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
373  C                     Implicit part of barotropic flow Divergence ( 0-1 )  C                     Implicit part of barotropic flow Divergence ( 0-1 )
374  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
375  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)
376  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
377  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
378  C     tauCD        - CD scheme coupling timescale ( 1/s )  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
379  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )  C     hFacSup        that control vanishing and creating levels
380  C     startTime     - Starting time for this integration ( s ).  C     tauCD        :: CD scheme coupling timescale ( 1/s )
381  C     endTime       - Ending time for this integration ( s ).  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
382  C     chkPtFreq     - Frequency of rolling check pointing ( s ).  C     startTime     :: Starting time for this integration ( s ).
383  C     pChkPtFreq    - Frequency of permanent check pointing ( s ).  C     endTime       :: Ending time for this integration ( s ).
384  C     dumpFreq      - Frequency with which model state is written to  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
385    C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
386    C     dumpFreq      :: Frequency with which model state is written to
387  C                     post-processing files ( s ).  C                     post-processing files ( s ).
388  C     afFacMom      - Advection of momentum term tracer parameter  C     diagFreq      :: Frequency with which model writes diagnostic output
389  C     vfFacMom      - Momentum viscosity tracer parameter  C                     of intermediate quantities.
390  C     pfFacMom      - Momentum pressure forcing tracer parameter  C     afFacMom      :: Advection of momentum term tracer parameter
391  C     cfFacMom      - Coriolis term tracer parameter  C     vfFacMom      :: Momentum viscosity tracer parameter
392  C     foFacMom      - Momentum forcing tracer parameter  C     pfFacMom      :: Momentum pressure forcing tracer parameter
393  C     mtFacMom      - Metric terms tracer parameter  C     cfFacMom      :: Coriolis term tracer parameter
394  C     cosPower      - Power of cosine of latitude to multiply viscosity  C     foFacMom      :: Momentum forcing tracer parameter
395  C     cAdjFreq      - Frequency of convective adjustment  C     mtFacMom      :: Metric terms tracer parameter
396    C     cosPower      :: Power of cosine of latitude to multiply viscosity
397    C     cAdjFreq      :: Frequency of convective adjustment
398  C  C
399  C     taveFreq      - Frequency with which time-averaged model state is written to  C     taveFreq      :: Frequency with which time-averaged model state is written to
400  C                     post-processing files ( s ).  C                     post-processing files ( s ).
401  C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
402  C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
403  C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
404  C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
405  C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
406  C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
407  C                          (note: externForcingCycle must be an integer  C                          (note: externForcingCycle must be an integer
408  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
409  C     horiVertRatio      - Ratio on units in vertical to units in horizontal.  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
410    C                       (use model surface (local) value if set to -1)
411    C     temp_EvPrRn :: temperature of Rain & Evap.
412    C     salt_EvPrRn :: salinity of Rain & Evap.
413    C     trac_EvPrRn :: tracer concentration in Rain & Evap.
414    C        (notes: a) tracer content of Rain/Evap only used if both
415    C                     NonLin_FrSurf & useRealFreshWater are set.
416    C                b) use model surface (local) value if set to UNSET_RL)
417    C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.
418  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
419  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
420  C     latFFTFiltLo       - Low latitude for FFT filtering of latitude  C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as
 C                          circles ( see filter*.F )  
 C     Ro_SeaLevel        - standard position of Sea-Level in "R" coordinate, used as  
421  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
422  C     bottomDragLinear   - Drag coefficient built in to core dynamics  C     bottomDragLinear   :: Drag coefficient built in to core dynamics
423  C         "     Quadratic  ( linear: 1/s, quadratic: 1/m )  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
424        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
425       & cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
426       & delP, delZ, delR, delX, delY,       & delP, delZ, delR, delX, delY,
427       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
428       & phiMin, thetaMin, rSphere, recip_RSphere, f0, fCori, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
429       & viscAh,  viscAz,  viscA4,  viscAr,       & fCori, fCoriG,
430         & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,
431       & diffKhT, diffKzT, diffK4T, diffKrT,       & diffKhT, diffKzT, diffK4T, diffKrT,
432       & diffKhS, diffKzS, diffK4S, diffKrS,       & diffKhS, diffKzS, diffK4S, diffKrS,
433       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
434       & hFacMin, hFacMinDz,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
435       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
436       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst, tRef, sRef,
437       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
438         & diagFreq, taveFreq, monitorFreq,
439       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
440       & cosPower,       & cosPower, cAdjFreq, omega,
441       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, lambdaThetaClimRelax,
442       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
443         & tauTr1ClimRelax, lambdaTr1ClimRelax,
444       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
445         & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
446       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
447       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
448       & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,       & ivdc_kappa, Ro_SeaLevel,
449       & bottomDragLinear,bottomDragQuadratic       & bottomDragLinear,bottomDragQuadratic
450    
451        _RL cg2dTargetResidual        _RL cg2dTargetResidual
452          _RL cg2dTargetResWunit
453        _RL cg3dTargetResidual        _RL cg3dTargetResidual
454        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
455        _RL delZ(Nr)        _RL delZ(Nr)
# Line 412  C         "     Quadratic  ( linear: 1/s Line 474  C         "     Quadratic  ( linear: 1/s
474        _RL hFacMinDz        _RL hFacMinDz
475        _RL hFacMinDp        _RL hFacMinDp
476        _RL hFacMinDr        _RL hFacMinDr
477          _RL hFacInf
478          _RL hFacSup
479        _RL beta        _RL beta
480        _RL viscAh        _RL viscAh
481          _RL viscAstrain
482          _RL viscAtension
483        _RL viscAz        _RL viscAz
484        _RL viscAp        _RL viscAp
485        _RL viscAr        _RL viscAr
# Line 438  C         "     Quadratic  ( linear: 1/s Line 504  C         "     Quadratic  ( linear: 1/s
504        _RL recip_rhonil        _RL recip_rhonil
505        _RL rhoConst        _RL rhoConst
506        _RL recip_rhoConst        _RL recip_rhoConst
       _RL specVol_S(Nr)  
507        _RL tRef(Nr)        _RL tRef(Nr)
       _RL theta_S(Nr)  
508        _RL sRef(Nr)        _RL sRef(Nr)
509        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
510          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
511        _RL startTime        _RL startTime
512        _RL endTime        _RL endTime
513        _RL chkPtFreq        _RL chkPtFreq
514        _RL pChkPtFreq        _RL pChkPtFreq
515        _RL dumpFreq        _RL dumpFreq
516          _RL diagFreq
517        _RL taveFreq        _RL taveFreq
518          _RL monitorFreq
519        _RL afFacMom        _RL afFacMom
520        _RL vfFacMom        _RL vfFacMom
521        _RL pfFacMom        _RL pfFacMom
# Line 462  C         "     Quadratic  ( linear: 1/s Line 529  C         "     Quadratic  ( linear: 1/s
529        _RL lambdaThetaClimRelax        _RL lambdaThetaClimRelax
530        _RL tauSaltClimRelax        _RL tauSaltClimRelax
531        _RL lambdaSaltClimRelax        _RL lambdaSaltClimRelax
532          _RL tauTr1ClimRelax
533          _RL lambdaTr1ClimRelax
534        _RL externForcingCycle        _RL externForcingCycle
535        _RL externForcingPeriod        _RL externForcingPeriod
536          _RL convertFW2Salt
537          _RL temp_EvPrRn
538          _RL salt_EvPrRn
539          _RL trac_EvPrRn
540        _RL horiVertRatio        _RL horiVertRatio
541        _RL recip_horiVertRatio        _RL recip_horiVertRatio
       _RL latFFTFiltLo  
542        _RL ivdc_kappa        _RL ivdc_kappa
543        _RL Ro_SeaLevel        _RL Ro_SeaLevel
       _RL zonal_filt_lat  
544        _RL bottomDragLinear        _RL bottomDragLinear
545        _RL bottomDragQuadratic        _RL bottomDragQuadratic
546    
# Line 483  C Equation of State (polynomial coeffien Line 554  C Equation of State (polynomial coeffien
554        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
555        _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)        _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
556  C Linear equation of state  C Linear equation of state
557  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    :: Linear EOS thermal expansion coefficient ( 1/degree ).
558  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     :: Linear EOS haline contraction coefficient.
559        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
560        _RL tAlpha        _RL tAlpha
561        _RL sBeta        _RL sBeta
562        character*(6) eosType        character*(6) eosType
563    
564    C Atmospheric physical parameters (Ideal Gas EOS, ...)
565    C     atm_po    :: standard reference pressure
566    C     atm_cp    :: specific heat (Cp) of the (dry) air at constant pressure
567    C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
568    C     Integr_GeoPot :: option to select the way we integrate the geopotential
569    C                     (still a subject of discussions ...)
570          COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,
571         &                  Integr_GeoPot
572          _RL atm_cp, atm_kappa, atm_po
573          INTEGER Integr_GeoPot
574    
575  C Logical flags for selecting packages  C Logical flags for selecting packages
576        LOGICAL useKPP        LOGICAL useKPP
577        LOGICAL useGMRedi        LOGICAL useGMRedi
578        LOGICAL useOBCS        LOGICAL useOBCS
579        LOGICAL useAIM        LOGICAL useAIM
580          LOGICAL useGrdchk
581        LOGICAL useECCO        LOGICAL useECCO
582          LOGICAL useSHAP_FILT
583          LOGICAL useZONAL_FILT
584          LOGICAL useFLT
585          LOGICAL useSBO
586          LOGICAL useSEAICE
587        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
588       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
589         &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
590         &        useSBO, useSEAICE
Legend:
Removed from v.1.49  
changed lines
  Added in v.1.65.2.6
  ViewVC Help
Powered by ViewVC 1.1.22