/[MITgcm]/MITgcm/model/inc/PARAMS.h
ViewVC logotype

Annotation of /MITgcm/model/inc/PARAMS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.75 - (hide annotations) (download)
Wed Sep 25 19:36:50 2002 UTC (21 years, 7 months ago) by mlosch
Branch: MAIN
CVS Tags: checkpoint46j_pre, checkpoint46i_post, checkpoint46h_post
Changes since 1.74: +7 -3 lines
File MIME type: text/plain
o cleaned up the use of rhoNil and rhoConst.
  - rhoNil should only appear in the LINEAR equation of state, everywhere
    else rhoNil is replaced by rhoConst, e.g. find_rho computes rho-rhoConst
    and the dynamical equations are all divided by rhoConst
o introduced new parameter rhoConstFresh, a reference density of fresh
  water, to remove the fresh water flux's dependence on rhoNil. The default
  value is 999.8 kg/m^3
o cleanup up external_forcing.F and external_forcing_surf.F
  - can now be used by both OCEANIC and OCEANICP

1 mlosch 1.75 C $Header: /u/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.74 2002/08/07 16:55:52 mlosch Exp $
2 mlosch 1.74 C $Name: $
3 cnh 1.1 C
4 cnh 1.63 CBOP
5     C !ROUTINE: PARAMS.h
6     C !INTERFACE:
7     C include PARAMS.h
8     C !DESCRIPTION: \bv
9     C *==========================================================*
10     C | PARAMS.h
11     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 cnh 1.13
20     C Macros for special grid options
21     #include "PARAMS_MACROS.h"
22 cnh 1.1
23     C-- Contants
24     C Useful physical values
25     Real*8 PI
26     PARAMETER ( PI = 3.14159265358979323844D0 )
27     Real*8 deg2rad
28     PARAMETER ( deg2rad = 2.D0*PI/360.D0 )
29    
30 cnh 1.7 C Symbolic values
31 cnh 1.63 C precXXXX :: Used to indicate what precision to use for
32 cnh 1.7 C dumping model state.
33     INTEGER precFloat32
34 adcroft 1.36 PARAMETER ( precFloat32 = 32 )
35 cnh 1.7 INTEGER precFloat64
36 adcroft 1.36 PARAMETER ( precFloat64 = 64 )
37 cnh 1.63 C UNSET_xxx :: Used to indicate variables that have not been given a value
38 cnh 1.28 Real*8 UNSET_FLOAT8
39     PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
40     Real*4 UNSET_FLOAT4
41     PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
42     _RL UNSET_RL
43     PARAMETER ( UNSET_RL = 1.234567D5 )
44     _RS UNSET_RS
45     PARAMETER ( UNSET_RS = 1.234567E5 )
46     INTEGER UNSET_I
47     PARAMETER ( UNSET_I = 123456789 )
48 cnh 1.7
49     C Checkpoint data
50     INTEGER maxNoChkptLev
51     PARAMETER ( maxNoChkptLev = 2 )
52    
53 cnh 1.1 C-- COMMON /PARM_C/ Character valued parameters used by the model.
54 cnh 1.63 C checkPtSuff :: List of checkpoint file suffices
55     C bathyFile :: File containing bathymetry. If not defined bathymetry
56 cnh 1.16 C is taken from inline function.
57 cnh 1.63 C topoFile :: File containing the topography of the surface (unit=m)
58 jmc 1.55 C (mainly used for the atmosphere = ground height).
59 cnh 1.63 C hydrogThetaFile :: File containing initial hydrographic data for potential
60 cnh 1.16 C temperature.
61 cnh 1.63 C hydrogSaltFile :: File containing initial hydrographic data for salinity.
62     C zonalWindFile :: File containing zonal wind data
63     C meridWindFile :: File containing meridional wind data
64     C thetaClimFile :: File containing theta climataology used
65 cnh 1.18 C in relaxation term -lambda(theta-theta*)
66 cnh 1.63 C saltClimFile :: File containing salt climataology used
67 cnh 1.18 C in relaxation term -lambda(salt-salt*)
68 cnh 1.63 C surfQfile :: File containing surface heat flux
69     C surfQswfile :: File containing surface shortwave radiation
70     C dQdTfile :: File containing thermal relaxation coefficient
71     C EmPmRfile :: File containing surface fresh water flux
72 mlosch 1.73 C pLoadFile :: File containing pressure loading
73 cnh 1.63 C buoyancyRelation :: Flag used to indicate which relation to use to
74 cnh 1.26 C get buoyancy.
75 mlosch 1.74 C eosType :: choose the equation of state:
76     C LINEAR, POLY3, UNESCO, JMD95Z, JMD95P
77 cnh 1.16 COMMON /PARM_C/ checkPtSuff,
78 jmc 1.55 & bathyFile, topoFile,
79     & hydrogThetaFile, hydrogSaltFile,
80 cnh 1.18 & zonalWindFile, meridWindFile, thetaClimFile,
81 adcroft 1.37 & saltClimFile, buoyancyRelation,
82 heimbach 1.45 & EmPmRfile, surfQfile, surfQswfile,
83 heimbach 1.50 & uVelInitFile, vVelInitFile, pSurfInitFile,
84 mlosch 1.74 & dQdTfile, ploadFile,
85     & eosType
86 cnh 1.7 CHARACTER*(5) checkPtSuff(maxNoChkptLev)
87 jmc 1.55 CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
88 cnh 1.16 CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
89     CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
90     CHARACTER*(MAX_LEN_FNAM) zonalWindFile
91     CHARACTER*(MAX_LEN_FNAM) meridWindFile
92 cnh 1.18 CHARACTER*(MAX_LEN_FNAM) thetaClimFile
93     CHARACTER*(MAX_LEN_FNAM) saltClimFile
94 adcroft 1.37 CHARACTER*(MAX_LEN_FNAM) surfQfile
95 heimbach 1.45 CHARACTER*(MAX_LEN_FNAM) surfQswfile
96 adcroft 1.37 CHARACTER*(MAX_LEN_FNAM) EmPmRfile
97 cnh 1.26 CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
98 adcroft 1.42 CHARACTER*(MAX_LEN_FNAM) uVelInitFile
99     CHARACTER*(MAX_LEN_FNAM) vVelInitFile
100 adcroft 1.43 CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
101 heimbach 1.50 CHARACTER*(MAX_LEN_FNAM) dQdTfile
102 mlosch 1.73 CHARACTER*(MAX_LEN_FNAM) ploadFile
103 mlosch 1.74 CHARACTER*(6) eosType
104 cnh 1.7
105 cnh 1.1 C-- COMMON /PARM_I/ Integer valued parameters used by the model.
106 cnh 1.63 C cg2dMaxIters :: Maximum number of iterations in the
107 cnh 1.1 C two-dimensional con. grad solver.
108 cnh 1.63 C cg2dChkResFreq :: Frequency with which to check residual
109 cnh 1.1 C in con. grad solver.
110 cnh 1.63 C cg3dMaxIters :: Maximum number of iterations in the
111 cnh 1.33 C three-dimensional con. grad solver.
112 cnh 1.63 C cg3dChkResFreq :: Frequency with which to check residual
113 cnh 1.33 C in con. grad solver.
114 cnh 1.63 C nIter0 :: Start time-step number of for this run
115     C nTimeSteps :: Number of timesteps to execute
116     C numStepsPerPickup :: For offline setup. Frequency of pickup
117 cnh 1.1 C of flow fields.
118 cnh 1.63 C writeStatePrec :: Precision used for writing model state.
119     C writeBinaryPrec :: Precision used for writing binary files
120     C readBinaryPrec :: Precision used for reading binary files
121     C nCheckLev :: Holds current checkpoint level
122     C nonlinFreeSurf :: option related to non-linear free surface
123 jmc 1.55 C =0 Linear free surface ; >0 Non-linear
124 cnh 1.34
125 cnh 1.1 COMMON /PARM_I/
126     & cg2dMaxIters,
127     & cg2dChkResFreq,
128 cnh 1.33 & cg3dMaxIters,
129     & cg3dChkResFreq,
130 adcroft 1.41 & nIter0, nTimeSteps, nEndIter,
131 cnh 1.7 & numStepsPerPickup,
132     & writeStatePrec, nCheckLev,
133 cnh 1.34 & writeBinaryPrec, readBinaryPrec,
134 jmc 1.55 & nonlinFreeSurf,
135 adcroft 1.57 & tempAdvScheme, saltAdvScheme, tracerAdvScheme
136 cnh 1.1 INTEGER cg2dMaxIters
137     INTEGER cg2dChkResFreq
138 cnh 1.33 INTEGER cg3dMaxIters
139     INTEGER cg3dChkResFreq
140 cnh 1.1 INTEGER nIter0
141     INTEGER nTimeSteps
142 adcroft 1.41 INTEGER nEndIter
143 cnh 1.1 INTEGER numStepsPerPickup
144 cnh 1.7 INTEGER writeStatePrec
145     INTEGER writeBinaryPrec
146     INTEGER readBinaryPrec
147     INTEGER nCheckLev
148 jmc 1.55 INTEGER nonlinFreeSurf
149 adcroft 1.57 INTEGER tempAdvScheme
150     INTEGER saltAdvScheme
151     INTEGER tracerAdvScheme
152 cnh 1.1
153     C-- COMMON /PARM_L/ Logical valued parameters used by the model.
154 cnh 1.63 C usingCartesianGrid :: If TRUE grid generation will be in a cartesian
155 cnh 1.1 C coordinate frame.
156 cnh 1.63 C usingSphericalPolarGrid :: If TRUE grid generation will be in a
157 cnh 1.1 C spherical polar frame.
158 cnh 1.63 C no_slip_sides :: Impose "no-slip" at lateral boundaries.
159     C no_slip_bottom :: Impose "no-slip" at bottom boundary.
160     C staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
161     C momViscosity :: Flag which turns momentum friction terms on and off.
162     C momAdvection :: Flag which turns advection of momentum on and off.
163     C momForcing :: Flag which turns external forcing of momentum on
164 cnh 1.1 C and off.
165 cnh 1.63 C momPressureForcing :: Flag which turns pressure term in momentum equation
166 cnh 1.9 C on and off.
167 cnh 1.63 C metricTerms :: Flag which turns metric terms on or off.
168     C usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
169     C useCoriolis :: Flag which turns the coriolis terms on and off.
170     C tempDiffusion :: Flag which turns diffusion of temperature on
171 cnh 1.1 C and off.
172 cnh 1.63 C tempAdvection :: Flag which turns advection of temperature on
173 cnh 1.1 C and off.
174 cnh 1.63 C tempForcing :: Flag which turns external forcing of temperature on
175 cnh 1.1 C and off.
176 jmc 1.71 C saltDiffusion :: Flag which turns diffusion of salinity on
177 cnh 1.1 C and off.
178 jmc 1.71 C saltAdvection :: Flag which turns advection of salinity on
179 cnh 1.1 C and off.
180 jmc 1.71 C saltForcing :: Flag which turns external forcing of salinity on
181 cnh 1.1 C and off.
182 jmc 1.71 C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
183     C as a real Fresh Water (=> changes the Sea Level)
184     C if F, converts P+R-E to salt flux (no SL effect)
185 cnh 1.63 C rigidLid :: Set to true to use rigid lid
186     C implicitFreeSurface :: Set to true to use implcit free surface
187     C exactConserv :: Set to true to conserve exactly the total Volume
188     C uniformLin_PhiSurf :: Set to true to use a uniform Bo_surf in the
189 jmc 1.55 C linear relation Phi_surf = Bo_surf*eta
190 cnh 1.63 C momStepping :: Turns momentum equation time-stepping off
191     C tempStepping :: Turns temperature equation time-stepping off
192     C saltStepping :: Turns salinity equation time-stepping off
193     C tr1Stepping :: Turns passive tracer 1 time-stepping on/off
194     C useConstantF :: Coriolis parameter set to f0
195     C useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
196     C useSphereF :: Coriolis parameter set to 2.omega.sin(phi)
197 jmc 1.71 C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
198 cnh 1.63 C implicitDiffusion :: Turns implicit vertical diffusion on
199     C implicitViscosity :: Turns implicit vertical viscosity on
200 jmc 1.71 C multiDimAdvection :: Flag that enable multi-dimension advection
201     C forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
202     C out off Adams-Bashforth time stepping.
203 cnh 1.63 C doThetaClimRelax :: Set true if relaxation to temperature
204 cnh 1.18 C climatology is required.
205 cnh 1.63 C doSaltClimRelax :: Set true if relaxation to salinity
206 cnh 1.18 C climatology is required.
207 cnh 1.63 C periodicExternalForcing :: Set true if forcing is time-dependant
208     C usingPCoords :: Set to indicate that we are working in pressure
209 cnh 1.29 C coords.
210 cnh 1.63 C usingZCoords :: Set to indicate that we are working in height
211 cnh 1.29 C coords.
212 jmc 1.70 C setCenterDr :: set cell Center depth and put Interface at the middle
213 cnh 1.63 C nonHydrostatic :: Using non-hydrostatic terms
214     C globalFiles :: Selects between "global" and "tiled" files
215     C allowFreezing :: Allows water to freeze and form ice
216     C groundAtK1 :: put the surface(k=1) at the Lower Boundary (=ground)
217 cnh 1.1 COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
218 adcroft 1.52 & usingCurvilinearGrid,
219 adcroft 1.36 & no_slip_sides,no_slip_bottom,
220 adcroft 1.46 & staggerTimeStep,
221 cnh 1.33 & momViscosity, momAdvection, momForcing, useCoriolis,
222 adcroft 1.58 & momPressureForcing, vectorInvariantMomentum,
223     & tempDiffusion, tempAdvection, tempForcing,
224 cnh 1.8 & saltDiffusion, saltAdvection, saltForcing,
225 jmc 1.68 & useRealFreshWaterFlux,
226 jmc 1.55 & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
227 heimbach 1.56 & momStepping, tempStepping, saltStepping, tr1Stepping,
228 cnh 1.15 & metricTerms, usingSphericalPolarMTerms,
229     & useConstantF, useBetaPlaneF, useSphereF,
230 jmc 1.71 & useEnergyConservingCoriolis, useJamartWetPoints,
231 adcroft 1.40 & implicitDiffusion, implicitViscosity,
232 jmc 1.71 & multiDimAdvection, forcing_In_AB,
233 heimbach 1.56 & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
234 jmc 1.70 & periodicExternalForcing,
235     & usingPCoords, usingZCoords, setCenterDr,
236 adcroft 1.46 & nonHydrostatic, globalFiles,
237 heimbach 1.51 & allowFreezing, groundAtK1,
238 heimbach 1.56 & usePickupBeforeC35, debugMode,
239 jmc 1.71 & readPickupWithTracer, writePickupWithTracer
240 cnh 1.1 LOGICAL usingCartesianGrid
241     LOGICAL usingSphericalPolarGrid
242 adcroft 1.52 LOGICAL usingCurvilinearGrid
243 cnh 1.15 LOGICAL usingSphericalPolarMTerms
244 adcroft 1.36 LOGICAL no_slip_sides
245     LOGICAL no_slip_bottom
246 adcroft 1.46 LOGICAL staggerTimeStep
247 cnh 1.1 LOGICAL momViscosity
248     LOGICAL momAdvection
249     LOGICAL momForcing
250 cnh 1.9 LOGICAL momPressureForcing
251 cnh 1.1 LOGICAL useCoriolis
252 adcroft 1.58 LOGICAL vectorInvariantMomentum
253 cnh 1.1 LOGICAL tempDiffusion
254     LOGICAL tempAdvection
255     LOGICAL tempForcing
256     LOGICAL saltDiffusion
257     LOGICAL saltAdvection
258     LOGICAL saltForcing
259 jmc 1.68 LOGICAL useRealFreshWaterFlux
260 adcroft 1.52 LOGICAL rigidLid
261 cnh 1.8 LOGICAL implicitFreeSurface
262 adcroft 1.52 LOGICAL exactConserv
263 jmc 1.55 LOGICAL uniformLin_PhiSurf
264 cnh 1.10 LOGICAL momStepping
265     LOGICAL tempStepping
266 adcroft 1.17 LOGICAL saltStepping
267 heimbach 1.56 LOGICAL tr1Stepping
268 cnh 1.15 LOGICAL metricTerms
269     LOGICAL useConstantF
270     LOGICAL useBetaPlaneF
271     LOGICAL useSphereF
272 jmc 1.71 LOGICAL useEnergyConservingCoriolis
273     LOGICAL useJamartWetPoints
274 adcroft 1.14 LOGICAL implicitDiffusion
275 adcroft 1.40 LOGICAL implicitViscosity
276 jmc 1.71 LOGICAL multiDimAdvection
277     LOGICAL forcing_In_AB
278 cnh 1.18 LOGICAL doThetaClimRelax
279     LOGICAL doSaltClimRelax
280 heimbach 1.56 LOGICAL doTr1ClimRelax
281 adcroft 1.19 LOGICAL periodicExternalForcing
282 cnh 1.29 LOGICAL usingPCoords
283     LOGICAL usingZCoords
284 jmc 1.70 LOGICAL setCenterDr
285 adcroft 1.37 LOGICAL nonHydrostatic
286 adcroft 1.38 LOGICAL globalFiles
287     LOGICAL allowFreezing
288 adcroft 1.46 LOGICAL groundAtK1
289 heimbach 1.51 LOGICAL usePickupBeforeC35
290 adcroft 1.54 LOGICAL debugMode
291 heimbach 1.56 LOGICAL readPickupWithTracer
292     LOGICAL writePickupWithTracer
293 cnh 1.1
294     C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
295 adcroft 1.52 C gg2dTargetResidual
296 cnh 1.63 C :: Target residual for cg2d solver; no unit (RHS normalisation)
297 adcroft 1.52 C cg2dTargetResWunit
298 cnh 1.63 C :: Target residual for cg2d solver; W unit (No RHS normalisation)
299 cnh 1.33 C cg3dTargetResidual
300 cnh 1.63 C :: Target residual for cg3d solver.
301     C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
302 cnh 1.7 C Note. 20th May 1998
303     C I made a weird discovery! In the model paper we argue
304     C for the form of the preconditioner used here ( see
305     C A Finite-volume, Incompressible Navier-Stokes Model
306     C ...., Marshall et. al ). The algebra gives a simple
307     C 0.5 factor for the averaging of ac and aCw to get a
308     C symmettric pre-conditioner. By using a factor of 0.51
309     C i.e. scaling the off-diagonal terms in the
310     C preconditioner down slightly I managed to get the
311     C number of iterations for convergence in a test case to
312     C drop form 192 -> 134! Need to investigate this further!
313     C For now I have introduced a parameter cg2dpcOffDFac which
314     C defaults to 0.51 but can be set at runtime.
315 cnh 1.63 C delP :: Vertical grid spacing ( Pa ).
316     C delZ :: Vertical grid spacing ( m ).
317     C delR :: Vertical grid spacing ( units of r ).
318 jmc 1.70 C delRc :: Vertical grid spacing between cell centers (r unit).
319 cnh 1.63 C delX :: Separation between cell faces (m) or (deg), depending
320 cnh 1.1 C delY on input flags.
321 cnh 1.63 C gravity :: Accel. due to gravity ( m/s^2 )
322 cnh 1.32 C recip_gravity and its inverse
323 cnh 1.63 C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 )
324 mlosch 1.75 C rhoNil :: Reference density for the linear equation of state
325 cnh 1.63 C rhoConst :: Vertically constant reference density
326 mlosch 1.75 C rhoConstFresh :: Constant reference density for fresh water (rain)
327 cnh 1.63 C startTime :: Start time for model ( s )
328     C phiMin :: Latitude of southern most cell face.
329     C thetaMin :: Longitude of western most cell face (this
330 cnh 1.1 C is an "inert" parameter but it is included
331     C to make geographical references simple.)
332 cnh 1.63 C rSphere :: Radius of sphere for a spherical polar grid ( m ).
333     C recip_RSphere :: Reciprocal radius of sphere ( m ).
334     C f0 :: Reference coriolis parameter ( 1/s )
335 cnh 1.1 C ( Southern edge f for beta plane )
336 cnh 1.63 C beta :: df/dy ( s^-1.m^-1 )
337     C omega :: Angular velocity ( rad/s )
338     C viscAh :: Eddy viscosity coeff. for mixing of
339 cnh 1.1 C momentum laterally ( m^2/s )
340 cnh 1.63 C viscAz :: Eddy viscosity coeff. for mixing of
341 cnh 1.1 C momentum vertically ( m^2/s )
342 cnh 1.63 C viscAp :: Eddy viscosity coeff. for mixing of
343 cnh 1.27 C momentum vertically ( Pa^2/s )
344 cnh 1.63 C viscAr :: Eddy viscosity coeff. for mixing of
345 cnh 1.24 C momentum vertically ( units of r^2/s )
346 cnh 1.63 C viscA4 :: Biharmonic viscosity coeff. for mixing of
347 cnh 1.1 C momentum laterally ( m^4/s )
348 cnh 1.63 C diffKhT :: Laplacian diffusion coeff. for mixing of
349 cnh 1.1 C heat laterally ( m^2/s )
350 cnh 1.63 C diffKzT :: Laplacian diffusion coeff. for mixing of
351 cnh 1.1 C heat vertically ( m^2/s )
352 cnh 1.63 C diffKpT :: Laplacian diffusion coeff. for mixing of
353 cnh 1.27 C heat vertically ( Pa^2/s )
354 cnh 1.63 C diffKrT :: Laplacian diffusion coeff. for mixing of
355 cnh 1.24 C heat vertically ( units of r^2/s )
356 cnh 1.63 C diffK4T :: Biharmonic diffusion coeff. for mixing of
357 cnh 1.1 C heat laterally ( m^4/s )
358 cnh 1.63 C diffKhS :: Laplacian diffusion coeff. for mixing of
359 cnh 1.1 C salt laterally ( m^2/s )
360 cnh 1.63 C diffKzS :: Laplacian diffusion coeff. for mixing of
361 cnh 1.1 C salt vertically ( m^2/s )
362 cnh 1.63 C diffKpS :: Laplacian diffusion coeff. for mixing of
363 cnh 1.27 C salt vertically ( Pa^2/s )
364 cnh 1.63 C diffKrS :: Laplacian diffusion coeff. for mixing of
365 cnh 1.24 C salt vertically ( units of r^2/s )
366 cnh 1.63 C diffK4S :: Biharmonic diffusion coeff. for mixing of
367 cnh 1.1 C salt laterally ( m^4/s )
368 cnh 1.63 C deltaT :: Default timestep ( s )
369     C deltaTClock :: Timestep used as model "clock". This determines the
370 cnh 1.7 C IO frequencies and is used in tagging output. It can
371     C be totally different to the dynamical time. Typically
372     C it will be the deep-water timestep for accelerated runs.
373     C Frequency of checkpointing and dumping of the model state
374     C are referenced to this clock. ( s )
375 cnh 1.63 C deltaTMom :: Timestep for momemtum equations ( s )
376     C deltaTtracer :: Timestep for tracer equations ( s )
377 adcroft 1.72 C deltaTfreesurf :: Timestep for free-surface equation ( s )
378 cnh 1.63 C freesurfFac :: Parameter to turn implicit free surface term on or off
379 cnh 1.8 C freesurfac = 1. uses implicit free surface
380     C freesurfac = 0. uses rigid lid
381 cnh 1.63 C implicSurfPress :: parameter of the Crank-Nickelson time stepping :
382 jmc 1.48 C Implicit part of Surface Pressure Gradient ( 0-1 )
383 cnh 1.63 C implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
384 jmc 1.48 C Implicit part of barotropic flow Divergence ( 0-1 )
385 cnh 1.63 C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...)
386     C hFacMinDz :: Minimum dimesional size of a cell (affects hFacC etc..., m)
387     C hFacMinDp :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
388     C hFacMinDr :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
389     C hFacInf :: Threshold (inf and sup) for fraction size of surface cell
390 adcroft 1.52 C hFacSup that control vanishing and creating levels
391 cnh 1.63 C tauCD :: CD scheme coupling timescale ( 1/s )
392     C rCD :: CD scheme normalised coupling parameter ( 0-1 )
393     C startTime :: Starting time for this integration ( s ).
394     C endTime :: Ending time for this integration ( s ).
395     C chkPtFreq :: Frequency of rolling check pointing ( s ).
396     C pChkPtFreq :: Frequency of permanent check pointing ( s ).
397     C dumpFreq :: Frequency with which model state is written to
398 cnh 1.24 C post-processing files ( s ).
399 cnh 1.63 C diagFreq :: Frequency with which model writes diagnostic output
400 adcroft 1.59 C of intermediate quantities.
401 cnh 1.63 C afFacMom :: Advection of momentum term tracer parameter
402     C vfFacMom :: Momentum viscosity tracer parameter
403     C pfFacMom :: Momentum pressure forcing tracer parameter
404     C cfFacMom :: Coriolis term tracer parameter
405     C foFacMom :: Momentum forcing tracer parameter
406     C mtFacMom :: Metric terms tracer parameter
407     C cosPower :: Power of cosine of latitude to multiply viscosity
408     C cAdjFreq :: Frequency of convective adjustment
409 cnh 1.24 C
410 cnh 1.63 C taveFreq :: Frequency with which time-averaged model state is written to
411 cnh 1.27 C post-processing files ( s ).
412 cnh 1.63 C tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
413     C lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
414     C tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
415     C lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
416     C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
417     C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
418 adcroft 1.19 C (note: externForcingCycle must be an integer
419     C number times externForcingPeriod)
420 jmc 1.68 C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
421     C (use model surface (local) value if set to -1)
422     C temp_EvPrRn :: temperature of Rain & Evap.
423     C salt_EvPrRn :: salinity of Rain & Evap.
424     C trac_EvPrRn :: tracer concentration in Rain & Evap.
425     C (notes: a) tracer content of Rain/Evap only used if both
426     C NonLin_FrSurf & useRealFreshWater are set.
427     C b) use model surface (local) value if set to UNSET_RL)
428 cnh 1.63 C horiVertRatio :: Ratio on units in vertical to units in horizontal.
429 cnh 1.31 C recip_horiVertRatio ( 1 if horiz in m and vertical in m ).
430 cnh 1.30 C ( g*rho if horiz in m and vertical in Pa ).
431 cnh 1.63 C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
432 adcroft 1.46 C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
433 cnh 1.63 C bottomDragLinear :: Drag coefficient built in to core dynamics
434 adcroft 1.64 C --"-"-- Quadratic ( linear: 1/s, quadratic: 1/m )
435 adcroft 1.52 COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
436     & cg2dpcOffDFac, cg3dTargetResidual,
437 jmc 1.70 & delP, delZ, delR, delRc, delX, delY,
438 adcroft 1.72 & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
439     & abeps, startTime,
440 adcroft 1.52 & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
441     & fCori, fCoriG,
442 adcroft 1.60 & viscAh, viscAz, viscA4, viscAr, viscAstrain, viscAtension,
443 cnh 1.24 & diffKhT, diffKzT, diffK4T, diffKrT,
444 cnh 1.25 & diffKhS, diffKzS, diffK4S, diffKrS,
445 jmc 1.48 & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
446 adcroft 1.52 & hFacMin, hFacMinDz, hFacInf, hFacSup,
447 cnh 1.32 & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
448 mlosch 1.75 & recip_rhoConst, rhoConst,
449     & recip_rhoConstFresh, rhoConstFresh, tRef, sRef,
450 adcroft 1.59 & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
451     & diagFreq, taveFreq, monitorFreq,
452 cnh 1.15 & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
453 heimbach 1.56 & cosPower, cAdjFreq, omega,
454     & tauThetaClimRelax, lambdaThetaClimRelax,
455 adcroft 1.19 & tauSaltClimRelax, lambdaSaltClimRelax,
456 heimbach 1.56 & tauTr1ClimRelax, lambdaTr1ClimRelax,
457 cnh 1.27 & externForcingCycle, externForcingPeriod,
458 jmc 1.68 & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
459 cnh 1.28 & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
460 jmc 1.68 & horiVertRatio, recip_horiVertRatio,
461 jmc 1.67 & ivdc_kappa, Ro_SeaLevel,
462 adcroft 1.46 & bottomDragLinear,bottomDragQuadratic
463 cnh 1.27
464 adcroft 1.6 _RL cg2dTargetResidual
465 adcroft 1.52 _RL cg2dTargetResWunit
466 cnh 1.33 _RL cg3dTargetResidual
467 cnh 1.7 _RL cg2dpcOffDFac
468 cnh 1.25 _RL delZ(Nr)
469     _RL delP(Nr)
470     _RL delR(Nr)
471 jmc 1.70 _RL delRc(Nr+1)
472 adcroft 1.6 _RL delX(Nx)
473     _RL delY(Ny)
474     _RL deltaT
475 cnh 1.7 _RL deltaTClock
476 adcroft 1.6 _RL deltaTmom
477     _RL deltaTtracer
478 adcroft 1.72 _RL deltaTfreesurf
479 adcroft 1.6 _RL abeps
480     _RL phiMin
481     _RL thetaMin
482     _RL rSphere
483 cnh 1.25 _RL recip_RSphere
484 adcroft 1.6 _RL f0
485 cnh 1.8 _RL freeSurfFac
486 jmc 1.48 _RL implicSurfPress
487     _RL implicDiv2Dflow
488 adcroft 1.22 _RL hFacMin
489     _RL hFacMinDz
490 cnh 1.28 _RL hFacMinDp
491 cnh 1.27 _RL hFacMinDr
492 adcroft 1.52 _RL hFacInf
493     _RL hFacSup
494 adcroft 1.6 _RL beta
495     _RL viscAh
496 adcroft 1.60 _RL viscAstrain
497     _RL viscAtension
498 adcroft 1.6 _RL viscAz
499 cnh 1.27 _RL viscAp
500 cnh 1.25 _RL viscAr
501 adcroft 1.6 _RL viscA4
502     _RL diffKhT
503 cnh 1.25 _RL diffKrT
504 adcroft 1.6 _RL diffKzT
505 cnh 1.27 _RL diffKpT
506 adcroft 1.6 _RL diffK4T
507     _RL diffKhS
508 cnh 1.25 _RL diffKrS
509 adcroft 1.6 _RL diffKzS
510 cnh 1.27 _RL diffKpS
511 adcroft 1.6 _RL diffK4S
512     _RL delt
513     _RL tauCD
514     _RL rCD
515     _RL gravity
516 cnh 1.32 _RL recip_gravity
517 cnh 1.8 _RL gBaro
518 adcroft 1.6 _RL rhonil
519 cnh 1.25 _RL recip_rhonil
520     _RL rhoConst
521 cnh 1.26 _RL recip_rhoConst
522 mlosch 1.75 _RL rhoConstFresh
523     _RL recip_rhoConstFresh
524 cnh 1.25 _RL tRef(Nr)
525     _RL sRef(Nr)
526 adcroft 1.52 _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
527     _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
528 adcroft 1.6 _RL startTime
529     _RL endTime
530     _RL chkPtFreq
531 cnh 1.7 _RL pChkPtFreq
532 adcroft 1.6 _RL dumpFreq
533 adcroft 1.59 _RL diagFreq
534 adcroft 1.20 _RL taveFreq
535 adcroft 1.53 _RL monitorFreq
536 cnh 1.9 _RL afFacMom
537     _RL vfFacMom
538     _RL pfFacMom
539     _RL cfFacMom
540     _RL foFacMom
541 cnh 1.15 _RL mTFacMom
542 adcroft 1.39 _RL cosPower
543 cnh 1.9 _RL cAdjFreq
544 cnh 1.15 _RL omega
545 cnh 1.18 _RL tauThetaClimRelax
546     _RL lambdaThetaClimRelax
547     _RL tauSaltClimRelax
548     _RL lambdaSaltClimRelax
549 heimbach 1.56 _RL tauTr1ClimRelax
550     _RL lambdaTr1ClimRelax
551 adcroft 1.19 _RL externForcingCycle
552     _RL externForcingPeriod
553 jmc 1.68 _RL convertFW2Salt
554     _RL temp_EvPrRn
555     _RL salt_EvPrRn
556     _RL trac_EvPrRn
557 cnh 1.30 _RL horiVertRatio
558 cnh 1.31 _RL recip_horiVertRatio
559 adcroft 1.41 _RL ivdc_kappa
560 adcroft 1.46 _RL Ro_SeaLevel
561     _RL bottomDragLinear
562     _RL bottomDragQuadratic
563 adcroft 1.6
564 adcroft 1.36 COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
565 cnh 1.1 & Lamba_theta
566 adcroft 1.6 _RL HeatCapacity_Cp
567     _RL Lamba_theta
568 adcroft 1.36 _RL recip_Cp
569 adcroft 1.5
570 mlosch 1.74 CmlC Equation of State (polynomial coeffients)
571     Cml COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
572     Cml _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
573     CmlC Linear equation of state
574     CmlC tAlpha :: Linear EOS thermal expansion coefficient ( 1/degree ).
575     CmlC sBeta :: Linear EOS haline contraction coefficient.
576     Cml COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
577     Cml _RL tAlpha
578     Cml _RL sBeta
579 jmc 1.55
580     C Atmospheric physical parameters (Ideal Gas EOS, ...)
581 cnh 1.63 C atm_po :: standard reference pressure
582     C atm_cp :: specific heat (Cp) of the (dry) air at constant pressure
583     C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
584     C Integr_GeoPot :: option to select the way we integrate the geopotential
585 jmc 1.55 C (still a subject of discussions ...)
586     COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,
587     & Integr_GeoPot
588     _RL atm_cp, atm_kappa, atm_po
589     INTEGER Integr_GeoPot
590 cnh 1.7
591 adcroft 1.44 C Logical flags for selecting packages
592 heimbach 1.45 LOGICAL useKPP
593     LOGICAL useGMRedi
594 adcroft 1.46 LOGICAL useOBCS
595 jmc 1.49 LOGICAL useAIM
596 heimbach 1.56 LOGICAL useGrdchk
597 heimbach 1.45 LOGICAL useECCO
598 adcroft 1.52 LOGICAL useSHAP_FILT
599 jmc 1.67 LOGICAL useZONAL_FILT
600 adcroft 1.62 LOGICAL useFLT
601 adcroft 1.69 LOGICAL usePTRACERS
602 adcroft 1.44 COMMON /PARM_PACKAGES/
603 heimbach 1.56 & useKPP, useGMRedi, useOBCS, useAIM, useECCO,
604 adcroft 1.69 & useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
605     & usePTRACERS
606 jmc 1.49

  ViewVC Help
Powered by ViewVC 1.1.22