/[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.136 by dimitri, Tue Nov 2 23:57:29 2004 UTC revision 1.170 by jmc, Mon Oct 24 22:38:49 2005 UTC
# Line 49  C     Checkpoint data Line 49  C     Checkpoint data
49    
50  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
51  C     checkPtSuff :: List of checkpoint file suffices  C     checkPtSuff :: List of checkpoint file suffices
52    C     delXFile      :: File containing X-spacing grid definition (1.D array)
53    C     delYFile      :: File containing Y-spacing grid definition (1.D array)
54    C     horizGridFile :: File containing horizontal-grid definition
55    C                        (only when using curvilinear_grid)
56  C     bathyFile   :: File containing bathymetry. If not defined bathymetry  C     bathyFile   :: File containing bathymetry. If not defined bathymetry
57  C                   is taken from inline function.  C                   is taken from inline function.
58  C     topoFile    :: File containing the topography of the surface (unit=m)  C     topoFile    :: File containing the topography of the surface (unit=m)
# Line 68  C     surfQnetFile    :: File containing Line 72  C     surfQnetFile    :: File containing
72  C     surfQswFile     :: File containing surface shortwave radiation  C     surfQswFile     :: File containing surface shortwave radiation
73  C     dQdTfile        :: File containing thermal relaxation coefficient  C     dQdTfile        :: File containing thermal relaxation coefficient
74  C     EmPmRfile       :: File containing surface fresh water flux  C     EmPmRfile       :: File containing surface fresh water flux
75    C     saltFluxFile    :: File containing surface salt flux
76  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
77    C     eddyTauxFile    :: File containing zonal Eddy stress data
78    C     eddyTauyFile    :: File containing meridional Eddy stress data
79  C     buoyancyRelation :: Flag used to indicate which relation to use to  C     buoyancyRelation :: Flag used to indicate which relation to use to
80  C                        get buoyancy.  C                        get buoyancy.
81  C     eosType         :: choose the equation of state:  C     eosType         :: choose the equation of state:
82  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
83  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
84        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
85         &                delXFile, delYFile, horizGridFile,
86       &                bathyFile, topoFile,       &                bathyFile, topoFile,
87       &                hydrogThetaFile, hydrogSaltFile,       &                hydrogThetaFile, hydrogSaltFile,
88       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
89       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
90       &                EmPmRfile, surfQfile, surfQnetFile, surfQswFile,       &                EmPmRfile, saltFluxFile,
91         &                surfQfile, surfQnetFile, surfQswFile,
92         &                lambdaThetaFile, lambdaSaltFile,
93       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
94       &                dQdTfile, ploadFile,       &                dQdTfile, ploadFile,
95         &                eddyTauxFile, eddyTauyFile,
96       &                eosType, pickupSuff,       &                eosType, pickupSuff,
97       &                mdsioLocalDir,       &                mdsioLocalDir,
98       &                the_run_name       &                the_run_name
99        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
100          CHARACTER*(MAX_LEN_FNAM) delXFile
101          CHARACTER*(MAX_LEN_FNAM) delYFile
102          CHARACTER*(MAX_LEN_FNAM) horizGridFile
103        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
104        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
105        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
# Line 97  C     the_run_name    :: string identify Line 111  C     the_run_name    :: string identify
111        CHARACTER*(MAX_LEN_FNAM) surfQnetFile        CHARACTER*(MAX_LEN_FNAM) surfQnetFile
112        CHARACTER*(MAX_LEN_FNAM) surfQswFile        CHARACTER*(MAX_LEN_FNAM) surfQswFile
113        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
114          CHARACTER*(MAX_LEN_FNAM) saltFluxFile
115        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
116        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
117        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
118        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
119        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
120        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) ploadFile
121          CHARACTER*(MAX_LEN_FNAM) eddyTauxFile
122          CHARACTER*(MAX_LEN_FNAM) eddyTauyFile
123          CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
124          CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
125        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
126        CHARACTER*(MAX_LEN_FNAM) the_run_name        CHARACTER*(MAX_LEN_FNAM) the_run_name
127        CHARACTER*(6) eosType        CHARACTER*(6) eosType
# Line 132  C                           =0 Linear fr Line 151  C                           =0 Linear fr
151  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
152  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
153  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
154  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
155  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
156  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
157    C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)
158  C     debugLevel          :: debug level selector: higher -> more writing  C     debugLevel          :: debug level selector: higher -> more writing
159    
160        COMMON /PARM_I/        COMMON /PARM_I/
# Line 149  C     debugLevel          :: debug level Line 169  C     debugLevel          :: debug level
169       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
170       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
171       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
172       &        tracerAdvScheme,       &        selectKEscheme,
173       &        debugLevel       &        debugLevel
174        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
175        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
# Line 168  C     debugLevel          :: debug level Line 188  C     debugLevel          :: debug level
188        INTEGER select_rStar        INTEGER select_rStar
189        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
190        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
191        INTEGER tracerAdvScheme        INTEGER selectKEscheme
192        INTEGER debugLevel        INTEGER debugLevel
193    
194  C  C
# Line 198  C     metricTerms   :: Flag which turns Line 218  C     metricTerms   :: Flag which turns
218  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
219  C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.
220  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
 C     tempDiffusion :: Flag which turns diffusion of temperature on  
 C                     and off.  
221  C     tempAdvection :: Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
222  C                     and off.  C                     and off.
223  C     tempForcing   :: Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
224  C                     and off.  C                     and off.
 C     saltDiffusion :: Flag which turns diffusion of salinity on  
 C                     and off.  
225  C     saltAdvection :: Flag which turns advection of salinity on  C     saltAdvection :: Flag which turns advection of salinity on
226  C                     and off.  C                     and off.
227  C     saltForcing   :: Flag which turns external forcing of salinity on  C     saltForcing   :: Flag which turns external forcing of salinity on
# Line 213  C                     and off. Line 229  C                     and off.
229  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
230  C                         as a real Fresh Water (=> changes the Sea Level)  C                         as a real Fresh Water (=> changes the Sea Level)
231  C                         if F, converts P+R-E to salt flux (no SL effect)  C                         if F, converts P+R-E to salt flux (no SL effect)
232    C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
233    C                       on irregular grids)
234    C     useAreaViscLength :: Set to true to use old scaling for viscous
235    C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.
236    C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
237  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
238  C     implicitFreeSurface :: Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implcit free surface
239  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
# Line 229  C     useJamartWetPoints :: Use wet-poin Line 250  C     useJamartWetPoints :: Use wet-poin
250  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
251  C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny  C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
252  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
253  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
254    C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
255  C     useAbsVorticity :: work with f+zeta in Coriolis terms  C     useAbsVorticity :: work with f+zeta in Coriolis terms
256  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
257  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
# Line 238  C     saltImplVertAdv :: Turns on implic Line 260  C     saltImplVertAdv :: Turns on implic
260  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
261  C     multiDimAdvection :: Flag that enable multi-dimension advection  C     multiDimAdvection :: Flag that enable multi-dimension advection
262  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
263  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution  C     forcing_In_AB     :: if False, put forcing (Temp,Salt,Tracers) contribution
264  C                      out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
265    C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
266    C                          apply AB on tracer tendencies (rather than on Tracer)
267    C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
268  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
269  C                        climatology is required.  C                        climatology is required.
270  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
# Line 265  C                       useSingleCpuIO i Line 290  C                       useSingleCpuIO i
290  C                       outputs from master mpi process only.  C                       outputs from master mpi process only.
291  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
292  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
 C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  
293  C     pickup_write_mdsio :: use mdsio to write pickups  C     pickup_write_mdsio :: use mdsio to write pickups
294  C     pickup_read_mdsio  :: use mdsio to read  pickups  C     pickup_read_mdsio  :: use mdsio to read  pickups
295  C     pickup_write_immed :: echo the pickup immediately (for conversion)  C     pickup_write_immed :: echo the pickup immediately (for conversion)
296  C     timeave_mdsio      :: use mdsio for timeave output  C     timeave_mdsio      :: use mdsio for timeave output
297  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
298  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
299    C     calendarDumps :: When set, approximate months (30-31 days) and years (360-372 days)
300    C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,
301    C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact
302    C                      calendar months and years.  Requires pkg/cal.
303    C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
304    C                        & Last iteration, in addition multiple of dumpFreq iter.
305        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
306       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
307       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
308       & staggerTimeStep,       & staggerTimeStep,
309       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
310       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
311       & tempDiffusion, tempAdvection, tempForcing,       & tempAdvection, tempForcing,
312       & saltDiffusion, saltAdvection, saltForcing,       & saltAdvection, saltForcing,
313       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
314         & useFullLeith, useStrainTensionVisc,
315         & useAreaViscLength,
316       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
317       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
318       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
# Line 288  C     monitor_stdio      :: use stdio fo Line 320  C     monitor_stdio      :: use stdio fo
320       & useCDscheme,       & useCDscheme,
321       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
322       & SadournyCoriolis, upwindVorticity, highOrderVorticity,       & SadournyCoriolis, upwindVorticity, highOrderVorticity,
323       & useAbsVorticity,       & useAbsVorticity, upwindShear,
324       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
325       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
326       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,       & multiDimAdvection, useMultiDimAdvec,
327         & forcing_In_AB, doAB_onGtGs,
328       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
329       & periodicExternalForcing,       & periodicExternalForcing,
330       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
331       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
332       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
333       & allowFreezing, useOldFreezing, groundAtK1,       & allowFreezing, useOldFreezing,
334       & usePickupBeforeC35, usePickupBeforeC54, debugMode,       & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,
      & readPickupWithTracer, writePickupWithTracer,  
335       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
336       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
337       & outputTypesInclusive       & outputTypesInclusive, dumpInitAndLast, debugMode,
338         & inAdMode, inAdTrue, inAdFalse, inAdExact,
339         & calendarDumps
340    
341        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
342        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
# Line 319  C     monitor_stdio      :: use stdio fo Line 353  C     monitor_stdio      :: use stdio fo
353        LOGICAL momPressureForcing        LOGICAL momPressureForcing
354        LOGICAL useCoriolis        LOGICAL useCoriolis
355        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
       LOGICAL tempDiffusion  
356        LOGICAL tempAdvection        LOGICAL tempAdvection
357        LOGICAL tempForcing        LOGICAL tempForcing
       LOGICAL saltDiffusion  
358        LOGICAL saltAdvection        LOGICAL saltAdvection
359        LOGICAL saltForcing        LOGICAL saltForcing
360        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
361          LOGICAL useFullLeith
362          LOGICAL useStrainTensionVisc
363          LOGICAL useAreaViscLength
364        LOGICAL rigidLid        LOGICAL rigidLid
365        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
366        LOGICAL exactConserv        LOGICAL exactConserv
# Line 345  C     monitor_stdio      :: use stdio fo Line 380  C     monitor_stdio      :: use stdio fo
380        LOGICAL upwindVorticity        LOGICAL upwindVorticity
381        LOGICAL highOrderVorticity        LOGICAL highOrderVorticity
382        LOGICAL useAbsVorticity        LOGICAL useAbsVorticity
383          LOGICAL upwindShear
384        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
385        LOGICAL implicitViscosity        LOGICAL implicitViscosity
386        LOGICAL tempImplVertAdv        LOGICAL tempImplVertAdv
# Line 353  C     monitor_stdio      :: use stdio fo Line 389  C     monitor_stdio      :: use stdio fo
389        LOGICAL multiDimAdvection        LOGICAL multiDimAdvection
390        LOGICAL useMultiDimAdvec        LOGICAL useMultiDimAdvec
391        LOGICAL forcing_In_AB        LOGICAL forcing_In_AB
392          LOGICAL doAB_onGtGs
393        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
394        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
395        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
# Line 369  C     monitor_stdio      :: use stdio fo Line 406  C     monitor_stdio      :: use stdio fo
406        LOGICAL useSingleCpuIO        LOGICAL useSingleCpuIO
407        LOGICAL allowFreezing        LOGICAL allowFreezing
408        LOGICAL useOldFreezing        LOGICAL useOldFreezing
       LOGICAL groundAtK1  
409        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
410        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
411          LOGICAL startFromPickupAB2
412          LOGICAL dumpInitAndLast
413        LOGICAL debugMode        LOGICAL debugMode
       LOGICAL readPickupWithTracer  
       LOGICAL writePickupWithTracer  
414        LOGICAL pickup_read_mdsio, pickup_write_mdsio        LOGICAL pickup_read_mdsio, pickup_write_mdsio
415        LOGICAL pickup_write_immed        LOGICAL pickup_write_immed
416        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
417        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
418          LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
419          LOGICAL calendarDumps
420    
421  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
422  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 413  C     rhoConst  :: Vertically constant r Line 451  C     rhoConst  :: Vertically constant r
451  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
452  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
453  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
 C     startTime :: Start time for model ( s )  
454  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
455  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
456  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
# Line 434  C     viscAr    :: Eddy viscosity coeff. Line 471  C     viscAr    :: Eddy viscosity coeff.
471  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
472  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
473  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
474    C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical
475    C                 momentum laterally, no effect for hydrostatic
476    C                 model, defaults to viscA4 if unset ( m^2/s )
477  C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally
478  C                  (act on Divergence part) ( m^2/s )  C                  (act on Divergence part) ( m^2/s )
479  C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally
# Line 442  C     viscA4D   :: Biharmonic viscosity Line 482  C     viscA4D   :: Biharmonic viscosity
482  C                  (act on Divergence part) ( m^4/s )  C                  (act on Divergence part) ( m^4/s )
483  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
484  C                  (act on Vorticity  part) ( m^4/s )  C                  (act on Vorticity  part) ( m^4/s )
485  C     viscC2leith :: Leith non-dimensional viscosity factor  C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))
486    C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
487    C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor (harmonic)
488    C     viscC4smag  :: Smagorinsky non-dimensional viscosity factor (biharmonic)
489  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
490  C                 momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
491    C     viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity
492    C                   coeff. for mixing of momentum laterally (non-dim)
493    C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
494    C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
495  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
496  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
497    C     viscA4ReMax :: Maximum Gridscale Reynolds number for
498    C                  biharmonic viscosity coeff. momentum laterally (non-dim)
499  C     viscAhGrid:: non-dimensional grid-size dependent viscosity  C     viscAhGrid:: non-dimensional grid-size dependent viscosity
500  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
501  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
502  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
503  C     viscC4leith :: Leith non-dimensional viscosity factor  C     viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))
504    C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
505  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
506  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
507  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
# Line 476  C                    it will be the deep Line 526  C                    it will be the deep
526  C                    Frequency of checkpointing and dumping of the model state  C                    Frequency of checkpointing and dumping of the model state
527  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
528  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
529  C     deltaTtracer :: Timestep for tracer equations ( s )  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
530  C     deltaTfreesurf :: Timestep for free-surface equation ( s )  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
531  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
532  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
533  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
534    C     abEps        :: Adams-Bashforth-2 stabilizing weight
535    C     alph_AB      :: Adams-Bashforth-3 primary factor
536    C     beta_AB      :: Adams-Bashforth-3 secondary factor
537  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
538  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
539  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
# Line 493  C     hFacInf      :: Threshold (inf and Line 546  C     hFacInf      :: Threshold (inf and
546  C     hFacSup        that control vanishing and creating levels  C     hFacSup        that control vanishing and creating levels
547  C     tauCD        :: CD scheme coupling timescale ( 1/s )  C     tauCD        :: CD scheme coupling timescale ( 1/s )
548  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
549    C     baseTime      :: model base time (time origin) = time @ iteration zero
550  C     startTime     :: Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
551  C     endTime       :: Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
552  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
# Line 516  C     tave_lastIter :: (for state variab Line 570  C     tave_lastIter :: (for state variab
570  C                      step (of each taveFreq period) put in the time average.  C                      step (of each taveFreq period) put in the time average.
571  C                      (fraction for 1rst iter = 1 - tave_lastIter)  C                      (fraction for 1rst iter = 1 - tave_lastIter)
572  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
 C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).  
573  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
 C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).  
574  C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,  C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
575  C                         i.e. where |yC| <= latBandClimRelax  C                         i.e. where |yC| <= latBandClimRelax
576  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
# Line 529  C     convertFW2Salt :: salinity, used t Line 581  C     convertFW2Salt :: salinity, used t
581  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
582  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
583  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
 C     trac_EvPrRn :: tracer concentration in Rain & Evap.  
584  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
585  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
586  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
# Line 538  C     recip_horiVertRatio  ( 1 if horiz Line 589  C     recip_horiVertRatio  ( 1 if horiz
589  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
590  C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as  C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as
591  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
592    C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
593    C                           (default=2: full drag ; =1: gives half-slip BC)
594  C     bottomDragLinear   :: Drag coefficient built in to core dynamics  C     bottomDragLinear   :: Drag coefficient built in to core dynamics
595  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )  C     bottomDragQuadratic   ( linear: 1/s, quadratic: 1/m )
596    C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
597    C                      (i.e. allows convection at different Rayleigh numbers)
598        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
599       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
600       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
601       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
602       & abeps, startTime,       & abEps, alph_AB, beta_AB,
603       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
604       & fCori, fCoriG, fCoriCos,       & viscAh, viscAhW, viscAhMax,
605       & viscAh, viscAhW, viscAhMax, viscAhGrid, viscC2leith,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
606         & viscC2leith, viscC2leithD,
607         & viscC2smag, viscC4smag,
608       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
609       & viscA4,  viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4, viscA4W,
610       & viscC4leith, viscAr, viscAstrain, viscAtension,       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
611         & viscAhRemax, viscA4Remax,
612         & viscC4leith, viscC4leithD, viscAr,
613       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
614       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
615       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
# Line 559  C      --"-"--  Quadratic  ( linear: 1/s Line 618  C      --"-"--  Quadratic  ( linear: 1/s
618       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
619       & recip_rhoConst, rhoConst,       & recip_rhoConst, rhoConst,
620       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
621       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,       & baseTime, startTime, endTime,
622       & diagFreq, taveFreq, tave_lastIter, monitorFreq,       & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
623         & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
624       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
625       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
626       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax,
627       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax,
628       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
629       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
630       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
631       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
632       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
633       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
634       & bottomDragLinear,bottomDragQuadratic,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
635       & tCyl       & tCylIn, tCylOut
636    
637        _RL cg2dTargetResidual        _RL cg2dTargetResidual
638        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
# Line 585  C      --"-"--  Quadratic  ( linear: 1/s Line 645  C      --"-"--  Quadratic  ( linear: 1/s
645        _RL deltaT        _RL deltaT
646        _RL deltaTClock        _RL deltaTClock
647        _RL deltaTmom        _RL deltaTmom
648        _RL deltaTtracer        _RL dTtracerLev(Nr)
649        _RL deltaTfreesurf        _RL deltaTfreesurf
650        _RL abeps        _RL abEps, alph_AB, beta_AB
651        _RL phiMin        _RL phiMin
652        _RL thetaMin        _RL thetaMin
653        _RL rSphere        _RL rSphere
# Line 608  C      --"-"--  Quadratic  ( linear: 1/s Line 668  C      --"-"--  Quadratic  ( linear: 1/s
668        _RL viscAhD        _RL viscAhD
669        _RL viscAhZ        _RL viscAhZ
670        _RL viscAhMax        _RL viscAhMax
671          _RL viscAhReMax
672        _RL viscAhGrid        _RL viscAhGrid
673          _RL viscAhGridMax
674          _RL viscAhGridMin
675        _RL viscC2leith        _RL viscC2leith
676        _RL viscAstrain        _RL viscC2leithD
677        _RL viscAtension        _RL viscC2smag
678          _RL viscC4smag
679        _RL viscAr        _RL viscAr
680        _RL viscA4        _RL viscA4
681          _RL viscA4W
682        _RL viscA4D        _RL viscA4D
683        _RL viscA4Z        _RL viscA4Z
684        _RL viscA4Max        _RL viscA4Max
685          _RL viscA4ReMax
686        _RL viscA4Grid, viscA4GridMax, viscA4GridMin        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
687        _RL viscC4leith        _RL viscC4leith
688          _RL viscC4leithD
689        _RL diffKhT        _RL diffKhT
690        _RL diffKrNrT(Nr)        _RL diffKrNrT(Nr)
691        _RL diffK4T        _RL diffK4T
# Line 643  C      --"-"--  Quadratic  ( linear: 1/s Line 710  C      --"-"--  Quadratic  ( linear: 1/s
710        _RL convertEmP2rUnit        _RL convertEmP2rUnit
711        _RL tRef(Nr)        _RL tRef(Nr)
712        _RL sRef(Nr)        _RL sRef(Nr)
713        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL baseTime
       _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  
       _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  
714        _RL startTime        _RL startTime
715        _RL endTime        _RL endTime
716        _RL chkPtFreq        _RL chkPtFreq
# Line 656  C      --"-"--  Quadratic  ( linear: 1/s Line 721  C      --"-"--  Quadratic  ( linear: 1/s
721        _RL taveFreq        _RL taveFreq
722        _RL tave_lastIter        _RL tave_lastIter
723        _RL monitorFreq        _RL monitorFreq
724          _RL adjMonitorFreq
725        _RL afFacMom        _RL afFacMom
726        _RL vfFacMom        _RL vfFacMom
727        _RL pfFacMom        _RL pfFacMom
# Line 667  C      --"-"--  Quadratic  ( linear: 1/s Line 733  C      --"-"--  Quadratic  ( linear: 1/s
733        _RL omega        _RL omega
734        _RL rotationPeriod        _RL rotationPeriod
735        _RL tauThetaClimRelax        _RL tauThetaClimRelax
       _RL lambdaThetaClimRelax  
736        _RL tauSaltClimRelax        _RL tauSaltClimRelax
       _RL lambdaSaltClimRelax  
737        _RL tauTr1ClimRelax        _RL tauTr1ClimRelax
738        _RL lambdaTr1ClimRelax        _RL lambdaTr1ClimRelax
739        _RL latBandClimRelax        _RL latBandClimRelax
# Line 678  C      --"-"--  Quadratic  ( linear: 1/s Line 742  C      --"-"--  Quadratic  ( linear: 1/s
742        _RL convertFW2Salt        _RL convertFW2Salt
743        _RL temp_EvPrRn        _RL temp_EvPrRn
744        _RL salt_EvPrRn        _RL salt_EvPrRn
       _RL trac_EvPrRn  
745        _RL horiVertRatio        _RL horiVertRatio
746        _RL recip_horiVertRatio        _RL recip_horiVertRatio
747        _RL ivdc_kappa        _RL ivdc_kappa
748        _RL Ro_SeaLevel        _RL Ro_SeaLevel
749          _RL sideDragFactor
750        _RL bottomDragLinear        _RL bottomDragLinear
751        _RL bottomDragQuadratic        _RL bottomDragQuadratic
752        _RL tCyl        _RL nh_Am2
753          _RL tCylIn
754          _RL tCylOut
755    
756  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
757        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
# Line 728  C Logical flags for selecting packages Line 794  C Logical flags for selecting packages
794        LOGICAL useZONAL_FILT        LOGICAL useZONAL_FILT
795        LOGICAL useFLT        LOGICAL useFLT
796        LOGICAL usePTRACERS        LOGICAL usePTRACERS
797          LOGICAL useGCHEM
798        LOGICAL useSBO        LOGICAL useSBO
799        LOGICAL useSEAICE        LOGICAL useSEAICE
800        LOGICAL useBulkForce        LOGICAL useBulkForce
# Line 737  C Logical flags for selecting packages Line 804  C Logical flags for selecting packages
804        LOGICAL usediagnostics        LOGICAL usediagnostics
805        LOGICAL useEBM        LOGICAL useEBM
806        LOGICAL useMNC        LOGICAL useMNC
807          LOGICAL useMATRIX
808          LOGICAL useRunClock
809        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
810       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
811       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
812       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,       &        usePTRACERS, useGCHEM,
813       &        usefizhi,  usegridalt, usediagnostics, useEBM, useMNC,       &        useSBO, useSEAICE, useThSIce, useBulkForce,
814       &        usePP81, useMY82, useOPPS, useGGL90       &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,
815         &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,
816         &        useRunClock
817    
818  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
819  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
Legend:
Removed from v.1.136  
changed lines
  Added in v.1.170
  ViewVC Help
Powered by ViewVC 1.1.22