/[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.259 by dimitri, Fri Mar 2 01:45:22 2012 UTC revision 1.271 by jmc, Sun Aug 11 14:27:37 2013 UTC
# Line 14  C     here. Notes describing the paramet Line 14  C     here. Notes describing the paramet
14    
15  CEOP  CEOP
16    
 C     Macros for special grid options  
 #include "PARAMS_MACROS.h"  
   
17  C--   Contants  C--   Contants
18  C     Useful physical values  C     Useful physical values
19        Real*8 PI        Real*8 PI
# Line 64  C     viscA4Zfile     :: File containing Line 61  C     viscA4Zfile     :: File containing
61  C     zonalWindFile   :: File containing zonal wind data  C     zonalWindFile   :: File containing zonal wind data
62  C     meridWindFile   :: File containing meridional wind data  C     meridWindFile   :: File containing meridional wind data
63  C     thetaClimFile   :: File containing surface theta climataology used  C     thetaClimFile   :: File containing surface theta climataology used
64  C                       in relaxation term -lambda(theta-theta*)  C                        in relaxation term -lambda(theta-theta*)
65  C     saltClimFile    :: File containing surface salt climataology used  C     saltClimFile    :: File containing surface salt climataology used
66  C                       in relaxation term -lambda(salt-salt*)  C                        in relaxation term -lambda(salt-salt*)
67  C     surfQfile       :: File containing surface heat flux, excluding SW  C     surfQfile       :: File containing surface heat flux, excluding SW
68  C                        (old version, kept for backward compatibility)  C                        (old version, kept for backward compatibility)
69  C     surfQnetFile    :: File containing surface net heat flux  C     surfQnetFile    :: File containing surface net heat flux
70  C     surfQswFile     :: File containing surface shortwave radiation  C     surfQswFile     :: File containing surface shortwave radiation
 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           NOTE: for backward compatibility EmPmRfile is specified in  C           NOTE: for backward compatibility EmPmRfile is specified in
73  C                 m/s when using external_fields_load.F.  It is converted  C                 m/s when using external_fields_load.F.  It is converted
74  C                 to kg/m2/s by multiplying by rhoConstFresh.  C                 to kg/m2/s by multiplying by rhoConstFresh.
75  C     saltFluxFile    :: File containing surface salt flux  C     saltFluxFile    :: File containing surface salt flux
76  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
77    C     addMassFile     :: File containing source/sink of fluid in the interior
78  C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data  C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data
79  C     eddyPsiYFile    :: File containing meridional Eddy streamfunction data  C     eddyPsiYFile    :: File containing meridional Eddy streamfunction data
80  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
# Line 97  C     the_run_name    :: string identify Line 94  C     the_run_name    :: string identify
94       &                surfQfile, surfQnetFile, surfQswFile,       &                surfQfile, surfQnetFile, surfQswFile,
95       &                lambdaThetaFile, lambdaSaltFile,       &                lambdaThetaFile, lambdaSaltFile,
96       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
97       &                dQdTfile, ploadFile,       &                pLoadFile, addMassFile,
98       &                eddyPsiXFile, eddyPsiYFile,       &                eddyPsiXFile, eddyPsiYFile,
99       &                the_run_name       &                the_run_name
100        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
# Line 133  C     the_run_name    :: string identify Line 130  C     the_run_name    :: string identify
130        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
131        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
132        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
133        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) pLoadFile
134        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) addMassFile
135        CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile
136        CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile
137        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
# Line 143  C     the_run_name    :: string identify Line 140  C     the_run_name    :: string identify
140    
141  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
142  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
143  C                           two-dimensional con. grad solver.  C                            two-dimensional con. grad solver.
144  C     cg2dChkResFreq      :: Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
145  C                           in con. grad solver.  C                            in con. grad solver.
146  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
147  C                            (non-linear free-surf.)  C                            (non-linear free-surf.)
148    C     cg2dUseMinResSol    :: =0 : use last-iteration/converged solution
149    C                            =1 : use solver minimum-residual solution
150  C     cg3dMaxIters        :: Maximum number of iterations in the  C     cg3dMaxIters        :: Maximum number of iterations in the
151  C                           three-dimensional con. grad solver.  C                            three-dimensional con. grad solver.
152  C     cg3dChkResFreq      :: Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
153  C                           in con. grad solver.  C                            in con. grad solver.
154  C     printResidualFreq   :: Frequency for printing residual in CG iterations  C     printResidualFreq   :: Frequency for printing residual in CG iterations
155  C     nIter0              :: Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
156  C     nTimeSteps          :: Number of timesteps to execute  C     nTimeSteps          :: Number of timesteps to execute
# Line 174  C     selectAddFluid      :: option to a Line 173  C     selectAddFluid      :: option to a
173  C                            (3-D generalisation of oceanic real-fresh water flux)  C                            (3-D generalisation of oceanic real-fresh water flux)
174  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
175  C     momForcingOutAB     :: =1: take momentum forcing contribution  C     momForcingOutAB     :: =1: take momentum forcing contribution
176  C                           out of (=0: in) Adams-Bashforth time stepping.  C                            out of (=0: in) Adams-Bashforth time stepping.
177  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
178  C                           out of (=0: in) Adams-Bashforth time stepping.  C                            out of (=0: in) Adams-Bashforth time stepping.
179  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
180  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
181  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
# Line 189  C-    debugLevel          :: controls pr Line 188  C-    debugLevel          :: controls pr
188  C                            and statistics ; higher -> more writing  C                            and statistics ; higher -> more writing
189    
190        COMMON /PARM_I/        COMMON /PARM_I/
191       &        cg2dMaxIters, cg2dChkResFreq, cg2dPreCondFreq,       &        cg2dMaxIters, cg2dChkResFreq,
192         &        cg2dPreCondFreq, cg2dUseMinResSol,
193       &        cg3dMaxIters, cg3dChkResFreq,       &        cg3dMaxIters, cg3dChkResFreq,
194       &        printResidualFreq,       &        printResidualFreq,
195       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
# Line 208  C                            and statist Line 208  C                            and statist
208        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
209        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
210        INTEGER cg2dPreCondFreq        INTEGER cg2dPreCondFreq
211          INTEGER cg2dUseMinResSol
212        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
213        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
214        INTEGER printResidualFreq        INTEGER printResidualFreq
# Line 234  C                            and statist Line 235  C                            and statist
235  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
236  C- Coordinate + Grid params:  C- Coordinate + Grid params:
237  C     fluidIsAir       :: Set to indicate that the fluid major constituent  C     fluidIsAir       :: Set to indicate that the fluid major constituent
238  C                        is air  C                         is air
239  C     fluidIsWater     :: Set to indicate that the fluid major constituent  C     fluidIsWater     :: Set to indicate that the fluid major constituent
240  C                        is water  C                         is water
241  C     usingPCoords     :: Set to indicate that we are working in a pressure  C     usingPCoords     :: Set to indicate that we are working in a pressure
242  C                        type coordinate (p or p*).  C                         type coordinate (p or p*).
243  C     usingZCoords     :: Set to indicate that we are working in a height  C     usingZCoords     :: Set to indicate that we are working in a height
244  C                        type coordinate (z or z*)  C                         type coordinate (z or z*)
245  C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)  C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
246  C                         this requires specific code for restart & exchange  C                         this requires specific code for restart & exchange
247  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
248  C                          coordinate frame.  C                           coordinate frame.
249  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
250  C                               spherical polar frame.  C                                spherical polar frame.
251  C     rotateGrid      :: rotate grid coordinates to geographical coordinates  C     rotateGrid      :: rotate grid coordinates to geographical coordinates
252  C                        according to Euler angles phiEuler, thetaEuler, psiEuler  C                        according to Euler angles phiEuler, thetaEuler, psiEuler
 C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)  
253  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
254    C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
255    C     hasWetCSCorners :: domain contains CS-type corners where dynamics is solved
256  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
257  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
258  C     setCenterDr    :: set cell-Center depth (put Interface at the middle)  C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
259  C- Momentum params:  C- Momentum params:
260  C     no_slip_sides  :: Impose "no-slip" at lateral boundaries.  C     no_slip_sides  :: Impose "no-slip" at lateral boundaries.
261  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
262    C     useSmag3D      :: Use isotropic 3-D Smagorinsky
263  C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable  C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
264  C                       on irregular grids)  C                       on irregular grids)
265  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
# Line 284  C     upwindShear        :: use 1rst ord Line 287  C     upwindShear        :: use 1rst ord
287  C     momStepping    :: Turns momentum equation time-stepping off  C     momStepping    :: Turns momentum equation time-stepping off
288  C     calc_wVelocity :: Turns of vertical velocity calculation off  C     calc_wVelocity :: Turns of vertical velocity calculation off
289  C- Temp. & Salt params:  C- Temp. & Salt params:
290  C     tempStepping   :: Turns temperature equation time-stepping off  C     tempStepping   :: Turns temperature equation time-stepping on/off
291  C     saltStepping   :: Turns salinity equation time-stepping off  C     saltStepping   :: Turns salinity equation time-stepping on/off
292    C     addFrictionHeating :: account for frictional heating
293  C     tempAdvection  :: Flag which turns advection of temperature on and off.  C     tempAdvection  :: Flag which turns advection of temperature on and off.
294    C     tempVertDiff4  :: use vertical bi-harmonic diffusion for temperature
295  C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer  C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
296  C     tempForcing    :: Flag which turns external forcing of temperature on  C     tempForcing    :: Flag which turns external forcing of temperature on/off
 C                       and off.  
297  C     saltAdvection  :: Flag which turns advection of salinity on and off.  C     saltAdvection  :: Flag which turns advection of salinity on and off.
298    C     saltVertDiff4  :: use vertical bi-harmonic diffusion for salinity
299  C     saltIsActiveTr :: Salinity  is a dynamically active tracer  C     saltIsActiveTr :: Salinity  is a dynamically active tracer
300  C     saltForcing    :: Flag which turns external forcing of salinity on  C     saltForcing    :: Flag which turns external forcing of salinity on/off
 C                       and off.  
301  C     maskIniTemp    :: apply mask to initial Pot.Temp.  C     maskIniTemp    :: apply mask to initial Pot.Temp.
302  C     maskIniSalt    :: apply mask to initial salinity  C     maskIniSalt    :: apply mask to initial salinity
303  C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.  C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
304  C     checkIniSalt   :: check for points with identically zero initial salinity  C     checkIniSalt   :: check for points with identically zero initial salinity
 C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  
 C                         as a real Fresh Water (=> changes the Sea Level)  
 C                         if F, converts P+R-E to salt flux (no SL effect)  
305  C- Pressure solver related parameters (PARM02)  C- Pressure solver related parameters (PARM02)
306  C     useSRCGSolver  :: Set to true to use conjugate gradient  C     useSRCGSolver  :: Set to true to use conjugate gradient
307  C                       solver with single reduction (only one call of  C                       solver with single reduction (only one call of
308  C                       s/r mpi_allreduce), default is false  C                       s/r mpi_allreduce), default is false
309  C- Time-stepping params:  C- Time-stepping & free-surface params:
310  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
311  C     implicitFreeSurface :: Set to true to use implicit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
312    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
313    C                            linear relation Phi_surf = Bo_surf*eta
314    C     uniformFreeSurfLev  :: TRUE if free-surface level-index is uniform (=1)
315  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
316  C     linFSConserveTr     :: Set to true to correct source/sink of tracer  C     linFSConserveTr     :: Set to true to correct source/sink of tracer
317  C                            at the surface due to Linear Free Surface  C                            at the surface due to Linear Free Surface
318  C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
319  C                            linear relation Phi_surf = Bo_surf*eta  C                         as a real Fresh Water (=> changes the Sea Level)
320    C                         if F, converts P+R-E to salt flux (no SL effect)
321  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
322  C     nonHydrostatic   :: Using non-hydrostatic algorithm  C     nonHydrostatic   :: Using non-hydrostatic algorithm
323  C     use3Dsolver      :: set to true to use 3-D pressure solver  C     use3Dsolver      :: set to true to use 3-D pressure solver
# Line 338  C     doThetaClimRelax :: Set true if re Line 343  C     doThetaClimRelax :: Set true if re
343  C                        climatology is required.  C                        climatology is required.
344  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
345  C                        climatology is required.  C                        climatology is required.
346    C     balanceThetaClimRelax :: substract global mean effect at every time step
347    C     balanceSaltClimRelax :: substract global mean effect at every time step
348  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
349  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
350  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
# Line 365  C     printDomain     :: controls printi Line 372  C     printDomain     :: controls printi
372       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
373       & usingPCoords, usingZCoords, useDynP_inEos_Zc,       & usingPCoords, usingZCoords, useDynP_inEos_Zc,
374       & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,       & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
375       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCylindricalGrid, usingCurvilinearGrid, hasWetCSCorners,
376       & deepAtmosphere, setInterFDr, setCenterDr,       & deepAtmosphere, setInterFDr, setCenterDr,
377       & no_slip_sides, no_slip_bottom,       & no_slip_sides, no_slip_bottom, useSmag3D,
378       & useFullLeith, useStrainTensionVisc, useAreaViscLength,       & useFullLeith, useStrainTensionVisc, useAreaViscLength,
379       & momViscosity, momAdvection, momForcing,       & momViscosity, momAdvection, momForcing,
380       & momPressureForcing, metricTerms, useNHMTerms,       & momPressureForcing, metricTerms, useNHMTerms,
# Line 377  C     printDomain     :: controls printi Line 384  C     printDomain     :: controls printi
384       & upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
385       & useAbsVorticity, upwindShear,       & useAbsVorticity, upwindShear,
386       & momStepping, calc_wVelocity, tempStepping, saltStepping,       & momStepping, calc_wVelocity, tempStepping, saltStepping,
387       & tempAdvection, tempIsActiveTr, tempForcing,       & addFrictionHeating,
388       & saltAdvection, saltIsActiveTr, saltForcing,       & tempAdvection, tempVertDiff4, tempIsActiveTr, tempForcing,
389         & saltAdvection, saltVertDiff4, saltIsActiveTr, saltForcing,
390       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
391       & useRealFreshWaterFlux, useSRCGSolver,       & useSRCGSolver,
392       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface,
393       & uniformLin_PhiSurf,       & uniformLin_PhiSurf, uniformFreeSurfLev,
394         & exactConserv, linFSConserveTr, useRealFreshWaterFlux,
395       & quasiHydrostatic, nonHydrostatic, use3Dsolver,       & quasiHydrostatic, nonHydrostatic, use3Dsolver,
396       & implicitIntGravWave, staggerTimeStep, doResetHFactors,       & implicitIntGravWave, staggerTimeStep, doResetHFactors,
397       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
# Line 390  C     printDomain     :: controls printi Line 399  C     printDomain     :: controls printi
399       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
400       & momDissip_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
401       & balanceEmPmR, balanceQnet, balancePrintMean,       & balanceEmPmR, balanceQnet, balancePrintMean,
402         & balanceThetaClimRelax, balanceSaltClimRelax,
403       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
404       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
405       & periodicExternalForcing,       & periodicExternalForcing,
# Line 399  C     printDomain     :: controls printi Line 409  C     printDomain     :: controls printi
409       & writePickupAtEnd,       & writePickupAtEnd,
410       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
411       & outputTypesInclusive, dumpInitAndLast,       & outputTypesInclusive, dumpInitAndLast,
412       & printDomain,       & printDomain
      & inAdMode, inAdTrue, inAdFalse, inAdExact  
413    
414        LOGICAL fluidIsAir        LOGICAL fluidIsAir
415        LOGICAL fluidIsWater        LOGICAL fluidIsWater
# Line 410  C     printDomain     :: controls printi Line 419  C     printDomain     :: controls printi
419        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
420        LOGICAL usingSphericalPolarGrid, rotateGrid        LOGICAL usingSphericalPolarGrid, rotateGrid
421        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
422        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid, hasWetCSCorners
423        LOGICAL deepAtmosphere        LOGICAL deepAtmosphere
424        LOGICAL setInterFDr        LOGICAL setInterFDr
425        LOGICAL setCenterDr        LOGICAL setCenterDr
426        LOGICAL useNHMTerms  
427        LOGICAL no_slip_sides        LOGICAL no_slip_sides
428        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
429          LOGICAL useSmag3D
430        LOGICAL useFullLeith        LOGICAL useFullLeith
431        LOGICAL useStrainTensionVisc        LOGICAL useStrainTensionVisc
432        LOGICAL useAreaViscLength        LOGICAL useAreaViscLength
# Line 424  C     printDomain     :: controls printi Line 434  C     printDomain     :: controls printi
434        LOGICAL momAdvection        LOGICAL momAdvection
435        LOGICAL momForcing        LOGICAL momForcing
436        LOGICAL momPressureForcing        LOGICAL momPressureForcing
437          LOGICAL metricTerms
438          LOGICAL useNHMTerms
439    
440        LOGICAL useCoriolis        LOGICAL useCoriolis
441          LOGICAL use3dCoriolis
442          LOGICAL useCDscheme
443        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
444          LOGICAL useEnergyConservingCoriolis
445          LOGICAL useJamartWetPoints
446          LOGICAL useJamartMomAdv
447          LOGICAL upwindVorticity
448          LOGICAL highOrderVorticity
449          LOGICAL useAbsVorticity
450          LOGICAL upwindShear
451          LOGICAL momStepping
452          LOGICAL calc_wVelocity
453          LOGICAL tempStepping
454          LOGICAL saltStepping
455          LOGICAL addFrictionHeating
456        LOGICAL tempAdvection        LOGICAL tempAdvection
457          LOGICAL tempVertDiff4
458        LOGICAL tempIsActiveTr        LOGICAL tempIsActiveTr
459        LOGICAL tempForcing        LOGICAL tempForcing
460        LOGICAL saltAdvection        LOGICAL saltAdvection
461          LOGICAL saltVertDiff4
462        LOGICAL saltIsActiveTr        LOGICAL saltIsActiveTr
463        LOGICAL saltForcing        LOGICAL saltForcing
464        LOGICAL maskIniTemp        LOGICAL maskIniTemp
465        LOGICAL maskIniSalt        LOGICAL maskIniSalt
466        LOGICAL checkIniTemp        LOGICAL checkIniTemp
467        LOGICAL checkIniSalt        LOGICAL checkIniSalt
       LOGICAL useRealFreshWaterFlux  
468        LOGICAL useSRCGSolver        LOGICAL useSRCGSolver
469        LOGICAL rigidLid        LOGICAL rigidLid
470        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
471          LOGICAL uniformLin_PhiSurf
472          LOGICAL uniformFreeSurfLev
473        LOGICAL exactConserv        LOGICAL exactConserv
474        LOGICAL linFSConserveTr        LOGICAL linFSConserveTr
475        LOGICAL uniformLin_PhiSurf        LOGICAL useRealFreshWaterFlux
476        LOGICAL quasiHydrostatic        LOGICAL quasiHydrostatic
477        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
478        LOGICAL use3Dsolver        LOGICAL use3Dsolver
479        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
480        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
481        LOGICAL doResetHFactors        LOGICAL doResetHFactors
       LOGICAL momStepping  
       LOGICAL calc_wVelocity  
       LOGICAL tempStepping  
       LOGICAL saltStepping  
       LOGICAL metricTerms  
       LOGICAL use3dCoriolis  
       LOGICAL useCDscheme  
       LOGICAL useEnergyConservingCoriolis  
       LOGICAL useJamartWetPoints  
       LOGICAL useJamartMomAdv  
       LOGICAL upwindVorticity  
       LOGICAL highOrderVorticity  
       LOGICAL useAbsVorticity  
       LOGICAL upwindShear  
482        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
483        LOGICAL implicitViscosity        LOGICAL implicitViscosity
484        LOGICAL tempImplVertAdv        LOGICAL tempImplVertAdv
# Line 477  C     printDomain     :: controls printi Line 493  C     printDomain     :: controls printi
493        LOGICAL balancePrintMean        LOGICAL balancePrintMean
494        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
495        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
496          LOGICAL balanceThetaClimRelax
497          LOGICAL balanceSaltClimRelax
498        LOGICAL allowFreezing        LOGICAL allowFreezing
499        LOGICAL useOldFreezing        LOGICAL useOldFreezing
500        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
# Line 490  C     printDomain     :: controls printi Line 508  C     printDomain     :: controls printi
508        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
509        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
510        LOGICAL printDomain        LOGICAL printDomain
       LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact  
511    
512  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
513  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 567  C     viscAh     :: Eddy viscosity coeff Line 584  C     viscAh     :: Eddy viscosity coeff
584  C                   momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
585  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
586  C                   momentum laterally, no effect for hydrostatic  C                   momentum laterally, no effect for hydrostatic
587  C                   model, defaults to viscAh if unset ( m^2/s )  C                   model, defaults to viscAhD if unset ( m^2/s )
588  C                   Not used if variable horiz. viscosity is used.  C                   Not used if variable horiz. viscosity is used.
589  C     viscA4     :: Biharmonic viscosity coeff. for mixing of  C     viscA4     :: Biharmonic viscosity coeff. for mixing of
590  C                   momentum laterally ( m^4/s )  C                   momentum laterally ( m^4/s )
591  C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical  C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
592  C                   momentum laterally, no effect for hydrostatic  C                   momentum laterally, no effect for hydrostatic
593  C                   model, defaults to viscA4 if unset ( m^2/s )  C                   model, defaults to viscA4D if unset ( m^2/s )
594  C                   Not used if variable horiz. viscosity is used.  C                   Not used if variable horiz. viscosity is used.
595  C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
596  C                   (act on Divergence part) ( m^2/s )  C                   (act on Divergence part) ( m^2/s )
# Line 583  C     viscA4D    :: Biharmonic viscosity Line 600  C     viscA4D    :: Biharmonic viscosity
600  C                   (act on Divergence part) ( m^4/s )  C                   (act on Divergence part) ( m^4/s )
601  C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
602  C                   (act on Vorticity  part) ( m^4/s )  C                   (act on Vorticity  part) ( m^4/s )
603    C     smag3D_coeff :: Isotropic 3-D Smagorinsky coefficient (-)
604  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
605  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
606  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
# Line 605  C     viscA4GridMax:: maximum and minimu Line 623  C     viscA4GridMax:: maximum and minimu
623  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
624  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
625  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
 C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.  
 C                 for mixing of heat vertically ( units of r^2/s )  
626  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
627  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
628    C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
629    C                 for mixing of heat vertically ( units of r^2/s )
630    C     diffKr4T  :: vertical profile of Biharmonic diffusion coeff.
631    C                 for mixing of heat vertically ( units of r^4/s )
632  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
633  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
 C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.  
 C                 for mixing of salt vertically ( units of r^2/s ),  
634  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
635  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
636    C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
637    C                 for mixing of salt vertically ( units of r^2/s ),
638    C     diffKr4S  :: vertical profile of Biharmonic diffusion coeff.
639    C                 for mixing of salt vertically ( units of r^4/s )
640  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
641  C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979  C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
642  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
# Line 634  C                    Frequency of checkp Line 656  C                    Frequency of checkp
656  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
657  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
658  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
659  C     deltaTfreesurf :: Timestep for free-surface equation ( s )  C     deltaTFreeSurf :: Timestep for free-surface equation ( s )
660  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freeSurfFac  :: Parameter to turn implicit free surface term on or off
661  C                    freesurfac = 1. uses implicit free surface  C                     freeSurFac = 1. uses implicit free surface
662  C                    freesurfac = 0. uses rigid lid  C                     freeSurFac = 0. uses rigid lid
663  C     abEps        :: Adams-Bashforth-2 stabilizing weight  C     abEps        :: Adams-Bashforth-2 stabilizing weight
664  C     alph_AB      :: Adams-Bashforth-3 primary factor  C     alph_AB      :: Adams-Bashforth-3 primary factor
665  C     beta_AB      :: Adams-Bashforth-3 secondary factor  C     beta_AB      :: Adams-Bashforth-3 secondary factor
# Line 662  C     endTime       :: Ending time for t Line 684  C     endTime       :: Ending time for t
684  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
685  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
686  C     dumpFreq      :: Frequency with which model state is written to  C     dumpFreq      :: Frequency with which model state is written to
687  C                     post-processing files ( s ).  C                      post-processing files ( s ).
688  C     diagFreq      :: Frequency with which model writes diagnostic output  C     diagFreq      :: Frequency with which model writes diagnostic output
689  C                     of intermediate quantities.  C                      of intermediate quantities.
690  C     afFacMom      :: Advection of momentum term tracer parameter  C     afFacMom      :: Advection of momentum term tracer parameter
691  C     vfFacMom      :: Momentum viscosity tracer parameter  C     vfFacMom      :: Momentum viscosity tracer parameter
692  C     pfFacMom      :: Momentum pressure forcing tracer parameter  C     pfFacMom      :: Momentum pressure forcing tracer parameter
# Line 713  C                           is to be rep Line 735  C                           is to be rep
735  C                           (affects myabs, mymin, mymax)  C                           (affects myabs, mymin, mymax)
736  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
737  C                      (i.e. allows convection at different Rayleigh numbers)  C                      (i.e. allows convection at different Rayleigh numbers)
738    C     tCylIn        :: Temperature of the cylinder inner boundary
739    C     tCylOut       :: Temperature of the cylinder outer boundary
740  C     phiEuler      :: Euler angle, rotation about original z-axis  C     phiEuler      :: Euler angle, rotation about original z-axis
741  C     thetaEuler    :: Euler angle, rotation about new x-axis  C     thetaEuler    :: Euler angle, rotation about new x-axis
742  C     psiEuler      :: Euler angle, rotation about new z-axis  C     psiEuler      :: Euler angle, rotation about new z-axis
743        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
744       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
745       & delR, delRc, xgOrigin, ygOrigin,       & delR, delRc, xgOrigin, ygOrigin,
746       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTMom, dTtracerLev, deltaTFreeSurf, deltaTClock,
747       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
748       & rSphere, recip_rSphere, radius_fromHorizGrid,       & rSphere, recip_rSphere, radius_fromHorizGrid,
749       & f0, beta, fPrime, omega, rotationPeriod,       & f0, beta, fPrime, omega, rotationPeriod,
750       & viscFacAdj, viscAh, viscAhW, viscAhMax,       & viscFacAdj, viscAh, viscAhW, smag3D_coeff,
751       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhMax, viscAhGrid, viscAhGridMax, viscAhGridMin,
752       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
753       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
754       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
# Line 732  C     psiEuler      :: Euler angle, rota Line 756  C     psiEuler      :: Euler angle, rota
756       & viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Grid, viscA4GridMax, viscA4GridMin,
757       & viscAhReMax, viscA4ReMax,       & viscAhReMax, viscA4ReMax,
758       & viscC4leith, viscC4leithD, viscArNr,       & viscC4leith, viscC4leithD, viscArNr,
759       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT, diffKr4T,
760       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS, diffKr4S,
761       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
762       & BL79LatVary,       & BL79LatVary,
763       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
# Line 771  C     psiEuler      :: Euler angle, rota Line 795  C     psiEuler      :: Euler angle, rota
795        _RL ygOrigin        _RL ygOrigin
796        _RL deltaT        _RL deltaT
797        _RL deltaTClock        _RL deltaTClock
798        _RL deltaTmom        _RL deltaTMom
799        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
800        _RL deltaTfreesurf        _RL deltaTFreeSurf
801        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
802        _RL rSphere        _RL rSphere
803        _RL recip_rSphere        _RL recip_rSphere
# Line 799  C     psiEuler      :: Euler angle, rota Line 823  C     psiEuler      :: Euler angle, rota
823        _RL viscAhW        _RL viscAhW
824        _RL viscAhD        _RL viscAhD
825        _RL viscAhZ        _RL viscAhZ
826          _RL smag3D_coeff
827        _RL viscAhMax        _RL viscAhMax
828        _RL viscAhReMax        _RL viscAhReMax
829        _RL viscAhGrid, viscAhGridMax, viscAhGridMin        _RL viscAhGrid, viscAhGridMax, viscAhGridMin
# Line 816  C     psiEuler      :: Euler angle, rota Line 841  C     psiEuler      :: Euler angle, rota
841        _RL viscC4leithD        _RL viscC4leithD
842        _RL viscC4smag        _RL viscC4smag
843        _RL diffKhT        _RL diffKhT
       _RL diffKrNrT(Nr)  
844        _RL diffK4T        _RL diffK4T
845          _RL diffKrNrT(Nr)
846          _RL diffKr4T(Nr)
847        _RL diffKhS        _RL diffKhS
       _RL diffKrNrS(Nr)  
848        _RL diffK4S        _RL diffK4S
849          _RL diffKrNrS(Nr)
850          _RL diffKr4S(Nr)
851        _RL diffKrBL79surf        _RL diffKrBL79surf
852        _RL diffKrBL79deep        _RL diffKrBL79deep
853        _RL diffKrBL79scl        _RL diffKrBL79scl
# Line 887  C     psiEuler      :: Euler angle, rota Line 914  C     psiEuler      :: Euler angle, rota
914        _RL bottomDragQuadratic        _RL bottomDragQuadratic
915        _RL smoothAbsFuncRange        _RL smoothAbsFuncRange
916        _RL nh_Am2        _RL nh_Am2
917        _RL tCylIn        _RL tCylIn, tCylOut
       _RL tCylOut  
918        _RL phiEuler, thetaEuler, psiEuler        _RL phiEuler, thetaEuler, psiEuler
919    
920  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
# Line 936  C Logical flags for selecting packages Line 962  C Logical flags for selecting packages
962        LOGICAL useCheapAML        LOGICAL useCheapAML
963        LOGICAL useGrdchk        LOGICAL useGrdchk
964        LOGICAL useSMOOTH        LOGICAL useSMOOTH
965          LOGICAL usePROFILES
966        LOGICAL useECCO        LOGICAL useECCO
967        LOGICAL useSBO        LOGICAL useSBO
968        LOGICAL useFLT        LOGICAL useFLT
# Line 951  C Logical flags for selecting packages Line 978  C Logical flags for selecting packages
978        LOGICAL useStreamIce        LOGICAL useStreamIce
979        LOGICAL useICEFRONT        LOGICAL useICEFRONT
980        LOGICAL useThSIce        LOGICAL useThSIce
981          LOGICAL useLand
982        LOGICAL useATM2d        LOGICAL useATM2d
983        LOGICAL useAIM        LOGICAL useAIM
984        LOGICAL useLand        LOGICAL useAtm_Phys
985        LOGICAL useFizhi        LOGICAL useFizhi
986        LOGICAL useGridAlt        LOGICAL useGridAlt
987        LOGICAL useDiagnostics        LOGICAL useDiagnostics
# Line 968  C Logical flags for selecting packages Line 996  C Logical flags for selecting packages
996       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
997       &        useGMRedi, useBBL, useDOWN_SLOPE,       &        useGMRedi, useBBL, useDOWN_SLOPE,
998       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
999       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,       &        useGrdchk,useSMOOTH,usePROFILES,useECCO,useSBO, useFLT,
1000       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
1001       &        useFRAZIL, useSEAICE, useSALT_PLUME, useShelfIce,       &        useFRAZIL, useSEAICE, useSALT_PLUME, useShelfIce,
1002       &        useStreamIce, useICEFRONT, useThSIce,       &        useStreamIce, useICEFRONT, useThSIce, useLand,
1003       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,       &        useATM2D, useAIM, useAtm_Phys, useFizhi, useGridAlt,
1004       &        useDiagnostics, useREGRID, useLayers, useMNC,       &        useDiagnostics, useREGRID, useLayers, useMNC,
1005       &        useRunClock, useEMBED_FILES,       &        useRunClock, useEMBED_FILES,
1006       &        useMYPACKAGE       &        useMYPACKAGE
1007    
 C     Logical flags for turning off parts of the code in adjoint mode  
       LOGICAL useKPPinAdMode, useKPPinFwdMode  
       LOGICAL useGMrediInAdMode, useGMrediInFwdMode  
       LOGICAL useSEAICEinAdMode, useSEAICEinFwdMode  
       COMMON /PARM_PACKAGES_ADJ/  
      &       useKPPinAdMode, useKPPinFwdMode,  
      &       useGMrediInAdMode, useGMrediInFwdMode,  
      &       useSEAICEinAdMode, useSEAICEinFwdMode  
   
1008  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
1009  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
1010  CEH3 ;;; End: ***  CEH3 ;;; End: ***
Legend:
Removed from v.1.259  
changed lines
  Added in v.1.271
  ViewVC Help
Powered by ViewVC 1.1.22