/[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.236 by gforget, Wed Feb 17 00:21:32 2010 UTC revision 1.259 by dimitri, Fri Mar 2 01:45:22 2012 UTC
# Line 33  C     pickupSuff      :: force to start Line 33  C     pickupSuff      :: force to start
33  C                        and read pickup files with this suffix (max 10 Char.)  C                        and read pickup files with this suffix (max 10 Char.)
34  C     mdsioLocalDir   :: read-write tiled file from/to this directory name  C     mdsioLocalDir   :: read-write tiled file from/to this directory name
35  C                        (+ 4 digits Processor-Rank) instead of current dir.  C                        (+ 4 digits Processor-Rank) instead of current dir.
36    C     adTapeDir       :: read-write checkpointing tape files from/to this
37    C                        directory name instead of current dir. Conflicts
38    C                        mdsioLocalDir, so only one of the two can be set.
39    C                        In contrast to mdsioLocalDir, if specified adTapeDir
40    C                        must exist before the model starts.
41  C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)  C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
42  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
43  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
44  C     delRFile      :: File containing vertical grid spacing delR  (1.D array)  C     delRFile      :: File containing vertical grid spacing delR  (1.D array)
45  C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)  C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)
46    C     hybSigmFile   :: File containing hybrid-sigma vertical coord. coeff. (2x 1.D)
47  C     delXFile      :: File containing X-spacing grid definition (1.D array)  C     delXFile      :: File containing X-spacing grid definition (1.D array)
48  C     delYFile      :: File containing Y-spacing grid definition (1.D array)  C     delYFile      :: File containing Y-spacing grid definition (1.D array)
49  C     horizGridFile :: File containing horizontal-grid definition  C     horizGridFile :: File containing horizontal-grid definition
# Line 77  C     eddyPsiYFile    :: File containing Line 83  C     eddyPsiYFile    :: File containing
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/        COMMON /PARM_C/
85       &                buoyancyRelation, eosType,       &                buoyancyRelation, eosType,
86       &                pickupSuff, mdsioLocalDir,       &                pickupSuff, mdsioLocalDir, adTapeDir,
87       &                tRefFile, sRefFile, rhoRefFile,       &                tRefFile, sRefFile, rhoRefFile,
88       &                delRFile, delRcFile,       &                delRFile, delRcFile, hybSigmFile,
89       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
90       &                bathyFile, topoFile,       &                bathyFile, topoFile,
91       &                viscAhDfile, viscAhZfile,       &                viscAhDfile, viscAhZfile,
92       &                viscA4Dfile, viscA4Zfile,       &                viscA4Dfile, viscA4Zfile,
93       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
94       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
95       &                saltClimFile,       &                saltClimFile,
# Line 98  C     the_run_name    :: string identify Line 104  C     the_run_name    :: string identify
104        CHARACTER*(6)  eosType        CHARACTER*(6)  eosType
105        CHARACTER*(10) pickupSuff        CHARACTER*(10) pickupSuff
106        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
107          CHARACTER*(MAX_LEN_FNAM) adTapeDir
108        CHARACTER*(MAX_LEN_FNAM) tRefFile        CHARACTER*(MAX_LEN_FNAM) tRefFile
109        CHARACTER*(MAX_LEN_FNAM) sRefFile        CHARACTER*(MAX_LEN_FNAM) sRefFile
110        CHARACTER*(MAX_LEN_FNAM) rhoRefFile        CHARACTER*(MAX_LEN_FNAM) rhoRefFile
111        CHARACTER*(MAX_LEN_FNAM) delRFile        CHARACTER*(MAX_LEN_FNAM) delRFile
112        CHARACTER*(MAX_LEN_FNAM) delRcFile        CHARACTER*(MAX_LEN_FNAM) delRcFile
113          CHARACTER*(MAX_LEN_FNAM) hybSigmFile
114        CHARACTER*(MAX_LEN_FNAM) delXFile        CHARACTER*(MAX_LEN_FNAM) delXFile
115        CHARACTER*(MAX_LEN_FNAM) delYFile        CHARACTER*(MAX_LEN_FNAM) delYFile
116        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
# Line 144  C     cg3dMaxIters        :: Maximum num Line 152  C     cg3dMaxIters        :: Maximum num
152  C                           three-dimensional con. grad solver.  C                           three-dimensional con. grad solver.
153  C     cg3dChkResFreq      :: Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
154  C                           in con. grad solver.  C                           in con. grad solver.
155    C     printResidualFreq   :: Frequency for printing residual in CG iterations
156  C     nIter0              :: Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
157  C     nTimeSteps          :: Number of timesteps to execute  C     nTimeSteps          :: Number of timesteps to execute
158  C     writeStatePrec      :: Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
159  C     writeBinaryPrec     :: Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
160  C     readBinaryPrec      :: Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
161    C     selectCoriMap       :: select setting of Coriolis parameter map:
162    C                           =0 f-Plane (Constant Coriolis, = f0)
163    C                           =1 Beta-Plane Coriolis (= f0 + beta.y)
164    C                           =2 Spherical Coriolis (= 2.omega.sin(phi))
165    C                           =3 Read Coriolis 2-d fields from files.
166    C     selectSigmaCoord    :: option related to sigma vertical coordinate
167  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
168  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
169  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
# Line 170  C     selectKEscheme      :: Kinetic Ene Line 185  C     selectKEscheme      :: Kinetic Ene
185  C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)  C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)
186  C     monitorSelect       :: select group of variables to monitor  C     monitorSelect       :: select group of variables to monitor
187  C                            =1 : dynvars ; =2 : + vort ; =3 : + surface  C                            =1 : dynvars ; =2 : + vort ; =3 : + surface
188  C     debugLevel          :: debug level selector: higher -> more writing  C-    debugLevel          :: controls printing of algorithm intermediate results
189    C                            and statistics ; higher -> more writing
190    
191        COMMON /PARM_I/        COMMON /PARM_I/
192       &        cg2dMaxIters,       &        cg2dMaxIters, cg2dChkResFreq, cg2dPreCondFreq,
193       &        cg2dChkResFreq, cg2dPreCondFreq,       &        cg3dMaxIters, cg3dChkResFreq,
194       &        cg3dMaxIters,       &        printResidualFreq,
      &        cg3dChkResFreq,  
195       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
196       &        writeStatePrec,       &        writeStatePrec,
197       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
198         &        selectCoriMap,
199         &        selectSigmaCoord,
200       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
201       &        selectNHfreeSurf,       &        selectNHfreeSurf,
202       &        selectAddFluid,       &        selectAddFluid,
# Line 193  C     debugLevel          :: debug level Line 210  C     debugLevel          :: debug level
210        INTEGER cg2dPreCondFreq        INTEGER cg2dPreCondFreq
211        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
212        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
213          INTEGER printResidualFreq
214        INTEGER nIter0        INTEGER nIter0
215        INTEGER nTimeSteps        INTEGER nTimeSteps
216        INTEGER nEndIter        INTEGER nEndIter
217        INTEGER writeStatePrec        INTEGER writeStatePrec
218        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
219        INTEGER readBinaryPrec        INTEGER readBinaryPrec
220          INTEGER selectCoriMap
221          INTEGER selectSigmaCoord
222        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
223        INTEGER select_rStar        INTEGER select_rStar
224        INTEGER selectNHfreeSurf        INTEGER selectNHfreeSurf
# Line 252  C     metricTerms   :: Flag which turns Line 272  C     metricTerms   :: Flag which turns
272  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
273  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
274  C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off  C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
 C     useConstantF  :: Coriolis parameter set to f0  
 C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  
 C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  
275  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
276  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
277  C                                (default = F = use mom_fluxform package)  C                                (default = F = use mom_fluxform package)
# Line 265  C     highOrderVorticity :: use 3rd/4th Line 282  C     highOrderVorticity :: use 3rd/4th
282  C     useAbsVorticity :: work with f+zeta in Coriolis terms  C     useAbsVorticity :: work with f+zeta in Coriolis terms
283  C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)  C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
284  C     momStepping    :: Turns momentum equation time-stepping off  C     momStepping    :: Turns momentum equation time-stepping off
285    C     calc_wVelocity :: Turns of vertical velocity calculation off
286  C- Temp. & Salt params:  C- Temp. & Salt params:
287  C     tempStepping   :: Turns temperature equation time-stepping off  C     tempStepping   :: Turns temperature equation time-stepping off
288  C     saltStepping   :: Turns salinity equation time-stepping off  C     saltStepping   :: Turns salinity equation time-stepping off
# Line 300  C     nonHydrostatic   :: Using non-hydr Line 318  C     nonHydrostatic   :: Using non-hydr
318  C     use3Dsolver      :: set to true to use 3-D pressure solver  C     use3Dsolver      :: set to true to use 3-D pressure solver
319  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
320  C     staggerTimeStep   :: enable a Stagger time stepping U,V (& W) then T,S  C     staggerTimeStep   :: enable a Stagger time stepping U,V (& W) then T,S
321    C     doResetHFactors   :: Do reset thickness factors @ beginning of each time-step
322  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
323  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
324  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
# Line 323  C     allowFreezing  :: Allows surface w Line 342  C     allowFreezing  :: Allows surface w
342  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
343  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
344  C- I/O parameters -  C- I/O parameters -
345  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files.
346  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  C                       On some platforms with MPI, option globalFiles is either
347  C                       slow (f77) or does not work (f90).  When  C                       slow or does not work. Use useSingleCpuIO instead.
348  C                       useSingleCpuIO is set, mdsio_writefield.F  C     useSingleCpuIO :: moved to EEPARAMS.h
 C                       outputs from master mpi process only.  
349  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
350  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
351  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
# Line 341  C     snapshot_mdsio     :: use mdsio fo Line 359  C     snapshot_mdsio     :: use mdsio fo
359  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
360  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
361  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
362    C     printDomain     :: controls printing of domain fields (bathy, hFac ...).
363    
364        COMMON /PARM_L/        COMMON /PARM_L/
365       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
# Line 353  C                        & Last iteratio Line 372  C                        & Last iteratio
372       & momViscosity, momAdvection, momForcing,       & momViscosity, momAdvection, momForcing,
373       & momPressureForcing, metricTerms, useNHMTerms,       & momPressureForcing, metricTerms, useNHMTerms,
374       & useCoriolis, use3dCoriolis,       & useCoriolis, use3dCoriolis,
      & useConstantF, useBetaPlaneF, useSphereF,  
375       & useCDscheme, vectorInvariantMomentum,       & useCDscheme, vectorInvariantMomentum,
376       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
377       & upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
378       & useAbsVorticity, upwindShear,       & useAbsVorticity, upwindShear,
379       & momStepping, tempStepping, saltStepping,       & momStepping, calc_wVelocity, tempStepping, saltStepping,
380       & tempAdvection, tempIsActiveTr, tempForcing,       & tempAdvection, tempIsActiveTr, tempForcing,
381       & saltAdvection, saltIsActiveTr, saltForcing,       & saltAdvection, saltIsActiveTr, saltForcing,
382       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
383       & useRealFreshWaterFlux,       & useRealFreshWaterFlux, useSRCGSolver,
384       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
385       & uniformLin_PhiSurf,       & uniformLin_PhiSurf,
386       & quasiHydrostatic, nonHydrostatic,       & quasiHydrostatic, nonHydrostatic, use3Dsolver,
387       & use3Dsolver, implicitIntGravWave, staggerTimeStep,       & implicitIntGravWave, staggerTimeStep, doResetHFactors,
388       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
389       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
390       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
# Line 375  C                        & Last iteratio Line 393  C                        & Last iteratio
393       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
394       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
395       & periodicExternalForcing,       & periodicExternalForcing,
396       & globalFiles, useSingleCpuIO,       & globalFiles,
397       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
398       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
399       & writePickupAtEnd,       & writePickupAtEnd,
400       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
401       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast,
402       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & printDomain,
403       & useSRCGSolver       & inAdMode, inAdTrue, inAdFalse, inAdExact
404    
405        LOGICAL fluidIsAir        LOGICAL fluidIsAir
406        LOGICAL fluidIsWater        LOGICAL fluidIsWater
# Line 399  C                        & Last iteratio Line 417  C                        & Last iteratio
417        LOGICAL useNHMTerms        LOGICAL useNHMTerms
418        LOGICAL no_slip_sides        LOGICAL no_slip_sides
419        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
420          LOGICAL useFullLeith
421          LOGICAL useStrainTensionVisc
422          LOGICAL useAreaViscLength
423        LOGICAL momViscosity        LOGICAL momViscosity
424        LOGICAL momAdvection        LOGICAL momAdvection
425        LOGICAL momForcing        LOGICAL momForcing
# Line 416  C                        & Last iteratio Line 437  C                        & Last iteratio
437        LOGICAL checkIniTemp        LOGICAL checkIniTemp
438        LOGICAL checkIniSalt        LOGICAL checkIniSalt
439        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
440        LOGICAL useFullLeith        LOGICAL useSRCGSolver
       LOGICAL useStrainTensionVisc  
       LOGICAL useAreaViscLength  
441        LOGICAL rigidLid        LOGICAL rigidLid
442        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
443        LOGICAL exactConserv        LOGICAL exactConserv
# Line 429  C                        & Last iteratio Line 448  C                        & Last iteratio
448        LOGICAL use3Dsolver        LOGICAL use3Dsolver
449        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
450        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
451          LOGICAL doResetHFactors
452        LOGICAL momStepping        LOGICAL momStepping
453          LOGICAL calc_wVelocity
454        LOGICAL tempStepping        LOGICAL tempStepping
455        LOGICAL saltStepping        LOGICAL saltStepping
456        LOGICAL metricTerms        LOGICAL metricTerms
       LOGICAL useConstantF  
       LOGICAL useBetaPlaneF  
       LOGICAL useSphereF  
457        LOGICAL use3dCoriolis        LOGICAL use3dCoriolis
458        LOGICAL useCDscheme        LOGICAL useCDscheme
459        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
# Line 463  C                        & Last iteratio Line 481  C                        & Last iteratio
481        LOGICAL useOldFreezing        LOGICAL useOldFreezing
482        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
483        LOGICAL globalFiles        LOGICAL globalFiles
       LOGICAL useSingleCpuIO  
484        LOGICAL pickupStrictlyMatch        LOGICAL pickupStrictlyMatch
485        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
486        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
# Line 472  C                        & Last iteratio Line 489  C                        & Last iteratio
489        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
490        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
491        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
492        LOGICAL debugMode        LOGICAL printDomain
493        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
       LOGICAL useSRCGSolver  
494    
495  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
496  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 500  C           defaults to 0.51 but can be Line 516  C           defaults to 0.51 but can be
516  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
517  C     delRc     :: Vertical grid spacing between cell centers (r unit).  C     delRc     :: Vertical grid spacing between cell centers (r unit).
518  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
519  C     delY        on input flags.  C     delY         on input flags. Note: moved to header file SET_GRID.h
520    C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
521    C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
522    C                :: parameter but it makes geographical references simple.)
523    C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
524    C                :: most face (Lat-Lon grid).
525  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
526  C     recip_gravity and its inverse  C     recip_gravity and its inverse
527  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
528  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
529  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density (Boussinesq)
530  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
531  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
532  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
# Line 513  C     rho1Ref   :: reference vertical pr Line 534  C     rho1Ref   :: reference vertical pr
534  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
535  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
536  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
537  C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:  C     dBdrRef   :: vertical gradient of reference buoyancy  [(m/s/r)^2]:
538  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
539  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
540  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
# Line 530  C     rUnit2mass :: units conversion fac Line 551  C     rUnit2mass :: units conversion fac
551  C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].  C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
552  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
553  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
 C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western  
 C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"  
 C                :: parameter but it makes geographical references simple.)  
 C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern  
 C                :: most face (Lat-Lon grid).  
554  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
555  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
556    C     radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
557  C     f0         :: Reference coriolis parameter ( 1/s )  C     f0         :: Reference coriolis parameter ( 1/s )
558  C                   ( Southern edge f for beta plane )  C                   ( Southern edge f for beta plane )
559  C     beta       :: df/dy ( s^-1.m^-1 )  C     beta       :: df/dy ( s^-1.m^-1 )
560    C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
561    C                   of rotation (reference value = 2.Omega.Cos(Phi))
562  C     omega      :: Angular velocity ( rad/s )  C     omega      :: Angular velocity ( rad/s )
563  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
564  C     viscArNr   :: vertical profile of Eddy viscosity coeff.  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
# Line 672  C     convertFW2Salt :: salinity, used t Line 691  C     convertFW2Salt :: salinity, used t
691  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
692  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
693  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
694    C     temp_addMass :: temperature of addMass array
695    C     salt_addMass :: salinity of addMass array
696  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
697  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
698  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 681  C     hMixSmooth  :: Smoothing parameter Line 702  C     hMixSmooth  :: Smoothing parameter
702  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
703  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
704  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
705    C     rSigmaBnd   :: vertical position (in r-unit) of r/sigma transition (Hybrid-Sigma)
706  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
707  C                           (default=2: full drag ; =1: gives half-slip BC)  C                           (default=2: full drag ; =1: gives half-slip BC)
708  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
# Line 696  C     thetaEuler    :: Euler angle, rota Line 718  C     thetaEuler    :: Euler angle, rota
718  C     psiEuler      :: Euler angle, rotation about new z-axis  C     psiEuler      :: Euler angle, rotation about new z-axis
719        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
720       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
721       & delR, delRc, delX, delY,       & delR, delRc, xgOrigin, ygOrigin,
722       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
723       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
724       & xgOrigin, ygOrigin, rSphere, recip_RSphere, f0, beta,       & rSphere, recip_rSphere, radius_fromHorizGrid,
725       & viscAh, viscAhW, viscAhMax,       & f0, beta, fPrime, omega, rotationPeriod,
726         & viscFacAdj, viscAh, viscAhW, viscAhMax,
727       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
728       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
729       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
# Line 718  C     psiEuler      :: Euler angle, rota Line 741  C     psiEuler      :: Euler angle, rota
741       & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,       & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
742       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
743       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
744       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhoNil, rhoConst, recip_rhoConst,
745       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
746       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
747       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
# Line 726  C     psiEuler      :: Euler angle, rota Line 749  C     psiEuler      :: Euler angle, rota
749       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
750       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
751       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
752       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq,
753       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
754       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
755       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
756       & hFacMinDr, hFacMinDp,       & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
757       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, Ro_SeaLevel,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth,
758         & Ro_SeaLevel, rSigmaBnd,
759       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
760       & smoothAbsFuncRange,       & smoothAbsFuncRange,
761       & tCylIn, tCylOut,       & tCylIn, tCylOut,
# Line 743  C     psiEuler      :: Euler angle, rota Line 767  C     psiEuler      :: Euler angle, rota
767        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
768        _RL delR(Nr)        _RL delR(Nr)
769        _RL delRc(Nr+1)        _RL delRc(Nr+1)
770        _RL delX(Nx)        _RL xgOrigin
771        _RL delY(Ny)        _RL ygOrigin
772        _RL deltaT        _RL deltaT
773        _RL deltaTClock        _RL deltaTClock
774        _RL deltaTmom        _RL deltaTmom
775        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
776        _RL deltaTfreesurf        _RL deltaTfreesurf
777        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
       _RL xgOrigin  
       _RL ygOrigin  
778        _RL rSphere        _RL rSphere
779        _RL recip_rSphere        _RL recip_rSphere
780          _RL radius_fromHorizGrid
781        _RL f0        _RL f0
782          _RL beta
783          _RL fPrime
784          _RL omega
785          _RL rotationPeriod
786        _RL freeSurfFac        _RL freeSurfFac
787        _RL implicSurfPress        _RL implicSurfPress
788        _RL implicDiv2Dflow        _RL implicDiv2Dflow
# Line 766  C     psiEuler      :: Euler angle, rota Line 793  C     psiEuler      :: Euler angle, rota
793        _RL hFacMinDr        _RL hFacMinDr
794        _RL hFacInf        _RL hFacInf
795        _RL hFacSup        _RL hFacSup
       _RL beta  
796        _RL viscArNr(Nr)        _RL viscArNr(Nr)
797          _RL viscFacAdj
798        _RL viscAh        _RL viscAh
799        _RL viscAhW        _RL viscAhW
800        _RL viscAhD        _RL viscAhD
# Line 807  C     psiEuler      :: Euler angle, rota Line 834  C     psiEuler      :: Euler angle, rota
834        _RL gravity        _RL gravity
835        _RL recip_gravity        _RL recip_gravity
836        _RL gBaro        _RL gBaro
837        _RL rhonil,        recip_rhonil        _RL rhoNil
838        _RL rhoConst,      recip_rhoConst        _RL rhoConst,      recip_rhoConst
839        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
840        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
# Line 839  C     psiEuler      :: Euler angle, rota Line 866  C     psiEuler      :: Euler angle, rota
866        _RL mtFacMom        _RL mtFacMom
867        _RL cosPower        _RL cosPower
868        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
       _RL rotationPeriod  
869        _RL tauThetaClimRelax        _RL tauThetaClimRelax
870        _RL tauSaltClimRelax        _RL tauSaltClimRelax
871        _RL latBandClimRelax        _RL latBandClimRelax
# Line 849  C     psiEuler      :: Euler angle, rota Line 874  C     psiEuler      :: Euler angle, rota
874        _RL convertFW2Salt        _RL convertFW2Salt
875        _RL temp_EvPrRn        _RL temp_EvPrRn
876        _RL salt_EvPrRn        _RL salt_EvPrRn
877          _RL temp_addMass
878          _RL salt_addMass
879        _RL ivdc_kappa        _RL ivdc_kappa
880        _RL hMixCriteria        _RL hMixCriteria
881        _RL dRhoSmall        _RL dRhoSmall
882        _RL hMixSmooth        _RL hMixSmooth
883        _RL Ro_SeaLevel        _RL Ro_SeaLevel
884          _RL rSigmaBnd
885        _RL sideDragFactor        _RL sideDragFactor
886        _RL bottomDragLinear        _RL bottomDragLinear
887        _RL bottomDragQuadratic        _RL bottomDragQuadratic
# Line 900  C Logical flags for selecting packages Line 928  C Logical flags for selecting packages
928        LOGICAL useKPP        LOGICAL useKPP
929        LOGICAL useGMRedi        LOGICAL useGMRedi
930        LOGICAL useDOWN_SLOPE        LOGICAL useDOWN_SLOPE
931          LOGICAL useBBL
932        LOGICAL useCAL        LOGICAL useCAL
933        LOGICAL useEXF        LOGICAL useEXF
934        LOGICAL useBulkForce        LOGICAL useBulkForce
# Line 915  C Logical flags for selecting packages Line 944  C Logical flags for selecting packages
944        LOGICAL useRBCS        LOGICAL useRBCS
945        LOGICAL useOffLine        LOGICAL useOffLine
946        LOGICAL useMATRIX        LOGICAL useMATRIX
947          LOGICAL useFRAZIL
948        LOGICAL useSEAICE        LOGICAL useSEAICE
949        LOGICAL useSALT_PLUME        LOGICAL useSALT_PLUME
950        LOGICAL useShelfIce        LOGICAL useShelfIce
951          LOGICAL useStreamIce
952        LOGICAL useICEFRONT        LOGICAL useICEFRONT
953        LOGICAL useThSIce        LOGICAL useThSIce
954        LOGICAL useATM2d        LOGICAL useATM2d
# Line 935  C Logical flags for selecting packages Line 966  C Logical flags for selecting packages
966        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
967       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
968       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
969       &        useGMRedi, useDOWN_SLOPE,       &        useGMRedi, useBBL, useDOWN_SLOPE,
970       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
971       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,
972       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
973       &        useSEAICE, useSALT_PLUME, useShelfIce,       &        useFRAZIL, useSEAICE, useSALT_PLUME, useShelfIce,
974       &        useICEFRONT, useThSIce,       &        useStreamIce, useICEFRONT, useThSIce,
975       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
976       &        useDiagnostics, useREGRID, useLayers, useMNC,       &        useDiagnostics, useREGRID, useLayers, useMNC,
977       &        useRunClock, useEMBED_FILES,       &        useRunClock, useEMBED_FILES,
978       &        useMYPACKAGE       &        useMYPACKAGE
979    
980    C     Logical flags for turning off parts of the code in adjoint mode
981          LOGICAL useKPPinAdMode, useKPPinFwdMode
982          LOGICAL useGMrediInAdMode, useGMrediInFwdMode
983          LOGICAL useSEAICEinAdMode, useSEAICEinFwdMode
984          COMMON /PARM_PACKAGES_ADJ/
985         &       useKPPinAdMode, useKPPinFwdMode,
986         &       useGMrediInAdMode, useGMrediInFwdMode,
987         &       useSEAICEinAdMode, useSEAICEinFwdMode
988    
989  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
990  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
991  CEH3 ;;; End: ***  CEH3 ;;; End: ***
Legend:
Removed from v.1.236  
changed lines
  Added in v.1.259
  ViewVC Help
Powered by ViewVC 1.1.22