/[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.18 by cnh, Mon Jun 15 05:13:55 1998 UTC revision 1.62 by adcroft, Thu Sep 13 17:43:55 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     \==========================================================/
# Line 23  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 35  C--   COMMON /PARM_C/ Character valued p Line 47  C--   COMMON /PARM_C/ Character valued p
47  C     checkPtSuff - List of checkpoint file suffices  C     checkPtSuff - List of checkpoint file suffices
48  C     bathyFile   - File containing bathymetry. If not defined bathymetry  C     bathyFile   - File containing bathymetry. If not defined bathymetry
49  C                   is taken from inline function.  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  C     hydrogThetaFile - File containing initial hydrographic data for potential
53  C                       temperature.  C                       temperature.
54  C     hydrogSaltFile  - File containing initial hydrographic data for salinity.  C     hydrogSaltFile  - File containing initial hydrographic data for salinity.
# Line 44  C     thetaClimFile   - File containing Line 58  C     thetaClimFile   - File containing
58  C                       in relaxation term -lambda(theta-theta*)  C                       in relaxation term -lambda(theta-theta*)
59  C     saltClimFile    - File containing salt climataology used  C     saltClimFile    - File containing salt climataology used
60  C                       in relaxation term -lambda(salt-salt*)  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,        COMMON /PARM_C/ checkPtSuff,
68       &                bathyFile, hydrogThetaFile, hydrogSaltFile,       &                bathyFile, topoFile,
69         &                hydrogThetaFile, hydrogSaltFile,
70       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
71       &                saltClimFile       &                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        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
77        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
78        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
79        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
80        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
81        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
82        CHARACTER*(MAX_LEN_FNAM) saltClimFile        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 70  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
# Line 113  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.
 C     implicitFreeSurface - Set to true to use implcit free surface  
172  C     rigidLid            - Set to true to use rigid lid  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  C     momStepping   - Turns momentum equation time-stepping off
178  C     tempStepping  - Turns temperature equation time-stepping off  C     tempStepping  - Turns temperature equation time-stepping off
179  C     saltStepping  - Turns salinity equation time-stepping off  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  C     useConstantF  - Coriolis parameter set to f0
182  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
183  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
184  C     implicitDiffusion - Turns implicit vertical diffusion on  C     implicitDiffusion - Turns implicit vertical diffusion on
185    C     implicitViscosity - Turns implicit vertical viscosity on
186  C     doThetaClimRelax - Set true if relaxation to temperature  C     doThetaClimRelax - Set true if relaxation to temperature
187  C                        climatology is required.  C                        climatology is required.
188  C     doSaltClimRelax  - Set true if relaxation to salinity  C     doSaltClimRelax  - Set true if relaxation to salinity
189  C                        climatology is required.  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, momPressureForcing,       & usingCurvilinearGrid,
201         & no_slip_sides,no_slip_bottom,
202         & staggerTimeStep,
203         & momViscosity, momAdvection, momForcing, useCoriolis,
204         & momPressureForcing, vectorInvariantMomentum,
205       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
206       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
207       & implicitFreeSurface, rigidLid,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
208       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping, tr1Stepping,
209       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
210       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
211       & implicitDiffusion, doThetaClimRelax, doSaltClimRelax       & implicitDiffusion, implicitViscosity,
212         & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
213         & periodicExternalForcing, usingPCoords, usingZCoords,
214         & nonHydrostatic, globalFiles,
215         & allowFreezing, groundAtK1,
216         & usePickupBeforeC35, debugMode,
217         & readPickupWithTracer, writePickupWithTracer,
218         & multiDimAdvection
219        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
220        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
221          LOGICAL usingCurvilinearGrid
222        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
223          LOGICAL no_slip_sides
224          LOGICAL no_slip_bottom
225          LOGICAL staggerTimeStep
226        LOGICAL momViscosity        LOGICAL momViscosity
227        LOGICAL momAdvection        LOGICAL momAdvection
228        LOGICAL momForcing        LOGICAL momForcing
229        LOGICAL momPressureForcing        LOGICAL momPressureForcing
230        LOGICAL useCoriolis        LOGICAL useCoriolis
231          LOGICAL vectorInvariantMomentum
232        LOGICAL tempDiffusion        LOGICAL tempDiffusion
233        LOGICAL tempAdvection        LOGICAL tempAdvection
234        LOGICAL tempForcing        LOGICAL tempForcing
235        LOGICAL saltDiffusion        LOGICAL saltDiffusion
236        LOGICAL saltAdvection        LOGICAL saltAdvection
237        LOGICAL saltForcing        LOGICAL saltForcing
       LOGICAL implicitFreeSurface  
238        LOGICAL rigidLid        LOGICAL rigidLid
239          LOGICAL implicitFreeSurface
240          LOGICAL exactConserv
241          LOGICAL uniformLin_PhiSurf
242        LOGICAL momStepping        LOGICAL momStepping
243        LOGICAL tempStepping        LOGICAL tempStepping
244        LOGICAL saltStepping        LOGICAL saltStepping
245          LOGICAL tr1Stepping
246        LOGICAL metricTerms        LOGICAL metricTerms
247        LOGICAL useConstantF        LOGICAL useConstantF
248        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
249        LOGICAL useSphereF        LOGICAL useSphereF
250        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
251          LOGICAL implicitViscosity
252        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
253        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
254          LOGICAL doTr1ClimRelax
255          LOGICAL periodicExternalForcing
256          LOGICAL usingPCoords
257          LOGICAL usingZCoords
258          LOGICAL nonHydrostatic
259          LOGICAL globalFiles
260          LOGICAL allowFreezing
261          LOGICAL groundAtK1
262          LOGICAL usePickupBeforeC35
263          LOGICAL debugMode
264          LOGICAL readPickupWithTracer
265          LOGICAL writePickupWithTracer
266          LOGICAL multiDimAdvection
267    
268  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
269  C     cg2dTargetResidual  C     gg2dTargetResidual
270  C               - Target residual for cg2d solver.  C          - Target residual for cg2d solver; no unit (RHS normalisation)
271    C     cg2dTargetResWunit
272    C          - Target residual for cg2d solver; W unit (No RHS normalisation)
273    C     cg3dTargetResidual
274    C               - Target residual for cg3d solver.
275  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
276  C     Note. 20th May 1998  C     Note. 20th May 1998
277  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 179  C           number of iterations for con Line 286  C           number of iterations for con
286  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
287  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
288  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
289  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     delP      - Vertical grid spacing ( Pa ).
290  C                 between "w" surfaces.  C     delZ      - Vertical grid spacing ( m  ).
291    C     delR      - Vertical grid spacing ( units of r ).
292  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
293  C     delY        on input flags.  C     delY        on input flags.
294  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
295    C     recip_gravity and its inverse
296  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 )
297  C     ronil     - Reference density  C     ronil     - Reference density
298    C     rhoConst  - Vertically constant reference density
299  C     startTime - Start time for model ( s )  C     startTime - Start time for model ( s )
300  C     phiMin    - Latitude of southern most cell face.  C     phiMin    - Latitude of southern most cell face.
301  C     thetaMin  - Longitude of western most cell face (this  C     thetaMin  - Longitude of western most cell face (this
302  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
303  C                 to make geographical references simple.)  C                 to make geographical references simple.)
304  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).
305  C     rRSphere  - Reciprocal radius of sphere for a spherical polar grid ( m ).  C     recip_RSphere  - Reciprocal radius of sphere ( m ).
306  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        - Reference coriolis parameter ( 1/s )
307  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
308  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      - df/dy ( s^-1.m^-1 )
# Line 201  C     viscAh    - Eddy viscosity coeff. Line 311  C     viscAh    - Eddy viscosity coeff.
311  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
312  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    - Eddy viscosity coeff. for mixing of
313  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
314    C     viscAp    - Eddy viscosity coeff. for mixing of
315    C                 momentum vertically ( Pa^2/s )
316    C     viscAr    - Eddy viscosity coeff. for mixing of
317    C                 momentum vertically ( units of r^2/s )
318  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscA4    - Biharmonic viscosity coeff. for mixing of
319  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
320  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   - Laplacian diffusion coeff. for mixing of
321  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
322  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   - Laplacian diffusion coeff. for mixing of
323  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
324    C     diffKpT   - Laplacian diffusion coeff. for mixing of
325    C                 heat vertically ( Pa^2/s )
326    C     diffKrT   - Laplacian diffusion coeff. for mixing of
327    C                 heat vertically ( units of r^2/s )
328  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   - Biharmonic diffusion coeff. for mixing of
329  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
330  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  -  Laplacian diffusion coeff. for mixing of
331  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
332  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   - Laplacian diffusion coeff. for mixing of
333  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
334    C     diffKpS   - Laplacian diffusion coeff. for mixing of
335    C                 salt vertically ( Pa^2/s )
336    C     diffKrS   - Laplacian diffusion coeff. for mixing of
337    C                 salt vertically ( units of r^2/s )
338  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   - Biharmonic diffusion coeff. for mixing of
339  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
340  C     deltaT    - Default timestep ( s )  C     deltaT    - Default timestep ( s )
# Line 227  C     deltaTtracer - Timestep for tracer Line 349  C     deltaTtracer - Timestep for tracer
349  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     freesurfFac  - Parameter to turn implicit free surface term on or off
350  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
351  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
352  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     implicSurfPress - parameter of the Crank-Nickelson time stepping :
353  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
354  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C     implicDiv2Dflow - parameter of the Crank-Nickelson time stepping :
355  C     GMlength  - Length to use in Visbeck et al. formula for K (m)  C                     Implicit part of barotropic flow Divergence ( 0-1 )
356  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
357  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
358  C     GMkbackground - background value of GM/Redi coefficient  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
359  C     startTime - Starting time for this integration ( s ).  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
360  C     endTime   - Ending time for this integration ( s ).  C     hFacInf      - Threshold (inf and sup) for fraction size of surface cell
361  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     hFacSup        that control vanishing and creating levels
362  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     tauCD        - CD scheme coupling timescale ( 1/s )
363  C     dumpFreq  - Frequency with which model state is written to  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
364  C                 post-processing files ( s ).  C     startTime     - Starting time for this integration ( s ).
365  C     afFacMom  - Advection of momentum term scaling parameter  C     endTime       - Ending time for this integration ( s ).
366  C     vfFacMom  - Momentum viscosity scaling parameter  C     chkPtFreq     - Frequency of rolling check pointing ( s ).
367  C     pfFacMom  - Momentum pressure forcing parameter  C     pChkPtFreq    - Frequency of permanent check pointing ( s ).
368  C     cfFacMom  - Coriolis term scaling parameter  C     dumpFreq      - Frequency with which model state is written to
369  C     foFacMom  - Momentum forcing scaling parameter  C                     post-processing files ( s ).
370  C     mtFacMom  - Metric terms scaling parameter  C     diagFreq      - Frequency with which model writes diagnostic output
371  C     cAdjFreq  - Frequency of convective adjustment  C                     of intermediate quantities.
372    C     afFacMom      - Advection of momentum term tracer parameter
373    C     vfFacMom      - Momentum viscosity tracer parameter
374    C     pfFacMom      - Momentum pressure forcing tracer parameter
375    C     cfFacMom      - Coriolis term tracer parameter
376    C     foFacMom      - Momentum forcing tracer parameter
377    C     mtFacMom      - Metric terms tracer parameter
378    C     cosPower      - Power of cosine of latitude to multiply viscosity
379    C     cAdjFreq      - Frequency of convective adjustment
380    C
381    C     taveFreq      - Frequency with which time-averaged model state is written to
382    C                     post-processing files ( s ).
383  C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).
384  C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).  C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
385  C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
386  C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).  C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
387        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,  C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
388       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,  C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
389       & thetaMin, rSphere, rRSphere, f0, fCori, beta, viscAh, viscAz, viscA4,  C                          (note: externForcingCycle must be an integer
390       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,  C                           number times externForcingPeriod)
391       & tauCD, rCD, freeSurfFac,  C     horiVertRatio      - Ratio on units in vertical to units in horizontal.
392       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
393       & gravity, gBaro, rhonil, tRef, sRef,  C                          ( g*rho if horiz in m and vertical in Pa ).
394    C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
395    C                          circles ( see filter*.F )
396    C     Ro_SeaLevel        - standard position of Sea-Level in "R" coordinate, used as
397    C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
398    C     bottomDragLinear   - Drag coefficient built in to core dynamics
399    C         "     Quadratic  ( linear: 1/s, quadratic: 1/m )
400          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
401         & cg2dpcOffDFac, cg3dTargetResidual,
402         & delP, delZ, delR, delX, delY,
403         & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
404         & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
405         & fCori, fCoriG,
406         & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,
407         & diffKhT, diffKzT, diffK4T, diffKrT,
408         & diffKhS, diffKzS, diffK4S, diffKrS,
409         & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
410         & hFacMin, hFacMinDz, hFacInf, hFacSup,
411         & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
412         & recip_rhoConst, rhoConst, tRef, sRef,
413       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
414         & diagFreq, taveFreq, monitorFreq,
415       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
416       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,       & cosPower, cAdjFreq, omega,
417       & tauSaltClimRelax, lambdaSaltClimRelax       & tauThetaClimRelax, lambdaThetaClimRelax,
418         & tauSaltClimRelax, lambdaSaltClimRelax,
419         & tauTr1ClimRelax, lambdaTr1ClimRelax,
420         & externForcingCycle, externForcingPeriod,
421         & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
422         & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
423         & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,
424         & bottomDragLinear,bottomDragQuadratic
425    
426        _RL cg2dTargetResidual        _RL cg2dTargetResidual
427          _RL cg2dTargetResWunit
428          _RL cg3dTargetResidual
429        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
430        _RL delZ(Nz)        _RL delZ(Nr)
431          _RL delP(Nr)
432          _RL delR(Nr)
433        _RL delX(Nx)        _RL delX(Nx)
434        _RL delY(Ny)        _RL delY(Ny)
435        _RL deltaT        _RL deltaT
# Line 275  C     lambdaSaltClimRelax - Inverse time Line 440  C     lambdaSaltClimRelax - Inverse time
440        _RL phiMin        _RL phiMin
441        _RL thetaMin        _RL thetaMin
442        _RL rSphere        _RL rSphere
443        _RL rRSphere        _RL recip_RSphere
444        _RL f0        _RL f0
445        _RL freeSurfFac        _RL freeSurfFac
446          _RL implicSurfPress
447          _RL implicDiv2Dflow
448          _RL hFacMin
449          _RL hFacMinDz
450          _RL hFacMinDp
451          _RL hFacMinDr
452          _RL hFacInf
453          _RL hFacSup
454        _RL beta        _RL beta
455        _RL viscAh        _RL viscAh
456          _RL viscAstrain
457          _RL viscAtension
458        _RL viscAz        _RL viscAz
459          _RL viscAp
460          _RL viscAr
461        _RL viscA4        _RL viscA4
462        _RL diffKhT        _RL diffKhT
463          _RL diffKrT
464        _RL diffKzT        _RL diffKzT
465          _RL diffKpT
466        _RL diffK4T        _RL diffK4T
467        _RL diffKhS        _RL diffKhS
468          _RL diffKrS
469        _RL diffKzS        _RL diffKzS
470          _RL diffKpS
471        _RL diffK4S        _RL diffK4S
472        _RL delt        _RL delt
473        _RL tauCD        _RL tauCD
474        _RL rCD        _RL rCD
       _RL GMmaxslope  
       _RL GMlength  
       _RL GMalpha  
       _RL GMdepth  
       _RL GMkbackground  
475        _RL gravity        _RL gravity
476          _RL recip_gravity
477        _RL gBaro        _RL gBaro
478        _RL rhonil        _RL rhonil
479        _RL tRef(Nz)        _RL recip_rhonil
480        _RL sRef(Nz)        _RL rhoConst
481        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL recip_rhoConst
482          _RL specVol_S(Nr)
483          _RL tRef(Nr)
484          _RL theta_S(Nr)
485          _RL sRef(Nr)
486          _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
487          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
488        _RL startTime        _RL startTime
489        _RL endTime        _RL endTime
490        _RL chkPtFreq        _RL chkPtFreq
491        _RL pChkPtFreq        _RL pChkPtFreq
492        _RL dumpFreq        _RL dumpFreq
493          _RL diagFreq
494          _RL taveFreq
495          _RL monitorFreq
496        _RL afFacMom        _RL afFacMom
497        _RL vfFacMom        _RL vfFacMom
498        _RL pfFacMom        _RL pfFacMom
499        _RL cfFacMom        _RL cfFacMom
500        _RL foFacMom        _RL foFacMom
501        _RL mTFacMom        _RL mTFacMom
502          _RL cosPower
503        _RL cAdjFreq        _RL cAdjFreq
504        _RL omega        _RL omega
505        _RL tauThetaClimRelax        _RL tauThetaClimRelax
506        _RL lambdaThetaClimRelax        _RL lambdaThetaClimRelax
507        _RL tauSaltClimRelax        _RL tauSaltClimRelax
508        _RL lambdaSaltClimRelax        _RL lambdaSaltClimRelax
509          _RL tauTr1ClimRelax
510          _RL lambdaTr1ClimRelax
511          _RL externForcingCycle
512          _RL externForcingPeriod
513          _RL horiVertRatio
514          _RL recip_horiVertRatio
515          _RL latFFTFiltLo
516          _RL ivdc_kappa
517          _RL Ro_SeaLevel
518          _RL zonal_filt_lat
519          _RL bottomDragLinear
520          _RL bottomDragQuadratic
521    
522        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
523       &                Lamba_theta       &                Lamba_theta
524        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
525        _RL Lamba_theta        _RL Lamba_theta
526          _RL recip_Cp
527    
528  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
529        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
530        _RL eosC(9,Nz+1),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)        _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
531  C Linear equation of state  C Linear equation of state
532  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
533  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     - Linear EOS haline contraction coefficient.
# Line 336  C     sBeta     - Linear EOS haline cont Line 536  C     sBeta     - Linear EOS haline cont
536        _RL sBeta        _RL sBeta
537        character*(6) eosType        character*(6) eosType
538    
539    C Atmospheric physical parameters (Ideal Gas EOS, ...)
540    C     atm_po    - standard reference pressure
541    C     atm_cp    - specific heat (Cp) of the (dry) air at constant pressure
542    C     atm_kappa - kappa = R/Cp (R: constant of Ideal Gas EOS)
543    C     Integr_GeoPot - option to select the way we integrate the geopotential
544    C                     (still a subject of discussions ...)
545          COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,
546         &                  Integr_GeoPot
547          _RL atm_cp, atm_kappa, atm_po
548          INTEGER Integr_GeoPot
549    
550    C Logical flags for selecting packages
551          LOGICAL useKPP
552          LOGICAL useGMRedi
553          LOGICAL useOBCS
554          LOGICAL useAIM
555          LOGICAL useGrdchk
556          LOGICAL useECCO
557          LOGICAL useSHAP_FILT
558          LOGICAL useFLT
559          COMMON /PARM_PACKAGES/
560         &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
561         &        useSHAP_FILT, useGrdchk, useFLT
562    

Legend:
Removed from v.1.18  
changed lines
  Added in v.1.62

  ViewVC Help
Powered by ViewVC 1.1.22