/[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.43 by adcroft, Wed Apr 5 17:52:16 2000 UTC revision 1.65 by adcroft, Fri Sep 28 03:25:15 2001 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 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 = 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 43  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     EmPmRfile       - File containing surface fresh water flux  C     surfQswfile     :: File containing surface shortwave radiation
70  C     buoyancyRelation - Flag used to indicate which relation to use to  C     dQdTfile        :: File containing thermal relaxation coefficient
71    C     EmPmRfile       :: File containing surface fresh water flux
72    C     buoyancyRelation :: Flag used to indicate which relation to use to
73  C                        get buoyancy.  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,       &                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 74  C                        get buoyancy. Line 88  C                        get buoyancy.
88        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
89        CHARACTER*(MAX_LEN_FNAM) saltClimFile        CHARACTER*(MAX_LEN_FNAM) saltClimFile
90        CHARACTER*(MAX_LEN_FNAM) surfQfile        CHARACTER*(MAX_LEN_FNAM) surfQfile
91          CHARACTER*(MAX_LEN_FNAM) surfQswfile
92        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
93        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
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 113  C                           etc... Line 125  C                           etc...
125       &        numStepsPerPickup,       &        numStepsPerPickup,
126       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
127       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
128       &        nShap       &        nonlinFreeSurf,
129         &        zonal_filt_sinpow, zonal_filt_cospow,
130         &        tempAdvScheme, saltAdvScheme, tracerAdvScheme
131        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
132        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
133        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
# Line 126  C                           etc... Line 140  C                           etc...
140        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
141        INTEGER readBinaryPrec        INTEGER readBinaryPrec
142        INTEGER nCheckLev        INTEGER nCheckLev
143        INTEGER nShap        INTEGER nonlinFreeSurf
144          INTEGER zonal_filt_sinpow
145          INTEGER zonal_filt_cospow
146          INTEGER tempAdvScheme
147          INTEGER saltAdvScheme
148          INTEGER tracerAdvScheme
149    
150  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
151  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
152  C                          coordinate frame.  C                          coordinate frame.
153  C     usingSphericalPolarGrid - If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
154  C                               spherical polar frame.  C                               spherical polar frame.
155  C     no_slip_sides - Impose "no-slip" at lateral boundaries.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
156  C     no_slip_bottom- Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
157  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
158  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
159  C     momForcing    - Flag which turns external forcing of momentum on  C     momAdvection  :: Flag which turns advection of momentum on and off.
160    C     momForcing    :: Flag which turns external forcing of momentum on
161  C                     and off.  C                     and off.
162  C     momPressureForcing - Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
163  C                          on and off.  C                          on and off.
164  C     metricTerms   - Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
165  C     usingSphericalPolarMTerms - If TRUE use spherical polar metric terms.  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
166  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
167  C     tempDiffusion - Flag which turns diffusion of temperature on  C     tempDiffusion :: Flag which turns diffusion of temperature on
168  C                     and off.  C                     and off.
169  C     tempAdvection - Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
170  C                     and off.  C                     and off.
171  C     tempForcing   - Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
172  C                     and off.  C                     and off.
173  C     saltDiffusion - Flag which turns diffusion of salinit on  C     saltDiffusion :: Flag which turns diffusion of salinit on
174  C                     and off.  C                     and off.
175  C     saltAdvection - Flag which turns advection of salinit on  C     saltAdvection :: Flag which turns advection of salinit on
176  C                     and off.  C                     and off.
177  C     saltForcing   - Flag which turns external forcing of salinit on  C     saltForcing   :: Flag which turns external forcing of salinit on
178  C                     and off.  C                     and off.
179  C     implicitFreeSurface - Set to true to use implcit free surface  C     rigidLid            :: Set to true to use rigid lid
180  C     rigidLid            - Set to true to use rigid lid  C     implicitFreeSurface :: Set to true to use implcit free surface
181  C     momStepping   - Turns momentum equation time-stepping off  C     exactConserv        :: Set to true to conserve exactly the total Volume
182  C     tempStepping  - Turns temperature equation time-stepping off  C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
183  C     saltStepping  - Turns salinity equation time-stepping off  C                           linear relation Phi_surf = Bo_surf*eta
184  C     useConstantF  - Coriolis parameter set to f0  C     momStepping   :: Turns momentum equation time-stepping off
185  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y  C     tempStepping  :: Turns temperature equation time-stepping off
186  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)  C     saltStepping  :: Turns salinity equation time-stepping off
187  C     implicitDiffusion - Turns implicit vertical diffusion on  C     tr1Stepping   :: Turns passive tracer 1 time-stepping on/off
188  C     implicitViscosity - Turns implicit vertical viscosity on  C     useConstantF  :: Coriolis parameter set to f0
189  C     doThetaClimRelax - Set true if relaxation to temperature  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     openBoundaries - Using open-boundaries  C     nonHydrostatic :: Using non-hydrostatic terms
203  C     nonHydrostatic - Using non-hydrostatic terms  C     globalFiles    :: Selects between "global" and "tiled" files
204  C     globalFiles    - Selects between "global" and "tiled" files  C     allowFreezing  :: Allows water to freeze and form ice
205  C     allowFreezing  - Allows water to freeze and form ice  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
206        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
207         & usingCurvilinearGrid,
208       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
209         & staggerTimeStep,
210       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
211       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,       & momPressureForcing, vectorInvariantMomentum,
212         & tempDiffusion, tempAdvection, tempForcing,
213       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
214       & implicitFreeSurface, rigidLid,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
215       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping, tr1Stepping,
216       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
217       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
218       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
219       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
220       & periodicExternalForcing, usingPCoords, usingZCoords,       & periodicExternalForcing, usingPCoords, usingZCoords,
221       & openBoundaries, nonHydrostatic, globalFiles,       & nonHydrostatic, globalFiles,
222       & allowFreezing       & allowFreezing, groundAtK1,
223         & usePickupBeforeC35, debugMode,
224         & readPickupWithTracer, writePickupWithTracer,
225         & multiDimAdvection, useEnergyConservingCoriolis
226        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
227        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
228          LOGICAL usingCurvilinearGrid
229        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
230        LOGICAL no_slip_sides        LOGICAL no_slip_sides
231        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
232          LOGICAL staggerTimeStep
233        LOGICAL momViscosity        LOGICAL momViscosity
234        LOGICAL momAdvection        LOGICAL momAdvection
235        LOGICAL momForcing        LOGICAL momForcing
236        LOGICAL momPressureForcing        LOGICAL momPressureForcing
237        LOGICAL useCoriolis        LOGICAL useCoriolis
238          LOGICAL vectorInvariantMomentum
239        LOGICAL tempDiffusion        LOGICAL tempDiffusion
240        LOGICAL tempAdvection        LOGICAL tempAdvection
241        LOGICAL tempForcing        LOGICAL tempForcing
242        LOGICAL saltDiffusion        LOGICAL saltDiffusion
243        LOGICAL saltAdvection        LOGICAL saltAdvection
244        LOGICAL saltForcing        LOGICAL saltForcing
       LOGICAL implicitFreeSurface  
245        LOGICAL rigidLid        LOGICAL rigidLid
246          LOGICAL implicitFreeSurface
247          LOGICAL exactConserv
248          LOGICAL uniformLin_PhiSurf
249        LOGICAL momStepping        LOGICAL momStepping
250        LOGICAL tempStepping        LOGICAL tempStepping
251        LOGICAL saltStepping        LOGICAL saltStepping
252          LOGICAL tr1Stepping
253        LOGICAL metricTerms        LOGICAL metricTerms
254        LOGICAL useConstantF        LOGICAL useConstantF
255        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
# Line 222  C     allowFreezing  - Allows water to f Line 258  C     allowFreezing  - Allows water to f
258        LOGICAL implicitViscosity        LOGICAL implicitViscosity
259        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
260        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
261          LOGICAL doTr1ClimRelax
262        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
263        LOGICAL usingPCoords        LOGICAL usingPCoords
264        LOGICAL usingZCoords        LOGICAL usingZCoords
       LOGICAL openBoundaries  
265        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
266        LOGICAL globalFiles        LOGICAL globalFiles
267        LOGICAL allowFreezing        LOGICAL allowFreezing
268          LOGICAL groundAtK1
269          LOGICAL usePickupBeforeC35
270          LOGICAL debugMode
271          LOGICAL readPickupWithTracer
272          LOGICAL writePickupWithTracer
273          LOGICAL multiDimAdvection
274          LOGICAL useEnergyConservingCoriolis
275    
276  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
277  C     cg2dTargetResidual  C     gg2dTargetResidual
278  C               - Target residual for cg2d solver.  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
279    C     cg2dTargetResWunit
280    C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
281  C     cg3dTargetResidual  C     cg3dTargetResidual
282  C               - Target residual for cg3d solver.  C               :: Target residual for cg3d solver.
283  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
284  C     Note. 20th May 1998  C     Note. 20th May 1998
285  C           I made a weird discovery! In the model paper we argue  C           I made a weird discovery! In the model paper we argue
286  C           for the form of the preconditioner used here ( see  C           for the form of the preconditioner used here ( see
# Line 249  C           number of iterations for con Line 294  C           number of iterations for con
294  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
295  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
296  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
297  C     delP      - Vertical grid spacing ( Pa ).  C     delP      :: Vertical grid spacing ( Pa ).
298  C     delZ      - Vertical grid spacing ( m  ).  C     delZ      :: Vertical grid spacing ( m  ).
299  C     delR      - Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
300  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
301  C     delY        on input flags.  C     delY        on input flags.
302  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
303  C     recip_gravity and its inverse  C     recip_gravity and its inverse
304  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 )
305  C     ronil     - Reference density  C     ronil     :: Reference density
306  C     rhoConst  - Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
307  C     startTime - Start time for model ( s )  C     startTime :: Start time for model ( s )
308  C     phiMin    - Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
309  C     thetaMin  - Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
310  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
311  C                 to make geographical references simple.)  C                 to make geographical references simple.)
312  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).
313  C     recip_RSphere  - Reciprocal radius of sphere ( m ).  C     recip_RSphere  :: Reciprocal radius of sphere ( m ).
314  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        :: Reference coriolis parameter ( 1/s )
315  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
316  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
317  C     omega     - Angular velocity ( rad/s )  C     omega     :: Angular velocity ( rad/s )
318  C     viscAh    - Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
319  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
320  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    :: Eddy viscosity coeff. for mixing of
321  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
322  C     viscAp    - Eddy viscosity coeff. for mixing of  C     viscAp    :: Eddy viscosity coeff. for mixing of
323  C                 momentum vertically ( Pa^2/s )  C                 momentum vertically ( Pa^2/s )
324  C     viscAr    - Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
325  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
326  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
327  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
328  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
329  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
330  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   :: Laplacian diffusion coeff. for mixing of
331  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
332  C     diffKpT   - Laplacian diffusion coeff. for mixing of  C     diffKpT   :: Laplacian diffusion coeff. for mixing of
333  C                 heat vertically ( Pa^2/s )  C                 heat vertically ( Pa^2/s )
334  C     diffKrT   - Laplacian diffusion coeff. for mixing of  C     diffKrT   :: Laplacian diffusion coeff. for mixing of
335  C                 heat vertically ( units of r^2/s )  C                 heat vertically ( units of r^2/s )
336  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
337  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
338  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
339  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
340  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   :: Laplacian diffusion coeff. for mixing of
341  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
342  C     diffKpS   - Laplacian diffusion coeff. for mixing of  C     diffKpS   :: Laplacian diffusion coeff. for mixing of
343  C                 salt vertically ( Pa^2/s )  C                 salt vertically ( Pa^2/s )
344  C     diffKrS   - Laplacian diffusion coeff. for mixing of  C     diffKrS   :: Laplacian diffusion coeff. for mixing of
345  C                 salt vertically ( units of r^2/s )  C                 salt vertically ( units of r^2/s )
346  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
347  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
348  C     deltaT    - Default timestep ( s )  C     deltaT    :: Default timestep ( s )
349  C     deltaTClock  - Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
350  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
351  C                    be totally different to the dynamical time. Typically  C                    be totally different to the dynamical time. Typically
352  C                    it will be the deep-water timestep for accelerated runs.  C                    it will be the deep-water timestep for accelerated runs.
353  C                    Frequency of checkpointing and dumping of the model state  C                    Frequency of checkpointing and dumping of the model state
354  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
355  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
356  C     deltaTtracer - Timestep for tracer equations ( s )  C     deltaTtracer :: Timestep for tracer equations ( s )
357  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
358  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
359  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
360  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
361  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
362  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
363  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)  C                     Implicit part of barotropic flow Divergence ( 0-1 )
364  C     tauCD        - CD scheme coupling timescale ( 1/s )  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
365  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)
366  C     GMmaxslope    - max. slope allowed in GM/Redi tensor  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
367  C     GMlength      - Length to use in Visbeck et al. formula for K (m)  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
368  C     GMalpha       - alpha to use in Visbeck et al. formula for K  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
369  C     GMdepth       - Depth over which to integrate Richardson # (Visbeck et al.)  C     hFacSup        that control vanishing and creating levels
370  C     GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s )  C     tauCD        :: CD scheme coupling timescale ( 1/s )
371  C     GMmaxval      - max. value of KapGM allowed in GM/Redi scheme ( m^2/s )  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
372  C     startTime     - Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
373  C     endTime       - Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
374  C     chkPtFreq     - Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
375  C     pChkPtFreq    - Frequency of permanent check pointing ( s ).  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
376  C     dumpFreq      - Frequency with which model state is written to  C     dumpFreq      :: Frequency with which model state is written to
377  C                     post-processing files ( s ).  C                     post-processing files ( s ).
378  C     afFacMom      - Advection of momentum term tracer parameter  C     diagFreq      :: Frequency with which model writes diagnostic output
379  C     vfFacMom      - Momentum viscosity tracer parameter  C                     of intermediate quantities.
380  C     pfFacMom      - Momentum pressure forcing tracer parameter  C     afFacMom      :: Advection of momentum term tracer parameter
381  C     cfFacMom      - Coriolis term tracer parameter  C     vfFacMom      :: Momentum viscosity tracer parameter
382  C     foFacMom      - Momentum forcing tracer parameter  C     pfFacMom      :: Momentum pressure forcing tracer parameter
383  C     mtFacMom      - Metric terms tracer parameter  C     cfFacMom      :: Coriolis term tracer parameter
384  C     cosPower      - Power of cosine of latitude to multiply viscosity  C     foFacMom      :: Momentum forcing tracer parameter
385  C     cAdjFreq      - Frequency of convective adjustment  C     mtFacMom      :: Metric terms tracer parameter
386    C     cosPower      :: Power of cosine of latitude to multiply viscosity
387    C     cAdjFreq      :: Frequency of convective adjustment
388  C  C
389  C     taveFreq      - Frequency with which time-averaged model state is written to  C     taveFreq      :: Frequency with which time-averaged model state is written to
390  C                     post-processing files ( s ).  C                     post-processing files ( s ).
391  C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
392  C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
393  C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
394  C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
395  C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
396  C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
397  C                          (note: externForcingCycle must be an integer  C                          (note: externForcingCycle must be an integer
398  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
399  C     horiVertRatio      - Ratio on units in vertical to units in horizontal.  C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.
400  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
401  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
402  C     latFFTFiltLo       - Low latitude for FFT filtering of latitude  C     latFFTFiltLo       :: Low latitude for FFT filtering of latitude
403  C                          circles ( see filter*.F )  C                          circles ( see filter*.F )
404        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,  C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as
405       & cg3dTargetResidual,  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
406    C     bottomDragLinear   :: Drag coefficient built in to core dynamics
407    C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
408          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
409         & cg2dpcOffDFac, cg3dTargetResidual,
410       & delP, delZ, delR, delX, delY,       & delP, delZ, delR, delX, delY,
411       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
412       & phiMin, thetaMin, rSphere, recip_RSphere, f0, fCori, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
413       & viscAh,  viscAz,  viscA4,  viscAr,       & fCori, fCoriG,
414         & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,
415       & diffKhT, diffKzT, diffK4T, diffKrT,       & diffKhT, diffKzT, diffK4T, diffKrT,
416       & diffKhS, diffKzS, diffK4S, diffKrS,       & diffKhS, diffKzS, diffK4S, diffKrS,
417       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
418       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
419       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
420       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst, tRef, sRef,
421       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
422         & diagFreq, taveFreq, monitorFreq,
423       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
424       & cosPower,       & cosPower, cAdjFreq, omega,
425       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, lambdaThetaClimRelax,
426       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
427         & tauTr1ClimRelax, lambdaTr1ClimRelax,
428       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
429       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
430       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
431       & latFFTFiltLo, ivdc_kappa       & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,
432         & bottomDragLinear,bottomDragQuadratic
433    
434        _RL cg2dTargetResidual        _RL cg2dTargetResidual
435          _RL cg2dTargetResWunit
436        _RL cg3dTargetResidual        _RL cg3dTargetResidual
437        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
438        _RL delZ(Nr)        _RL delZ(Nr)
# Line 395  C                          circles ( see Line 451  C                          circles ( see
451        _RL recip_RSphere        _RL recip_RSphere
452        _RL f0        _RL f0
453        _RL freeSurfFac        _RL freeSurfFac
454          _RL implicSurfPress
455          _RL implicDiv2Dflow
456        _RL hFacMin        _RL hFacMin
457        _RL hFacMinDz        _RL hFacMinDz
458        _RL hFacMinDp        _RL hFacMinDp
459        _RL hFacMinDr        _RL hFacMinDr
460          _RL hFacInf
461          _RL hFacSup
462        _RL beta        _RL beta
463        _RL viscAh        _RL viscAh
464          _RL viscAstrain
465          _RL viscAtension
466        _RL viscAz        _RL viscAz
467        _RL viscAp        _RL viscAp
468        _RL viscAr        _RL viscAr
# Line 418  C                          circles ( see Line 480  C                          circles ( see
480        _RL delt        _RL delt
481        _RL tauCD        _RL tauCD
482        _RL rCD        _RL rCD
       _RL GMmaxslope  
       _RL GMlength  
       _RL GMalpha  
       _RL GMdepth  
       _RL GMkbackground  
       _RL GMmaxval  
483        _RL gravity        _RL gravity
484        _RL recip_gravity        _RL recip_gravity
485        _RL gBaro        _RL gBaro
# Line 435  C                          circles ( see Line 491  C                          circles ( see
491        _RL tRef(Nr)        _RL tRef(Nr)
492        _RL theta_S(Nr)        _RL theta_S(Nr)
493        _RL sRef(Nr)        _RL sRef(Nr)
494        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
495          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
496        _RL startTime        _RL startTime
497        _RL endTime        _RL endTime
498        _RL chkPtFreq        _RL chkPtFreq
499        _RL pChkPtFreq        _RL pChkPtFreq
500        _RL dumpFreq        _RL dumpFreq
501          _RL diagFreq
502        _RL taveFreq        _RL taveFreq
503          _RL monitorFreq
504        _RL afFacMom        _RL afFacMom
505        _RL vfFacMom        _RL vfFacMom
506        _RL pfFacMom        _RL pfFacMom
# Line 455  C                          circles ( see Line 514  C                          circles ( see
514        _RL lambdaThetaClimRelax        _RL lambdaThetaClimRelax
515        _RL tauSaltClimRelax        _RL tauSaltClimRelax
516        _RL lambdaSaltClimRelax        _RL lambdaSaltClimRelax
517          _RL tauTr1ClimRelax
518          _RL lambdaTr1ClimRelax
519        _RL externForcingCycle        _RL externForcingCycle
520        _RL externForcingPeriod        _RL externForcingPeriod
521        _RL horiVertRatio        _RL horiVertRatio
522        _RL recip_horiVertRatio        _RL recip_horiVertRatio
523        _RL latFFTFiltLo        _RL latFFTFiltLo
524        _RL ivdc_kappa        _RL ivdc_kappa
525          _RL Ro_SeaLevel
526          _RL zonal_filt_lat
527          _RL bottomDragLinear
528          _RL bottomDragQuadratic
529    
530        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
531       &                Lamba_theta       &                Lamba_theta
# Line 472  C Equation of State (polynomial coeffien Line 537  C Equation of State (polynomial coeffien
537        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
538        _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)
539  C Linear equation of state  C Linear equation of state
540  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    :: Linear EOS thermal expansion coefficient ( 1/degree ).
541  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     :: Linear EOS haline contraction coefficient.
542        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
543        _RL tAlpha        _RL tAlpha
544        _RL sBeta        _RL sBeta
545        character*(6) eosType        character*(6) eosType
546    
547  C These are input arrays (of integers) that contain the *absolute*  C Atmospheric physical parameters (Ideal Gas EOS, ...)
548  C computational index of an open-boundary (OB) point.  C     atm_po    :: standard reference pressure
549  C A zero (0) element means there is no corresponding OB in that column/row.  C     atm_cp    :: specific heat (Cp) of the (dry) air at constant pressure
550  C The computational coordinate refers to "tracer" cells.  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
551  C For a northern/southern OB, the OB V point is to the south/north.  C     Integr_GeoPot :: option to select the way we integrate the geopotential
552  C For an eastern/western OB, the OB U point is to the west/east.  C                     (still a subject of discussions ...)
553  C eg.        COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,
554  C     OB_Jnorth(3)=34  means that:       &                  Integr_GeoPot
555  C          T( 3 ,34) is a an OB point        _RL atm_cp, atm_kappa, atm_po
556  C          U(3:4,34) is a an OB point        INTEGER Integr_GeoPot
557  C          V( 4 ,34) is a an OB point  
558  C while  C Logical flags for selecting packages
559  C     OB_Jsouth(3)=1  means that:        LOGICAL useKPP
560  C          T( 3 ,1) is a an OB point        LOGICAL useGMRedi
561  C          U(3:4,1) is a an OB point        LOGICAL useOBCS
562  C          V( 4 ,2) is a an OB point        LOGICAL useAIM
563  C        LOGICAL useGrdchk
564  C For convenience, negative values for Jnorth/Ieast refer to        LOGICAL useECCO
565  C points relative to the Northern/Eastern edges of the model        LOGICAL useSHAP_FILT
566  C eg. OB_Jnorth(3)=-1  means that the point (3,Ny-1) is a northern O-B.        LOGICAL useFLT
567  C        COMMON /PARM_PACKAGES/
568        COMMON /PARM_OB/       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
569       & OB_Jnorth,OB_Jsouth,OB_Ieast,OB_Iwest       &        useSHAP_FILT, useGrdchk, useFLT
570        INTEGER OB_Jnorth(Nx)  
       INTEGER OB_Jsouth(Nx)  
       INTEGER OB_Ieast(Ny)  
       INTEGER OB_Iwest(Ny)  
Legend:
Removed from v.1.43  
changed lines
  Added in v.1.65
  ViewVC Help
Powered by ViewVC 1.1.22