/[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.9 by cnh, Mon May 25 20:05:55 1998 UTC revision 1.56 by heimbach, Fri Jul 13 14:15:29 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        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
124        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
125          INTEGER cg3dMaxIters
126          INTEGER cg3dChkResFreq
127        INTEGER nIter0        INTEGER nIter0
128        INTEGER nTimeSteps        INTEGER nTimeSteps
129          INTEGER nEndIter
130        INTEGER numStepsPerPickup        INTEGER numStepsPerPickup
131        INTEGER writeStatePrec        INTEGER writeStatePrec
132        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
133        INTEGER readBinaryPrec        INTEGER readBinaryPrec
134        INTEGER nCheckLev        INTEGER nCheckLev
135          INTEGER nonlinFreeSurf
136          INTEGER zonal_filt_sinpow
137          INTEGER zonal_filt_cospow
138    
139  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
140  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian
141  C                          coordinate frame.  C                          coordinate frame.
142  C     usingSphericalPolarGrid - If TRUE grid generation will be in a  C     usingSphericalPolarGrid - If TRUE grid generation will be in a
143  C                               spherical polar frame.  C                               spherical polar frame.
144    C     no_slip_sides - Impose "no-slip" at lateral boundaries.
145    C     no_slip_bottom- Impose "no-slip" at bottom boundary.
146    C     staggerTimeStep - enable a Stagger time stepping T,S Rho then U,V
147  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     momViscosity  - Flag which turns momentum friction terms on and off.
148  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momAdvection  - Flag which turns advection of momentum on and off.
149  C     momForcing    - Flag which turns external forcing of momentum on  C     momForcing    - Flag which turns external forcing of momentum on
150  C                     and off.  C                     and off.
151  C     momPressureForcing - Flag which turns pressure term in momentum equation  C     momPressureForcing - Flag which turns pressure term in momentum equation
152  C                          on and off.  C                          on and off.
153    C     metricTerms   - Flag which turns metric terms on or off.
154    C     usingSphericalPolarMTerms - If TRUE use spherical polar metric terms.
155  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     useCoriolis   - Flag which turns the coriolis terms on and off.
156  C     tempDiffusion - Flag which turns diffusion of temperature on  C     tempDiffusion - Flag which turns diffusion of temperature on
157  C                     and off.  C                     and off.
# Line 87  C     saltAdvection - Flag which turns a Line 165  C     saltAdvection - Flag which turns a
165  C                     and off.  C                     and off.
166  C     saltForcing   - Flag which turns external forcing of salinit on  C     saltForcing   - Flag which turns external forcing of salinit on
167  C                     and off.  C                     and off.
 C     implicitFreeSurface - Set to true to use implcit free surface  
168  C     rigidLid            - Set to true to use rigid lid  C     rigidLid            - Set to true to use rigid lid
169    C     implicitFreeSurface - Set to true to use implcit free surface
170    C     exactConserv        - Set to true to conserve exactly the total Volume
171    C     uniformLin_PhiSurf  - Set to true to use a uniform Bo_surf in the
172    C                           linear relation Phi_surf = Bo_surf*eta
173    C     momStepping   - Turns momentum equation time-stepping off
174    C     tempStepping  - Turns temperature equation time-stepping off
175    C     saltStepping  - Turns salinity equation time-stepping off
176    C     tr1Stepping   - Turns passive tracer 1 time-stepping on/off
177    C     useConstantF  - Coriolis parameter set to f0
178    C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
179    C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
180    C     implicitDiffusion - Turns implicit vertical diffusion on
181    C     implicitViscosity - Turns implicit vertical viscosity on
182    C     doThetaClimRelax - Set true if relaxation to temperature
183    C                        climatology is required.
184    C     doSaltClimRelax  - Set true if relaxation to salinity
185    C                        climatology is required.
186    C     periodicExternalForcing - Set true if forcing is time-dependant
187    C     usingPCoords     - Set to indicate that we are working in pressure
188    C                        coords.
189    C     usingZCoords     - Set to indicate that we are working in height
190    C                        coords.
191    C     nonHydrostatic - Using non-hydrostatic terms
192    C     globalFiles    - Selects between "global" and "tiled" files
193    C     allowFreezing  - Allows water to freeze and form ice
194    C     groundAtK1  - put the surface(k=1) at the Lower Boundary (=ground)
195        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
196       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,       & usingCurvilinearGrid,
197       & tempDiffusion, tempAdvection, tempForcing,       & no_slip_sides,no_slip_bottom,
198         & staggerTimeStep,
199         & momViscosity, momAdvection, momForcing, useCoriolis,
200         & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,
201       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
202       & implicitFreeSurface, rigidLid       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
203         & momStepping, tempStepping, saltStepping, tr1Stepping,
204         & metricTerms, usingSphericalPolarMTerms,
205         & useConstantF, useBetaPlaneF, useSphereF,
206         & implicitDiffusion, implicitViscosity,
207         & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
208         & periodicExternalForcing, usingPCoords, usingZCoords,
209         & nonHydrostatic, globalFiles,
210         & allowFreezing, groundAtK1,
211         & usePickupBeforeC35, debugMode,
212         & readPickupWithTracer, writePickupWithTracer
213        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
214        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
215          LOGICAL usingCurvilinearGrid
216          LOGICAL usingSphericalPolarMTerms
217          LOGICAL no_slip_sides
218          LOGICAL no_slip_bottom
219          LOGICAL staggerTimeStep
220        LOGICAL momViscosity        LOGICAL momViscosity
221        LOGICAL momAdvection        LOGICAL momAdvection
222        LOGICAL momForcing        LOGICAL momForcing
# Line 107  C     rigidLid            - Set to true Line 228  C     rigidLid            - Set to true
228        LOGICAL saltDiffusion        LOGICAL saltDiffusion
229        LOGICAL saltAdvection        LOGICAL saltAdvection
230        LOGICAL saltForcing        LOGICAL saltForcing
       LOGICAL implicitFreeSurface  
231        LOGICAL rigidLid        LOGICAL rigidLid
232          LOGICAL implicitFreeSurface
233          LOGICAL exactConserv
234          LOGICAL uniformLin_PhiSurf
235          LOGICAL momStepping
236          LOGICAL tempStepping
237          LOGICAL saltStepping
238          LOGICAL tr1Stepping
239          LOGICAL metricTerms
240          LOGICAL useConstantF
241          LOGICAL useBetaPlaneF
242          LOGICAL useSphereF
243          LOGICAL implicitDiffusion
244          LOGICAL implicitViscosity
245          LOGICAL doThetaClimRelax
246          LOGICAL doSaltClimRelax
247          LOGICAL doTr1ClimRelax
248          LOGICAL periodicExternalForcing
249          LOGICAL usingPCoords
250          LOGICAL usingZCoords
251          LOGICAL nonHydrostatic
252          LOGICAL globalFiles
253          LOGICAL allowFreezing
254          LOGICAL groundAtK1
255          LOGICAL usePickupBeforeC35
256          LOGICAL debugMode
257          LOGICAL readPickupWithTracer
258          LOGICAL writePickupWithTracer
259    
260  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
261  C     cg2dTargetResidual  C     gg2dTargetResidual
262  C               - Target residual for cg2d solver.  C          - Target residual for cg2d solver; no unit (RHS normalisation)
263    C     cg2dTargetResWunit
264    C          - Target residual for cg2d solver; W unit (No RHS normalisation)
265    C     cg3dTargetResidual
266    C               - Target residual for cg3d solver.
267  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
268  C     Note. 20th May 1998  C     Note. 20th May 1998
269  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 127  C           number of iterations for con Line 278  C           number of iterations for con
278  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
279  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
280  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
281  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     delP      - Vertical grid spacing ( Pa ).
282  C                 between "w" surfaces.  C     delZ      - Vertical grid spacing ( m  ).
283    C     delR      - Vertical grid spacing ( units of r ).
284  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
285  C     delY        on input flags.  C     delY        on input flags.
286  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
287    C     recip_gravity and its inverse
288  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 )
289  C     ronil     - Reference density  C     ronil     - Reference density
290    C     rhoConst  - Vertically constant reference density
291  C     startTime - Start time for model ( s )  C     startTime - Start time for model ( s )
292  C     phiMin    - Latitude of southern most cell face.  C     phiMin    - Latitude of southern most cell face.
293  C     thetaMin  - Longitude of western most cell face (this  C     thetaMin  - Longitude of western most cell face (this
294  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
295  C                 to make geographical references simple.)  C                 to make geographical references simple.)
296  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).
297    C     recip_RSphere  - Reciprocal radius of sphere ( m ).
298  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        - Reference coriolis parameter ( 1/s )
299  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
300  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      - df/dy ( s^-1.m^-1 )
301    C     omega     - Angular velocity ( rad/s )
302  C     viscAh    - Eddy viscosity coeff. for mixing of  C     viscAh    - Eddy viscosity coeff. for mixing of
303  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
304  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    - Eddy viscosity coeff. for mixing of
305  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
306    C     viscAp    - Eddy viscosity coeff. for mixing of
307    C                 momentum vertically ( Pa^2/s )
308    C     viscAr    - Eddy viscosity coeff. for mixing of
309    C                 momentum vertically ( units of r^2/s )
310  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscA4    - Biharmonic viscosity coeff. for mixing of
311  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
312  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   - Laplacian diffusion coeff. for mixing of
313  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
314  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   - Laplacian diffusion coeff. for mixing of
315  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
316    C     diffKpT   - Laplacian diffusion coeff. for mixing of
317    C                 heat vertically ( Pa^2/s )
318    C     diffKrT   - Laplacian diffusion coeff. for mixing of
319    C                 heat vertically ( units of r^2/s )
320  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   - Biharmonic diffusion coeff. for mixing of
321  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
322  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  -  Laplacian diffusion coeff. for mixing of
323  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
324  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   - Laplacian diffusion coeff. for mixing of
325  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
326    C     diffKpS   - Laplacian diffusion coeff. for mixing of
327    C                 salt vertically ( Pa^2/s )
328    C     diffKrS   - Laplacian diffusion coeff. for mixing of
329    C                 salt vertically ( units of r^2/s )
330  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   - Biharmonic diffusion coeff. for mixing of
331  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
332  C     deltaT    - Default timestep ( s )  C     deltaT    - Default timestep ( s )
# Line 173  C     deltaTtracer - Timestep for tracer Line 341  C     deltaTtracer - Timestep for tracer
341  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     freesurfFac  - Parameter to turn implicit free surface term on or off
342  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
343  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
344  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     implicSurfPress - parameter of the Crank-Nickelson time stepping :
345  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
346  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C     implicDiv2Dflow - parameter of the Crank-Nickelson time stepping :
347  C     GMlength  - Length to use in Visbeck et al. formula for K (m)  C                     Implicit part of barotropic flow Divergence ( 0-1 )
348  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
349  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
350  C     GMkbackground - background value of GM/Redi coefficient  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
351  C     startTime - Starting time for this integration ( s ).  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
352  C     endTime   - Ending time for this integration ( s ).  C     hFacInf      - Threshold (inf and sup) for fraction size of surface cell
353  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     hFacSup        that control vanishing and creating levels
354  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     tauCD        - CD scheme coupling timescale ( 1/s )
355  C     dumpFreq  - Frequency with which model state is written to  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
356  C                 post-processing files ( s ).  C     startTime     - Starting time for this integration ( s ).
357  C     afFacMom  - Advection of momentum term scaling parameter  C     endTime       - Ending time for this integration ( s ).
358  C     vfFacMom  - Momentum viscosity scaling parameter  C     chkPtFreq     - Frequency of rolling check pointing ( s ).
359  C     pfFacMom  - Momentum pressure forcing parameter  C     pChkPtFreq    - Frequency of permanent check pointing ( s ).
360  C     cfFacMom  - Coriolis term scaling parameter  C     dumpFreq      - Frequency with which model state is written to
361  C     foFacMom  - Momentum forcing scaling parameter  C                     post-processing files ( s ).
362  C     cAdjFreq  - Frequency of convective adjustment  C     afFacMom      - Advection of momentum term tracer parameter
363        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,  C     vfFacMom      - Momentum viscosity tracer parameter
364       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,  C     pfFacMom      - Momentum pressure forcing tracer parameter
365       & thetaMin, rSphere, f0, fCori, beta, viscAh, viscAz, viscA4,  C     cfFacMom      - Coriolis term tracer parameter
366       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,  C     foFacMom      - Momentum forcing tracer parameter
367       & tauCD, rCD, freeSurfFac,  C     mtFacMom      - Metric terms tracer parameter
368       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,  C     cosPower      - Power of cosine of latitude to multiply viscosity
369       & gravity, gBaro, rhonil, tRef, sRef,  C     cAdjFreq      - Frequency of convective adjustment
370       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,  C
371       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom,  C     taveFreq      - Frequency with which time-averaged model state is written to
372       & cAdjFreq  C                     post-processing files ( s ).
373    C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).
374    C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
375    C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
376    C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
377    C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
378    C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
379    C                          (note: externForcingCycle must be an integer
380    C                           number times externForcingPeriod)
381    C     horiVertRatio      - Ratio on units in vertical to units in horizontal.
382    C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
383    C                          ( g*rho if horiz in m and vertical in Pa ).
384    C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
385    C                          circles ( see filter*.F )
386    C     Ro_SeaLevel        - standard position of Sea-Level in "R" coordinate, used as
387    C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
388    C     bottomDragLinear   - Drag coefficient built in to core dynamics
389    C         "     Quadratic  ( linear: 1/s, quadratic: 1/m )
390          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
391         & cg2dpcOffDFac, cg3dTargetResidual,
392         & delP, delZ, delR, delX, delY,
393         & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
394         & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
395         & fCori, fCoriG,
396         & viscAh,  viscAz,  viscA4,  viscAr,
397         & diffKhT, diffKzT, diffK4T, diffKrT,
398         & diffKhS, diffKzS, diffK4S, diffKrS,
399         & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
400         & hFacMin, hFacMinDz, hFacInf, hFacSup,
401         & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
402         & recip_rhoConst, rhoConst, tRef, sRef,
403         & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq, monitorFreq,
404         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
405         & cosPower, cAdjFreq, omega,
406         & tauThetaClimRelax, lambdaThetaClimRelax,
407         & tauSaltClimRelax, lambdaSaltClimRelax,
408         & tauTr1ClimRelax, lambdaTr1ClimRelax,
409         & externForcingCycle, externForcingPeriod,
410         & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
411         & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
412         & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,
413         & bottomDragLinear,bottomDragQuadratic
414    
415        _RL cg2dTargetResidual        _RL cg2dTargetResidual
416          _RL cg2dTargetResWunit
417          _RL cg3dTargetResidual
418        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
419        _RL delZ(Nz)        _RL delZ(Nr)
420          _RL delP(Nr)
421          _RL delR(Nr)
422        _RL delX(Nx)        _RL delX(Nx)
423        _RL delY(Ny)        _RL delY(Ny)
424        _RL deltaT        _RL deltaT
# Line 215  C     cAdjFreq  - Frequency of convectiv Line 429  C     cAdjFreq  - Frequency of convectiv
429        _RL phiMin        _RL phiMin
430        _RL thetaMin        _RL thetaMin
431        _RL rSphere        _RL rSphere
432          _RL recip_RSphere
433        _RL f0        _RL f0
434        _RL freeSurfFac        _RL freeSurfFac
435          _RL implicSurfPress
436          _RL implicDiv2Dflow
437          _RL hFacMin
438          _RL hFacMinDz
439          _RL hFacMinDp
440          _RL hFacMinDr
441          _RL hFacInf
442          _RL hFacSup
443        _RL beta        _RL beta
444        _RL viscAh        _RL viscAh
445        _RL viscAz        _RL viscAz
446          _RL viscAp
447          _RL viscAr
448        _RL viscA4        _RL viscA4
449        _RL diffKhT        _RL diffKhT
450          _RL diffKrT
451        _RL diffKzT        _RL diffKzT
452          _RL diffKpT
453        _RL diffK4T        _RL diffK4T
454        _RL diffKhS        _RL diffKhS
455          _RL diffKrS
456        _RL diffKzS        _RL diffKzS
457          _RL diffKpS
458        _RL diffK4S        _RL diffK4S
459        _RL delt        _RL delt
460        _RL tauCD        _RL tauCD
461        _RL rCD        _RL rCD
       _RL GMmaxslope  
       _RL GMlength  
       _RL GMalpha  
       _RL GMdepth  
       _RL GMkbackground  
462        _RL gravity        _RL gravity
463          _RL recip_gravity
464        _RL gBaro        _RL gBaro
465        _RL rhonil        _RL rhonil
466        _RL tRef(Nz)        _RL recip_rhonil
467        _RL sRef(Nz)        _RL rhoConst
468        _RL Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL recip_rhoConst
469          _RL specVol_S(Nr)
470          _RL tRef(Nr)
471          _RL theta_S(Nr)
472          _RL sRef(Nr)
473          _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
474          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
475        _RL startTime        _RL startTime
476        _RL endTime        _RL endTime
477        _RL chkPtFreq        _RL chkPtFreq
478        _RL pChkPtFreq        _RL pChkPtFreq
479        _RL dumpFreq        _RL dumpFreq
480          _RL taveFreq
481          _RL monitorFreq
482        _RL afFacMom        _RL afFacMom
483        _RL vfFacMom        _RL vfFacMom
484        _RL pfFacMom        _RL pfFacMom
485        _RL cfFacMom        _RL cfFacMom
486        _RL foFacMom        _RL foFacMom
487          _RL mTFacMom
488          _RL cosPower
489        _RL cAdjFreq        _RL cAdjFreq
490          _RL omega
491          _RL tauThetaClimRelax
492          _RL lambdaThetaClimRelax
493          _RL tauSaltClimRelax
494          _RL lambdaSaltClimRelax
495          _RL tauTr1ClimRelax
496          _RL lambdaTr1ClimRelax
497          _RL externForcingCycle
498          _RL externForcingPeriod
499          _RL horiVertRatio
500          _RL recip_horiVertRatio
501          _RL latFFTFiltLo
502          _RL ivdc_kappa
503          _RL Ro_SeaLevel
504          _RL zonal_filt_lat
505          _RL bottomDragLinear
506          _RL bottomDragQuadratic
507    
508        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
509       &                Lamba_theta       &                Lamba_theta
510        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
511        _RL Lamba_theta        _RL Lamba_theta
512          _RL recip_Cp
513    
514  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
515        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
516        _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)
517  C Linear equation of state  C Linear equation of state
518  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
519  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     - Linear EOS haline contraction coefficient.
520        COMMON /PARM_EOS_LIN/ tAlpha,sBeta        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
521        _RL tAlpha        _RL tAlpha
522        _RL sBeta        _RL sBeta
523          character*(6) eosType
524    
525    C Atmospheric physical parameters (Ideal Gas EOS, ...)
526    C     atm_po    - standard reference pressure
527    C     atm_cp    - specific heat (Cp) of the (dry) air at constant pressure
528    C     atm_kappa - kappa = R/Cp (R: constant of Ideal Gas EOS)
529    C     Integr_GeoPot - option to select the way we integrate the geopotential
530    C                     (still a subject of discussions ...)
531          COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,
532         &                  Integr_GeoPot
533          _RL atm_cp, atm_kappa, atm_po
534          INTEGER Integr_GeoPot
535    
536    C Logical flags for selecting packages
537          LOGICAL useKPP
538          LOGICAL useGMRedi
539          LOGICAL useOBCS
540          LOGICAL useAIM
541          LOGICAL useGrdchk
542          LOGICAL useECCO
543          LOGICAL useSHAP_FILT
544          COMMON /PARM_PACKAGES/
545         &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
546         &        useSHAP_FILT, useGrdchk
547    

Legend:
Removed from v.1.9  
changed lines
  Added in v.1.56

  ViewVC Help
Powered by ViewVC 1.1.22