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

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

  ViewVC Help
Powered by ViewVC 1.1.22