/[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.7 by cnh, Thu May 21 18:28:50 1998 UTC revision 1.57 by adcroft, Wed Aug 15 15:51:46 2001 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2    C $Name$
3  C  C
4  C     /==========================================================\  C     /==========================================================\
5  C     | PARAMS.h                                                 |  C     | PARAMS.h                                                 |
6  C     | o Header file defining model "parameters".               |  C     | o Header file defining model "parameters".               |
7  C     |==========================================================|  C     |==========================================================|
8  C     | The values from the model's standard input file are      |  C     | The values from the model standard input file are        |
9  C     | stored into the variables held here. Notes describing    |  C     | stored into the variables held here. Notes describing    |
10  C     | the parameters can also be found here.                   |  C     | the parameters can also be found here.                   |
11  C     \==========================================================/  C     \==========================================================/
12    
13    C     Macros for special grid options
14    #include "PARAMS_MACROS.h"
15    
16  C--   Contants  C--   Contants
17  C     Useful physical values  C     Useful physical values
18        Real*8 PI        Real*8 PI
# Line 20  C     Symbolic values Line 24  C     Symbolic values
24  C     precXXXX - Used to indicate what precision to use for  C     precXXXX - Used to indicate what precision to use for
25  C                dumping model state.  C                dumping model state.
26        INTEGER precFloat32        INTEGER precFloat32
27        PARAMETER ( precFloat32 = 0 )        PARAMETER ( precFloat32 = 32 )
28        INTEGER precFloat64        INTEGER precFloat64
29        PARAMETER ( precFloat64 = 1 )        PARAMETER ( precFloat64 = 64 )
30    C     UNSET_xxx - Used to indicate variables that have not been given a value
31          Real*8 UNSET_FLOAT8
32          PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
33          Real*4 UNSET_FLOAT4
34          PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
35          _RL    UNSET_RL    
36          PARAMETER ( UNSET_RL     = 1.234567D5 )
37          _RS    UNSET_RS    
38          PARAMETER ( UNSET_RS     = 1.234567E5 )
39          INTEGER UNSET_I
40          PARAMETER ( UNSET_I      = 123456789  )
41    
42  C     Checkpoint data  C     Checkpoint data
43        INTEGER maxNoChkptLev        INTEGER maxNoChkptLev
# Line 30  C     Checkpoint data Line 45  C     Checkpoint data
45    
46  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
47  C     checkPtSuff - List of checkpoint file suffices  C     checkPtSuff - List of checkpoint file suffices
48        COMMON /PARM_C/ checkPtSuff  C     bathyFile   - File containing bathymetry. If not defined bathymetry
49    C                   is taken from inline function.
50    C     topoFile    - File containing the topography of the surface (unit=m)
51    C                   (mainly used for the atmosphere = ground height).
52    C     hydrogThetaFile - File containing initial hydrographic data for potential
53    C                       temperature.
54    C     hydrogSaltFile  - File containing initial hydrographic data for salinity.
55    C     zonalWindFile   - File containing zonal wind data
56    C     meridWindFile   - File containing meridional wind data
57    C     thetaClimFile   - File containing theta climataology used
58    C                       in relaxation term -lambda(theta-theta*)
59    C     saltClimFile    - File containing salt climataology used
60    C                       in relaxation term -lambda(salt-salt*)
61    C     surfQfile       - File containing surface heat flux
62    C     surfQswfile     - File containing surface shortwave radiation
63    C     dQdTfile        - File containing thermal relaxation coefficient
64    C     EmPmRfile       - File containing surface fresh water flux
65    C     buoyancyRelation - Flag used to indicate which relation to use to
66    C                        get buoyancy.
67          COMMON /PARM_C/ checkPtSuff,
68         &                bathyFile, topoFile,
69         &                hydrogThetaFile, hydrogSaltFile,
70         &                zonalWindFile, meridWindFile, thetaClimFile,
71         &                saltClimFile, buoyancyRelation,
72         &                EmPmRfile, surfQfile, surfQswfile,
73         &                uVelInitFile, vVelInitFile, pSurfInitFile,
74         &                dQdTfile
75        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
76          CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
77          CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
78          CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
79          CHARACTER*(MAX_LEN_FNAM) zonalWindFile
80          CHARACTER*(MAX_LEN_FNAM) meridWindFile
81          CHARACTER*(MAX_LEN_FNAM) thetaClimFile
82          CHARACTER*(MAX_LEN_FNAM) saltClimFile
83          CHARACTER*(MAX_LEN_FNAM) surfQfile
84          CHARACTER*(MAX_LEN_FNAM) surfQswfile
85          CHARACTER*(MAX_LEN_FNAM) EmPmRfile
86          CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
87          CHARACTER*(MAX_LEN_FNAM) uVelInitFile
88          CHARACTER*(MAX_LEN_FNAM) vVelInitFile
89          CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
90          CHARACTER*(MAX_LEN_FNAM) dQdTfile
91    
92  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
93  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        - Maximum number of iterations in the
94  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
95  C     cg2dChkResFreq      - Frequency with which to check residual  C     cg2dChkResFreq      - Frequency with which to check residual
96  C                           in con. grad solver.  C                           in con. grad solver.
97    C     cg3dMaxIters        - Maximum number of iterations in the
98    C                           three-dimensional con. grad solver.
99    C     cg3dChkResFreq      - Frequency with which to check residual
100    C                           in con. grad solver.
101  C     nIter0              - Start time-step number of for this run  C     nIter0              - Start time-step number of for this run
102  C     nTimeSteps          - Number of timesteps to execute  C     nTimeSteps          - Number of timesteps to execute
103  C     numStepsPerPickup   - For offline setup. Frequency of pickup  C     numStepsPerPickup   - For offline setup. Frequency of pickup
# Line 46  C     writeStatePrec      - Precision us Line 106  C     writeStatePrec      - Precision us
106  C     writeBinaryPrec     - Precision used for writing binary files  C     writeBinaryPrec     - Precision used for writing binary files
107  C     readBinaryPrec      - Precision used for reading binary files  C     readBinaryPrec      - Precision used for reading binary files
108  C     nCheckLev           - Holds current checkpoint level  C     nCheckLev           - Holds current checkpoint level
109    C     nonlinFreeSurf      - option related to non-linear free surface
110    C                           =0 Linear free surface ; >0 Non-linear
111    
112        COMMON /PARM_I/        COMMON /PARM_I/
113       &        cg2dMaxIters,       &        cg2dMaxIters,
114       &        cg2dChkResFreq,       &        cg2dChkResFreq,
115       &        nIter0, nTimeSteps,       &        cg3dMaxIters,
116         &        cg3dChkResFreq,
117         &        nIter0, nTimeSteps, nEndIter,
118       &        numStepsPerPickup,       &        numStepsPerPickup,
119       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
120       &        writeBinaryPrec, readBinaryPrec       &        writeBinaryPrec, readBinaryPrec,
121         &        nonlinFreeSurf,
122         &        zonal_filt_sinpow, zonal_filt_cospow,
123         &        tempAdvScheme, saltAdvScheme, tracerAdvScheme
124        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
125        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
126          INTEGER cg3dMaxIters
127          INTEGER cg3dChkResFreq
128        INTEGER nIter0        INTEGER nIter0
129        INTEGER nTimeSteps        INTEGER nTimeSteps
130          INTEGER nEndIter
131        INTEGER numStepsPerPickup        INTEGER numStepsPerPickup
132        INTEGER writeStatePrec        INTEGER writeStatePrec
133        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
134        INTEGER readBinaryPrec        INTEGER readBinaryPrec
135        INTEGER nCheckLev        INTEGER nCheckLev
136          INTEGER nonlinFreeSurf
137          INTEGER zonal_filt_sinpow
138          INTEGER zonal_filt_cospow
139          INTEGER tempAdvScheme
140          INTEGER saltAdvScheme
141          INTEGER tracerAdvScheme
142    
143  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
144  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian
145  C                          coordinate frame.  C                          coordinate frame.
146  C     usingSphericalPolarGrid - If TRUE grid generation will be in a  C     usingSphericalPolarGrid - If TRUE grid generation will be in a
147  C                               spherical polar frame.  C                               spherical polar frame.
148    C     no_slip_sides - Impose "no-slip" at lateral boundaries.
149    C     no_slip_bottom- Impose "no-slip" at bottom boundary.
150    C     staggerTimeStep - enable a Stagger time stepping T,S Rho then U,V
151  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     momViscosity  - Flag which turns momentum friction terms on and off.
152  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momAdvection  - Flag which turns advection of momentum on and off.
153  C     momForcing    - Flag which turns external forcing of momentum on  C     momForcing    - Flag which turns external forcing of momentum on
154  C                     and off.  C                     and off.
155    C     momPressureForcing - Flag which turns pressure term in momentum equation
156    C                          on and off.
157    C     metricTerms   - Flag which turns metric terms on or off.
158    C     usingSphericalPolarMTerms - If TRUE use spherical polar metric terms.
159  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     useCoriolis   - Flag which turns the coriolis terms on and off.
160  C     tempDiffusion - Flag which turns diffusion of temperature on  C     tempDiffusion - Flag which turns diffusion of temperature on
161  C                     and off.  C                     and off.
# Line 85  C     saltAdvection - Flag which turns a Line 169  C     saltAdvection - Flag which turns a
169  C                     and off.  C                     and off.
170  C     saltForcing   - Flag which turns external forcing of salinit on  C     saltForcing   - Flag which turns external forcing of salinit on
171  C                     and off.  C                     and off.
172    C     rigidLid            - Set to true to use rigid lid
173    C     implicitFreeSurface - Set to true to use implcit free surface
174    C     exactConserv        - Set to true to conserve exactly the total Volume
175    C     uniformLin_PhiSurf  - Set to true to use a uniform Bo_surf in the
176    C                           linear relation Phi_surf = Bo_surf*eta
177    C     momStepping   - Turns momentum equation time-stepping off
178    C     tempStepping  - Turns temperature equation time-stepping off
179    C     saltStepping  - Turns salinity equation time-stepping off
180    C     tr1Stepping   - Turns passive tracer 1 time-stepping on/off
181    C     useConstantF  - Coriolis parameter set to f0
182    C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
183    C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
184    C     implicitDiffusion - Turns implicit vertical diffusion on
185    C     implicitViscosity - Turns implicit vertical viscosity on
186    C     doThetaClimRelax - Set true if relaxation to temperature
187    C                        climatology is required.
188    C     doSaltClimRelax  - Set true if relaxation to salinity
189    C                        climatology is required.
190    C     periodicExternalForcing - Set true if forcing is time-dependant
191    C     usingPCoords     - Set to indicate that we are working in pressure
192    C                        coords.
193    C     usingZCoords     - Set to indicate that we are working in height
194    C                        coords.
195    C     nonHydrostatic - Using non-hydrostatic terms
196    C     globalFiles    - Selects between "global" and "tiled" files
197    C     allowFreezing  - Allows water to freeze and form ice
198    C     groundAtK1  - put the surface(k=1) at the Lower Boundary (=ground)
199        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
200       & momViscosity, momAdvection, momForcing, useCoriolis,       & usingCurvilinearGrid,
201       & tempDiffusion, tempAdvection, tempForcing,       & no_slip_sides,no_slip_bottom,
202       & saltDiffusion, saltAdvection, saltForcing       & staggerTimeStep,
203         & momViscosity, momAdvection, momForcing, useCoriolis,
204         & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,
205         & saltDiffusion, saltAdvection, saltForcing,
206         & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
207         & momStepping, tempStepping, saltStepping, tr1Stepping,
208         & metricTerms, usingSphericalPolarMTerms,
209         & useConstantF, useBetaPlaneF, useSphereF,
210         & implicitDiffusion, implicitViscosity,
211         & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
212         & periodicExternalForcing, usingPCoords, usingZCoords,
213         & nonHydrostatic, globalFiles,
214         & allowFreezing, groundAtK1,
215         & usePickupBeforeC35, debugMode,
216         & readPickupWithTracer, writePickupWithTracer
217        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
218        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
219          LOGICAL usingCurvilinearGrid
220          LOGICAL usingSphericalPolarMTerms
221          LOGICAL no_slip_sides
222          LOGICAL no_slip_bottom
223          LOGICAL staggerTimeStep
224        LOGICAL momViscosity        LOGICAL momViscosity
225        LOGICAL momAdvection        LOGICAL momAdvection
226        LOGICAL momForcing        LOGICAL momForcing
227          LOGICAL momPressureForcing
228        LOGICAL useCoriolis        LOGICAL useCoriolis
229        LOGICAL tempDiffusion        LOGICAL tempDiffusion
230        LOGICAL tempAdvection        LOGICAL tempAdvection
# Line 101  C                     and off. Line 232  C                     and off.
232        LOGICAL saltDiffusion        LOGICAL saltDiffusion
233        LOGICAL saltAdvection        LOGICAL saltAdvection
234        LOGICAL saltForcing        LOGICAL saltForcing
235          LOGICAL rigidLid
236          LOGICAL implicitFreeSurface
237          LOGICAL exactConserv
238          LOGICAL uniformLin_PhiSurf
239          LOGICAL momStepping
240          LOGICAL tempStepping
241          LOGICAL saltStepping
242          LOGICAL tr1Stepping
243          LOGICAL metricTerms
244          LOGICAL useConstantF
245          LOGICAL useBetaPlaneF
246          LOGICAL useSphereF
247          LOGICAL implicitDiffusion
248          LOGICAL implicitViscosity
249          LOGICAL doThetaClimRelax
250          LOGICAL doSaltClimRelax
251          LOGICAL doTr1ClimRelax
252          LOGICAL periodicExternalForcing
253          LOGICAL usingPCoords
254          LOGICAL usingZCoords
255          LOGICAL nonHydrostatic
256          LOGICAL globalFiles
257          LOGICAL allowFreezing
258          LOGICAL groundAtK1
259          LOGICAL usePickupBeforeC35
260          LOGICAL debugMode
261          LOGICAL readPickupWithTracer
262          LOGICAL writePickupWithTracer
263    
264  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
265  C     cg2dTargetResidual  C     gg2dTargetResidual
266  C               - Target residual for cg2d solver.  C          - Target residual for cg2d solver; no unit (RHS normalisation)
267    C     cg2dTargetResWunit
268    C          - Target residual for cg2d solver; W unit (No RHS normalisation)
269    C     cg3dTargetResidual
270    C               - Target residual for cg3d solver.
271  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
272  C     Note. 20th May 1998  C     Note. 20th May 1998
273  C           I made a weird discovery! In the model paper we argue  C           I made a weird discovery! In the model paper we argue
# Line 119  C           number of iterations for con Line 282  C           number of iterations for con
282  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
283  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
284  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
285  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     delP      - Vertical grid spacing ( Pa ).
286  C                 between "w" surfaces.  C     delZ      - Vertical grid spacing ( m  ).
287    C     delR      - Vertical grid spacing ( units of r ).
288  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
289  C     delY        on input flags.  C     delY        on input flags.
290  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
291    C     recip_gravity and its inverse
292    C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )
293  C     ronil     - Reference density  C     ronil     - Reference density
294    C     rhoConst  - Vertically constant reference density
295  C     startTime - Start time for model ( s )  C     startTime - Start time for model ( s )
296  C     phiMin    - Latitude of southern most cell face.  C     phiMin    - Latitude of southern most cell face.
297  C     thetaMin  - Longitude of western most cell face (this  C     thetaMin  - Longitude of western most cell face (this
298  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
299  C                 to make geographical references simple.)  C                 to make geographical references simple.)
300  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).
301    C     recip_RSphere  - Reciprocal radius of sphere ( m ).
302  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        - Reference coriolis parameter ( 1/s )
303  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
304  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      - df/dy ( s^-1.m^-1 )
305    C     omega     - Angular velocity ( rad/s )
306  C     viscAh    - Eddy viscosity coeff. for mixing of  C     viscAh    - Eddy viscosity coeff. for mixing of
307  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
308  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    - Eddy viscosity coeff. for mixing of
309  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
310    C     viscAp    - Eddy viscosity coeff. for mixing of
311    C                 momentum vertically ( Pa^2/s )
312    C     viscAr    - Eddy viscosity coeff. for mixing of
313    C                 momentum vertically ( units of r^2/s )
314  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscA4    - Biharmonic viscosity coeff. for mixing of
315  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
316  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   - Laplacian diffusion coeff. for mixing of
317  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
318  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   - Laplacian diffusion coeff. for mixing of
319  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
320    C     diffKpT   - Laplacian diffusion coeff. for mixing of
321    C                 heat vertically ( Pa^2/s )
322    C     diffKrT   - Laplacian diffusion coeff. for mixing of
323    C                 heat vertically ( units of r^2/s )
324  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   - Biharmonic diffusion coeff. for mixing of
325  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
326  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  -  Laplacian diffusion coeff. for mixing of
327  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
328  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   - Laplacian diffusion coeff. for mixing of
329  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
330    C     diffKpS   - Laplacian diffusion coeff. for mixing of
331    C                 salt vertically ( Pa^2/s )
332    C     diffKrS   - Laplacian diffusion coeff. for mixing of
333    C                 salt vertically ( units of r^2/s )
334  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   - Biharmonic diffusion coeff. for mixing of
335  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
336  C     deltaT    - Default timestep ( s )  C     deltaT    - Default timestep ( s )
# Line 161  C                    Frequency of checkp Line 342  C                    Frequency of checkp
342  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
343  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    - Timestep for momemtum equations ( s )
344  C     deltaTtracer - Timestep for tracer equations ( s )  C     deltaTtracer - Timestep for tracer equations ( s )
345  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     freesurfFac  - Parameter to turn implicit free surface term on or off
346  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C                    freesurfac = 1. uses implicit free surface
347  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C                    freesurfac = 0. uses rigid lid
348  C     GMlength  - Length to use in Visbeck et al. formula for K  C     implicSurfPress - parameter of the Crank-Nickelson time stepping :
349  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
350  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C     implicDiv2Dflow - parameter of the Crank-Nickelson time stepping :
351  C     GMbackground - background value of GM/Redi coefficient  C                     Implicit part of barotropic flow Divergence ( 0-1 )
352  C     startTime - Starting time for this integration ( s ).  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
353  C     endTime   - Ending time for this integration ( s ).  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
354  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
355  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
356  C     dumpFreq  - Frequency with which model state is written to  C     hFacInf      - Threshold (inf and sup) for fraction size of surface cell
357  C                 post-processing files ( s ).  C     hFacSup        that control vanishing and creating levels
358        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,  C     tauCD        - CD scheme coupling timescale ( 1/s )
359       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
360       & thetaMin, rSphere, f0, fCori, beta, viscAh, viscAz, viscA4,  C     startTime     - Starting time for this integration ( s ).
361       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,  C     endTime       - Ending time for this integration ( s ).
362       & tauCD, rCD,  C     chkPtFreq     - Frequency of rolling check pointing ( s ).
363       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,  C     pChkPtFreq    - Frequency of permanent check pointing ( s ).
364       & gravity, rhonil, tRef, sRef,  C     dumpFreq      - Frequency with which model state is written to
365       & endTime, chkPtFreq, pchkPtFreq, dumpFreq  C                     post-processing files ( s ).
366    C     afFacMom      - Advection of momentum term tracer parameter
367    C     vfFacMom      - Momentum viscosity tracer parameter
368    C     pfFacMom      - Momentum pressure forcing tracer parameter
369    C     cfFacMom      - Coriolis term tracer parameter
370    C     foFacMom      - Momentum forcing tracer parameter
371    C     mtFacMom      - Metric terms tracer parameter
372    C     cosPower      - Power of cosine of latitude to multiply viscosity
373    C     cAdjFreq      - Frequency of convective adjustment
374    C
375    C     taveFreq      - Frequency with which time-averaged model state is written to
376    C                     post-processing files ( s ).
377    C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).
378    C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
379    C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
380    C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
381    C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
382    C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
383    C                          (note: externForcingCycle must be an integer
384    C                           number times externForcingPeriod)
385    C     horiVertRatio      - Ratio on units in vertical to units in horizontal.
386    C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
387    C                          ( g*rho if horiz in m and vertical in Pa ).
388    C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
389    C                          circles ( see filter*.F )
390    C     Ro_SeaLevel        - standard position of Sea-Level in "R" coordinate, used as
391    C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
392    C     bottomDragLinear   - Drag coefficient built in to core dynamics
393    C         "     Quadratic  ( linear: 1/s, quadratic: 1/m )
394          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
395         & cg2dpcOffDFac, cg3dTargetResidual,
396         & delP, delZ, delR, delX, delY,
397         & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
398         & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
399         & fCori, fCoriG,
400         & viscAh,  viscAz,  viscA4,  viscAr,
401         & diffKhT, diffKzT, diffK4T, diffKrT,
402         & diffKhS, diffKzS, diffK4S, diffKrS,
403         & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
404         & hFacMin, hFacMinDz, hFacInf, hFacSup,
405         & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
406         & recip_rhoConst, rhoConst, tRef, sRef,
407         & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq, monitorFreq,
408         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
409         & cosPower, cAdjFreq, omega,
410         & tauThetaClimRelax, lambdaThetaClimRelax,
411         & tauSaltClimRelax, lambdaSaltClimRelax,
412         & tauTr1ClimRelax, lambdaTr1ClimRelax,
413         & externForcingCycle, externForcingPeriod,
414         & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
415         & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
416         & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,
417         & bottomDragLinear,bottomDragQuadratic
418    
419        _RL cg2dTargetResidual        _RL cg2dTargetResidual
420          _RL cg2dTargetResWunit
421          _RL cg3dTargetResidual
422        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
423        _RL delZ(Nz)        _RL delZ(Nr)
424          _RL delP(Nr)
425          _RL delR(Nr)
426        _RL delX(Nx)        _RL delX(Nx)
427        _RL delY(Ny)        _RL delY(Ny)
428        _RL deltaT        _RL deltaT
# Line 195  C                 post-processing files Line 433  C                 post-processing files
433        _RL phiMin        _RL phiMin
434        _RL thetaMin        _RL thetaMin
435        _RL rSphere        _RL rSphere
436          _RL recip_RSphere
437        _RL f0        _RL f0
438          _RL freeSurfFac
439          _RL implicSurfPress
440          _RL implicDiv2Dflow
441          _RL hFacMin
442          _RL hFacMinDz
443          _RL hFacMinDp
444          _RL hFacMinDr
445          _RL hFacInf
446          _RL hFacSup
447        _RL beta        _RL beta
448        _RL viscAh        _RL viscAh
449        _RL viscAz        _RL viscAz
450          _RL viscAp
451          _RL viscAr
452        _RL viscA4        _RL viscA4
453        _RL diffKhT        _RL diffKhT
454          _RL diffKrT
455        _RL diffKzT        _RL diffKzT
456          _RL diffKpT
457        _RL diffK4T        _RL diffK4T
458        _RL diffKhS        _RL diffKhS
459          _RL diffKrS
460        _RL diffKzS        _RL diffKzS
461          _RL diffKpS
462        _RL diffK4S        _RL diffK4S
463        _RL delt        _RL delt
464        _RL tauCD        _RL tauCD
465        _RL rCD        _RL rCD
       _RL GMmaxslope  
       _RL GMlength  
       _RL GMalpha  
       _RL GMdepth  
       _RL GMkbackground  
466        _RL gravity        _RL gravity
467          _RL recip_gravity
468          _RL gBaro
469        _RL rhonil        _RL rhonil
470        _RL tRef(Nz)        _RL recip_rhonil
471        _RL sRef(Nz)        _RL rhoConst
472        _RL Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL recip_rhoConst
473          _RL specVol_S(Nr)
474          _RL tRef(Nr)
475          _RL theta_S(Nr)
476          _RL sRef(Nr)
477          _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
478          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
479        _RL startTime        _RL startTime
480        _RL endTime        _RL endTime
481        _RL chkPtFreq        _RL chkPtFreq
482        _RL pChkPtFreq        _RL pChkPtFreq
483        _RL dumpFreq        _RL dumpFreq
484          _RL taveFreq
485          _RL monitorFreq
486          _RL afFacMom
487          _RL vfFacMom
488          _RL pfFacMom
489          _RL cfFacMom
490          _RL foFacMom
491          _RL mTFacMom
492          _RL cosPower
493          _RL cAdjFreq
494          _RL omega
495          _RL tauThetaClimRelax
496          _RL lambdaThetaClimRelax
497          _RL tauSaltClimRelax
498          _RL lambdaSaltClimRelax
499          _RL tauTr1ClimRelax
500          _RL lambdaTr1ClimRelax
501          _RL externForcingCycle
502          _RL externForcingPeriod
503          _RL horiVertRatio
504          _RL recip_horiVertRatio
505          _RL latFFTFiltLo
506          _RL ivdc_kappa
507          _RL Ro_SeaLevel
508          _RL zonal_filt_lat
509          _RL bottomDragLinear
510          _RL bottomDragQuadratic
511    
512        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
513       &                Lamba_theta       &                Lamba_theta
514        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
515        _RL Lamba_theta        _RL Lamba_theta
516          _RL recip_Cp
517    
518  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
519        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
520        _RL eosC(Nz+1,9),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)        _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
521  C Linear equation of state  C Linear equation of state
522  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
523  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     - Linear EOS haline contraction coefficient.
524        COMMON /PARM_EOS_LIN/ tAlpha,sBeta        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
525        _RL tAlpha        _RL tAlpha
526        _RL sBeta        _RL sBeta
527          character*(6) eosType
528    
529    C Atmospheric physical parameters (Ideal Gas EOS, ...)
530    C     atm_po    - standard reference pressure
531    C     atm_cp    - specific heat (Cp) of the (dry) air at constant pressure
532    C     atm_kappa - kappa = R/Cp (R: constant of Ideal Gas EOS)
533    C     Integr_GeoPot - option to select the way we integrate the geopotential
534    C                     (still a subject of discussions ...)
535          COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,
536         &                  Integr_GeoPot
537          _RL atm_cp, atm_kappa, atm_po
538          INTEGER Integr_GeoPot
539    
540    C Logical flags for selecting packages
541          LOGICAL useKPP
542          LOGICAL useGMRedi
543          LOGICAL useOBCS
544          LOGICAL useAIM
545          LOGICAL useGrdchk
546          LOGICAL useECCO
547          LOGICAL useSHAP_FILT
548          COMMON /PARM_PACKAGES/
549         &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
550         &        useSHAP_FILT, useGrdchk
551    
Legend:
Removed from v.1.7  
changed lines
  Added in v.1.57
  ViewVC Help
Powered by ViewVC 1.1.22