/[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.55 by jmc, Fri Jul 6 21:31:20 2001 UTC revision 1.65.4.1.2.1 by dimitri, Wed Feb 12 06:45:54 2003 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3  C  C
4  C     /==========================================================\  CBOP
5  C     | PARAMS.h                                                 |  C    !ROUTINE: PARAMS.h
6  C     | o Header file defining model "parameters".               |  C    !INTERFACE:
7  C     |==========================================================|  C    include PARAMS.h
8  C     | The values from the model standard input file are        |  C    !DESCRIPTION: \bv
9  C     | stored into the variables held here. Notes describing    |  C     *==========================================================*
10  C     | the parameters can also be found here.                   |  C     | PARAMS.h                                                  
11  C     \==========================================================/  C     | o Header file defining model "parameters".                
12    C     *==========================================================*
13    C     | The values from the model standard input file are        
14    C     | stored into the variables held here. Notes describing    
15    C     | the parameters can also be found here.                    
16    C     *==========================================================*
17    C     \ev
18    CEOP
19    
20  C     Macros for special grid options  C     Macros for special grid options
21  #include "PARAMS_MACROS.h"  #include "PARAMS_MACROS.h"
# Line 21  C     Useful physical values Line 28  C     Useful physical values
28        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
29    
30  C     Symbolic values  C     Symbolic values
31  C     precXXXX - Used to indicate what precision to use for  C     precXXXX :: Used to indicate what precision to use for
32  C                dumping model state.  C                dumping model state.
33        INTEGER precFloat32        INTEGER precFloat32
34        PARAMETER ( precFloat32 = 32 )        PARAMETER ( precFloat32 = 32 )
35        INTEGER precFloat64        INTEGER precFloat64
36        PARAMETER ( precFloat64 = 64 )        PARAMETER ( precFloat64 = 64 )
37  C     UNSET_xxx - Used to indicate variables that have not been given a value  C     UNSET_xxx :: Used to indicate variables that have not been given a value
38        Real*8 UNSET_FLOAT8        Real*8 UNSET_FLOAT8
39        PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )        PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
40        Real*4 UNSET_FLOAT4        Real*4 UNSET_FLOAT4
# Line 44  C     Checkpoint data Line 51  C     Checkpoint data
51        PARAMETER ( maxNoChkptLev = 2 )        PARAMETER ( maxNoChkptLev = 2 )
52    
53  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
54  C     checkPtSuff - List of checkpoint file suffices  C     checkPtSuff :: List of checkpoint file suffices
55  C     bathyFile   - File containing bathymetry. If not defined bathymetry  C     bathyFile   :: File containing bathymetry. If not defined bathymetry
56  C                   is taken from inline function.  C                   is taken from inline function.
57  C     topoFile    - File containing the topography of the surface (unit=m)  C     topoFile    :: File containing the topography of the surface (unit=m)
58  C                   (mainly used for the atmosphere = ground height).  C                   (mainly used for the atmosphere = ground height).
59  C     hydrogThetaFile - File containing initial hydrographic data for potential  C     hydrogThetaFile :: File containing initial hydrographic data for potential
60  C                       temperature.  C                       temperature.
61  C     hydrogSaltFile  - File containing initial hydrographic data for salinity.  C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.
62  C     zonalWindFile   - File containing zonal wind data  C     zonalWindFile   :: File containing zonal wind data
63  C     meridWindFile   - File containing meridional wind data  C     meridWindFile   :: File containing meridional wind data
64  C     thetaClimFile   - File containing theta climataology used  C     thetaClimFile   :: File containing theta climataology used
65  C                       in relaxation term -lambda(theta-theta*)  C                       in relaxation term -lambda(theta-theta*)
66  C     saltClimFile    - File containing salt climataology used  C     saltClimFile    :: File containing salt climataology used
67  C                       in relaxation term -lambda(salt-salt*)  C                       in relaxation term -lambda(salt-salt*)
68  C     surfQfile       - File containing surface heat flux  C     surfQfile       :: File containing surface heat flux
69  C     surfQswfile     - File containing surface shortwave radiation  C     surfQswfile     :: File containing surface shortwave radiation
70  C     dQdTfile        - File containing thermal relaxation coefficient  C     dQdTfile        :: File containing thermal relaxation coefficient
71  C     EmPmRfile       - File containing surface fresh water flux  C     EmPmRfile       :: File containing surface fresh water flux
72  C     buoyancyRelation - Flag used to indicate which relation to use to  C     buoyancyRelation :: Flag used to indicate which relation to use to
73  C                        get buoyancy.  C                        get buoyancy.
74        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
75       &                bathyFile, topoFile,       &                bathyFile, topoFile,
# Line 90  C                        get buoyancy. Line 97  C                        get buoyancy.
97        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
98    
99  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
100  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
101  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
102  C     cg2dChkResFreq      - Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
103  C                           in con. grad solver.  C                           in con. grad solver.
104  C     cg3dMaxIters        - Maximum number of iterations in the  C     cg3dMaxIters        :: Maximum number of iterations in the
105  C                           three-dimensional con. grad solver.  C                           three-dimensional con. grad solver.
106  C     cg3dChkResFreq      - Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
107  C                           in con. grad solver.  C                           in con. grad solver.
108  C     nIter0              - Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
109  C     nTimeSteps          - Number of timesteps to execute  C     nTimeSteps          :: Number of timesteps to execute
110  C     numStepsPerPickup   - For offline setup. Frequency of pickup  C     numStepsPerPickup   :: For offline setup. Frequency of pickup
111  C                           of flow fields.  C                           of flow fields.
112  C     writeStatePrec      - Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
113  C     writeBinaryPrec     - Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
114  C     readBinaryPrec      - Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
115  C     nCheckLev           - Holds current checkpoint level  C     nCheckLev           :: Holds current checkpoint level
116  C     nonlinFreeSurf      - option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
117  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
118    
119        COMMON /PARM_I/        COMMON /PARM_I/
# Line 119  C                           =0 Linear fr Line 126  C                           =0 Linear fr
126       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
127       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
128       &        nonlinFreeSurf,       &        nonlinFreeSurf,
129       &        zonal_filt_sinpow, zonal_filt_cospow       &        tempAdvScheme, saltAdvScheme, tracerAdvScheme
130        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
131        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
132        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
# Line 133  C                           =0 Linear fr Line 140  C                           =0 Linear fr
140        INTEGER readBinaryPrec        INTEGER readBinaryPrec
141        INTEGER nCheckLev        INTEGER nCheckLev
142        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
143        INTEGER zonal_filt_sinpow        INTEGER tempAdvScheme
144        INTEGER zonal_filt_cospow        INTEGER saltAdvScheme
145          INTEGER tracerAdvScheme
146    
147  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
148  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
149  C                          coordinate frame.  C                          coordinate frame.
150  C     usingSphericalPolarGrid - If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
151  C                               spherical polar frame.  C                               spherical polar frame.
152  C     no_slip_sides - Impose "no-slip" at lateral boundaries.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
153  C     no_slip_bottom- Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
154  C     staggerTimeStep - enable a Stagger time stepping T,S Rho then U,V  C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
155  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
156  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momAdvection  :: Flag which turns advection of momentum on and off.
157  C     momForcing    - Flag which turns external forcing of momentum on  C     momForcing    :: Flag which turns external forcing of momentum on
158  C                     and off.  C                     and off.
159  C     momPressureForcing - Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
160  C                          on and off.  C                          on and off.
161  C     metricTerms   - Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
162  C     usingSphericalPolarMTerms - If TRUE use spherical polar metric terms.  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
163  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
164  C     tempDiffusion - Flag which turns diffusion of temperature on  C     tempDiffusion :: Flag which turns diffusion of temperature on
165  C                     and off.  C                     and off.
166  C     tempAdvection - Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
167  C                     and off.  C                     and off.
168  C     tempForcing   - Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
169  C                     and off.  C                     and off.
170  C     saltDiffusion - Flag which turns diffusion of salinit on  C     saltDiffusion :: Flag which turns diffusion of salinit on
171  C                     and off.  C                     and off.
172  C     saltAdvection - Flag which turns advection of salinit on  C     saltAdvection :: Flag which turns advection of salinit on
173  C                     and off.  C                     and off.
174  C     saltForcing   - Flag which turns external forcing of salinit on  C     saltForcing   :: Flag which turns external forcing of salinit on
175  C                     and off.  C                     and off.
176  C     rigidLid            - Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
177  C     implicitFreeSurface - Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implcit free surface
178  C     exactConserv        - Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
179  C     uniformLin_PhiSurf  - Set to true to use a uniform Bo_surf in the  C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
180  C                           linear relation Phi_surf = Bo_surf*eta  C                           linear relation Phi_surf = Bo_surf*eta
181  C     momStepping   - Turns momentum equation time-stepping off  C     momStepping   :: Turns momentum equation time-stepping off
182  C     tempStepping  - Turns temperature equation time-stepping off  C     tempStepping  :: Turns temperature equation time-stepping off
183  C     saltStepping  - Turns salinity equation time-stepping off  C     saltStepping  :: Turns salinity equation time-stepping off
184  C     useConstantF  - Coriolis parameter set to f0  C     tr1Stepping   :: Turns passive tracer 1 time-stepping on/off
185  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y  C     useConstantF  :: Coriolis parameter set to f0
186  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
187  C     implicitDiffusion - Turns implicit vertical diffusion on  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
188  C     implicitViscosity - Turns implicit vertical viscosity on  C     implicitDiffusion :: Turns implicit vertical diffusion on
189  C     doThetaClimRelax - Set true if relaxation to temperature  C     implicitViscosity :: Turns implicit vertical viscosity on
190    C     doThetaClimRelax :: Set true if relaxation to temperature
191  C                        climatology is required.  C                        climatology is required.
192  C     doSaltClimRelax  - Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
193  C                        climatology is required.  C                        climatology is required.
194  C     periodicExternalForcing - Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
195  C     usingPCoords     - Set to indicate that we are working in pressure  C     usingPCoords     :: Set to indicate that we are working in pressure
196  C                        coords.  C                        coords.
197  C     usingZCoords     - Set to indicate that we are working in height  C     usingZCoords     :: Set to indicate that we are working in height
198  C                        coords.  C                        coords.
199  C     nonHydrostatic - Using non-hydrostatic terms  C     nonHydrostatic :: Using non-hydrostatic terms
200  C     globalFiles    - Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
201  C     allowFreezing  - Allows water to freeze and form ice  C     allowFreezing  :: Allows water to freeze and form ice
202  C     groundAtK1  - put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
203    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
204        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
205       & usingCurvilinearGrid,       & usingCurvilinearGrid,
206       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
207       & staggerTimeStep,       & staggerTimeStep,
208       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
209       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,       & momPressureForcing, vectorInvariantMomentum,
210         & tempDiffusion, tempAdvection, tempForcing,
211       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
212       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
213       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping, tr1Stepping,
214       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
215       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
216       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
217       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
218       & periodicExternalForcing, usingPCoords, usingZCoords,       & periodicExternalForcing, usingPCoords, usingZCoords,
219       & nonHydrostatic, globalFiles,       & nonHydrostatic, globalFiles,
220       & allowFreezing, groundAtK1,       & allowFreezing, groundAtK1,
221       & usePickupBeforeC35, debugMode       & usePickupBeforeC35, debugMode,
222         & readPickupWithTracer, writePickupWithTracer,
223         & multiDimAdvection, useEnergyConservingCoriolis,
224         & useJamartWetPoints
225        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
226        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
227        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
# Line 220  C     groundAtK1  - put the surface(k=1) Line 234  C     groundAtK1  - put the surface(k=1)
234        LOGICAL momForcing        LOGICAL momForcing
235        LOGICAL momPressureForcing        LOGICAL momPressureForcing
236        LOGICAL useCoriolis        LOGICAL useCoriolis
237          LOGICAL vectorInvariantMomentum
238        LOGICAL tempDiffusion        LOGICAL tempDiffusion
239        LOGICAL tempAdvection        LOGICAL tempAdvection
240        LOGICAL tempForcing        LOGICAL tempForcing
# Line 233  C     groundAtK1  - put the surface(k=1) Line 248  C     groundAtK1  - put the surface(k=1)
248        LOGICAL momStepping        LOGICAL momStepping
249        LOGICAL tempStepping        LOGICAL tempStepping
250        LOGICAL saltStepping        LOGICAL saltStepping
251          LOGICAL tr1Stepping
252        LOGICAL metricTerms        LOGICAL metricTerms
253        LOGICAL useConstantF        LOGICAL useConstantF
254        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
# Line 241  C     groundAtK1  - put the surface(k=1) Line 257  C     groundAtK1  - put the surface(k=1)
257        LOGICAL implicitViscosity        LOGICAL implicitViscosity
258        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
259        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
260          LOGICAL doTr1ClimRelax
261        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
262        LOGICAL usingPCoords        LOGICAL usingPCoords
263        LOGICAL usingZCoords        LOGICAL usingZCoords
# Line 250  C     groundAtK1  - put the surface(k=1) Line 267  C     groundAtK1  - put the surface(k=1)
267        LOGICAL groundAtK1        LOGICAL groundAtK1
268        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
269        LOGICAL debugMode        LOGICAL debugMode
270          LOGICAL readPickupWithTracer
271          LOGICAL writePickupWithTracer
272          LOGICAL multiDimAdvection
273          LOGICAL useEnergyConservingCoriolis
274          LOGICAL useJamartWetPoints
275    
276  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
277  C     gg2dTargetResidual  C     gg2dTargetResidual
278  C          - Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
279  C     cg2dTargetResWunit  C     cg2dTargetResWunit
280  C          - Target residual for cg2d solver; W unit (No RHS normalisation)  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
281  C     cg3dTargetResidual  C     cg3dTargetResidual
282  C               - Target residual for cg3d solver.  C               :: Target residual for cg3d solver.
283  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
284  C     Note. 20th May 1998  C     Note. 20th May 1998
285  C           I made a weird discovery! In the model paper we argue  C           I made a weird discovery! In the model paper we argue
286  C           for the form of the preconditioner used here ( see  C           for the form of the preconditioner used here ( see
# Line 272  C           number of iterations for con Line 294  C           number of iterations for con
294  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
295  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
296  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
297  C     delP      - Vertical grid spacing ( Pa ).  C     delP      :: Vertical grid spacing ( Pa ).
298  C     delZ      - Vertical grid spacing ( m  ).  C     delZ      :: Vertical grid spacing ( m  ).
299  C     delR      - Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
300  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
301  C     delY        on input flags.  C     delY        on input flags.
302  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
303  C     recip_gravity and its inverse  C     recip_gravity and its inverse
304  C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
305  C     ronil     - Reference density  C     ronil     :: Reference density
306  C     rhoConst  - Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
307  C     startTime - Start time for model ( s )  C     startTime :: Start time for model ( s )
308  C     phiMin    - Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
309  C     thetaMin  - Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
310  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
311  C                 to make geographical references simple.)  C                 to make geographical references simple.)
312  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).
313  C     recip_RSphere  - Reciprocal radius of sphere ( m ).  C     recip_RSphere  :: Reciprocal radius of sphere ( m ).
314  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        :: Reference coriolis parameter ( 1/s )
315  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
316  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
317  C     omega     - Angular velocity ( rad/s )  C     omega     :: Angular velocity ( rad/s )
318  C     viscAh    - Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
319  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
320  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    :: Eddy viscosity coeff. for mixing of
321  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
322  C     viscAp    - Eddy viscosity coeff. for mixing of  C     viscAp    :: Eddy viscosity coeff. for mixing of
323  C                 momentum vertically ( Pa^2/s )  C                 momentum vertically ( Pa^2/s )
324  C     viscAr    - Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
325  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
326  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
327  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
328  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
329  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
330  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   :: Laplacian diffusion coeff. for mixing of
331  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
332  C     diffKpT   - Laplacian diffusion coeff. for mixing of  C     diffKpT   :: Laplacian diffusion coeff. for mixing of
333  C                 heat vertically ( Pa^2/s )  C                 heat vertically ( Pa^2/s )
334  C     diffKrT   - Laplacian diffusion coeff. for mixing of  C     diffKrT   :: Laplacian diffusion coeff. for mixing of
335  C                 heat vertically ( units of r^2/s )  C                 heat vertically ( units of r^2/s )
336  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
337  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
338  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
339  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
340  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   :: Laplacian diffusion coeff. for mixing of
341  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
342  C     diffKpS   - Laplacian diffusion coeff. for mixing of  C     diffKpS   :: Laplacian diffusion coeff. for mixing of
343  C                 salt vertically ( Pa^2/s )  C                 salt vertically ( Pa^2/s )
344  C     diffKrS   - Laplacian diffusion coeff. for mixing of  C     diffKrS   :: Laplacian diffusion coeff. for mixing of
345  C                 salt vertically ( units of r^2/s )  C                 salt vertically ( units of r^2/s )
346  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
347  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
348  C     deltaT    - Default timestep ( s )  C     deltaT    :: Default timestep ( s )
349  C     deltaTClock  - Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
350  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
351  C                    be totally different to the dynamical time. Typically  C                    be totally different to the dynamical time. Typically
352  C                    it will be the deep-water timestep for accelerated runs.  C                    it will be the deep-water timestep for accelerated runs.
353  C                    Frequency of checkpointing and dumping of the model state  C                    Frequency of checkpointing and dumping of the model state
354  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
355  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
356  C     deltaTtracer - Timestep for tracer equations ( s )  C     deltaTtracer :: Timestep for tracer equations ( s )
357  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
358  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
359  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
360  C     implicSurfPress - parameter of the Crank-Nickelson time stepping :  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
361  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
362  C     implicDiv2Dflow - parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
363  C                     Implicit part of barotropic flow Divergence ( 0-1 )  C                     Implicit part of barotropic flow Divergence ( 0-1 )
364  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
365  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)
366  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
367  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
368  C     hFacInf      - Threshold (inf and sup) for fraction size of surface cell  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
369  C     hFacSup        that control vanishing and creating levels  C     hFacSup        that control vanishing and creating levels
370  C     tauCD        - CD scheme coupling timescale ( 1/s )  C     tauCD        :: CD scheme coupling timescale ( 1/s )
371  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
372  C     startTime     - Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
373  C     endTime       - Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
374  C     chkPtFreq     - Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
375  C     pChkPtFreq    - Frequency of permanent check pointing ( s ).  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
376  C     dumpFreq      - Frequency with which model state is written to  C     dumpFreq      :: Frequency with which model state is written to
377  C                     post-processing files ( s ).  C                     post-processing files ( s ).
378  C     afFacMom      - Advection of momentum term tracer parameter  C     diagFreq      :: Frequency with which model writes diagnostic output
379  C     vfFacMom      - Momentum viscosity tracer parameter  C                     of intermediate quantities.
380  C     pfFacMom      - Momentum pressure forcing tracer parameter  C     afFacMom      :: Advection of momentum term tracer parameter
381  C     cfFacMom      - Coriolis term tracer parameter  C     vfFacMom      :: Momentum viscosity tracer parameter
382  C     foFacMom      - Momentum forcing tracer parameter  C     pfFacMom      :: Momentum pressure forcing tracer parameter
383  C     mtFacMom      - Metric terms tracer parameter  C     cfFacMom      :: Coriolis term tracer parameter
384  C     cosPower      - Power of cosine of latitude to multiply viscosity  C     foFacMom      :: Momentum forcing tracer parameter
385  C     cAdjFreq      - Frequency of convective adjustment  C     mtFacMom      :: Metric terms tracer parameter
386    C     cosPower      :: Power of cosine of latitude to multiply viscosity
387    C     cAdjFreq      :: Frequency of convective adjustment
388  C  C
389  C     taveFreq      - Frequency with which time-averaged model state is written to  C     taveFreq      :: Frequency with which time-averaged model state is written to
390  C                     post-processing files ( s ).  C                     post-processing files ( s ).
391  C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
392  C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
393  C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
394  C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
395  C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
396  C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
397  C                          (note: externForcingCycle must be an integer  C                          (note: externForcingCycle must be an integer
398  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
399  C     horiVertRatio      - Ratio on units in vertical to units in horizontal.  C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.
400  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
401  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
402  C     latFFTFiltLo       - Low latitude for FFT filtering of latitude  C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as
 C                          circles ( see filter*.F )  
 C     Ro_SeaLevel        - standard position of Sea-Level in "R" coordinate, used as  
403  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
404  C     bottomDragLinear   - Drag coefficient built in to core dynamics  C     bottomDragLinear   :: Drag coefficient built in to core dynamics
405  C         "     Quadratic  ( linear: 1/s, quadratic: 1/m )  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
406        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
407       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
408       & delP, delZ, delR, delX, delY,       & delP, delZ, delR, delX, delY,
409       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
410       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
411       & fCori, fCoriG,       & fCori, fCoriG,
412       & viscAh,  viscAz,  viscA4,  viscAr,       & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,
413       & diffKhT, diffKzT, diffK4T, diffKrT,       & diffKhT, diffKzT, diffK4T, diffKrT,
414       & diffKhS, diffKzS, diffK4S, diffKrS,       & diffKhS, diffKzS, diffK4S, diffKrS,
415       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
416       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
417       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
418       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst, tRef, sRef,
419       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq, monitorFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
420         & diagFreq, taveFreq, monitorFreq,
421       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
422       & cosPower,       & cosPower, cAdjFreq, omega,
423       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, lambdaThetaClimRelax,
424       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
425         & tauTr1ClimRelax, lambdaTr1ClimRelax,
426       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
427       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
428       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
429       & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,       & ivdc_kappa, Ro_SeaLevel,
430       & bottomDragLinear,bottomDragQuadratic       & bottomDragLinear,bottomDragQuadratic
431    
432        _RL cg2dTargetResidual        _RL cg2dTargetResidual
# Line 435  C         "     Quadratic  ( linear: 1/s Line 459  C         "     Quadratic  ( linear: 1/s
459        _RL hFacSup        _RL hFacSup
460        _RL beta        _RL beta
461        _RL viscAh        _RL viscAh
462          _RL viscAstrain
463          _RL viscAtension
464        _RL viscAz        _RL viscAz
465        _RL viscAp        _RL viscAp
466        _RL viscAr        _RL viscAr
# Line 470  C         "     Quadratic  ( linear: 1/s Line 496  C         "     Quadratic  ( linear: 1/s
496        _RL chkPtFreq        _RL chkPtFreq
497        _RL pChkPtFreq        _RL pChkPtFreq
498        _RL dumpFreq        _RL dumpFreq
499          _RL diagFreq
500        _RL taveFreq        _RL taveFreq
501        _RL monitorFreq        _RL monitorFreq
502        _RL afFacMom        _RL afFacMom
# Line 485  C         "     Quadratic  ( linear: 1/s Line 512  C         "     Quadratic  ( linear: 1/s
512        _RL lambdaThetaClimRelax        _RL lambdaThetaClimRelax
513        _RL tauSaltClimRelax        _RL tauSaltClimRelax
514        _RL lambdaSaltClimRelax        _RL lambdaSaltClimRelax
515          _RL tauTr1ClimRelax
516          _RL lambdaTr1ClimRelax
517        _RL externForcingCycle        _RL externForcingCycle
518        _RL externForcingPeriod        _RL externForcingPeriod
519        _RL horiVertRatio        _RL horiVertRatio
520        _RL recip_horiVertRatio        _RL recip_horiVertRatio
       _RL latFFTFiltLo  
521        _RL ivdc_kappa        _RL ivdc_kappa
522        _RL Ro_SeaLevel        _RL Ro_SeaLevel
       _RL zonal_filt_lat  
523        _RL bottomDragLinear        _RL bottomDragLinear
524        _RL bottomDragQuadratic        _RL bottomDragQuadratic
525    
# Line 506  C Equation of State (polynomial coeffien Line 533  C Equation of State (polynomial coeffien
533        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
534        _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)        _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
535  C Linear equation of state  C Linear equation of state
536  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    :: Linear EOS thermal expansion coefficient ( 1/degree ).
537  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     :: Linear EOS haline contraction coefficient.
538        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
539        _RL tAlpha        _RL tAlpha
540        _RL sBeta        _RL sBeta
541        character*(6) eosType        character*(6) eosType
542    
543  C Atmospheric physical parameters (Ideal Gas EOS, ...)  C Atmospheric physical parameters (Ideal Gas EOS, ...)
544  C     atm_po    - standard reference pressure  C     atm_po    :: standard reference pressure
545  C     atm_cp    - specific heat (Cp) of the (dry) air at constant pressure  C     atm_cp    :: specific heat (Cp) of the (dry) air at constant pressure
546  C     atm_kappa - kappa = R/Cp (R: constant of Ideal Gas EOS)  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
547  C     Integr_GeoPot - option to select the way we integrate the geopotential  C     Integr_GeoPot :: option to select the way we integrate the geopotential
548  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
549        COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,        COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,
550       &                  Integr_GeoPot       &                  Integr_GeoPot
# Line 529  C Logical flags for selecting packages Line 556  C Logical flags for selecting packages
556        LOGICAL useGMRedi        LOGICAL useGMRedi
557        LOGICAL useOBCS        LOGICAL useOBCS
558        LOGICAL useAIM        LOGICAL useAIM
559          LOGICAL useGrdchk
560        LOGICAL useECCO        LOGICAL useECCO
561        LOGICAL useSHAP_FILT        LOGICAL useSHAP_FILT
562          LOGICAL useZONAL_FILT
563          LOGICAL useFLT
564          LOGICAL useSEAICE
565        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
566       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO, useSHAP_FILT       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
567         &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
568         &        useSEAICE

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

  ViewVC Help
Powered by ViewVC 1.1.22