version 3.10-dev
parameterlist.txt File Reference
Parameters and runtime configuration

List of currently usable run-time parameters. More...

Description

The listed run-time parameters are available in general, but we point out that a certain model might not be able to use every parameter!

Group Parameter Type Default Value Explanation
- ParameterFile std::string executable.input :-
Adaptive BCRefinementThreshold Scalar 1e-10 The threshold above which fluxes are treated as non-zero
Adaptive MaxLevel std::size_t 0 The maximum refinement level
Adaptive MinLevel std::size_t 0 The minimum refinement level
Adaptive RefineAtDirichletBC bool true Whether to refine at Dirichlet boundaries
Adaptive RefineAtFluxBC bool true Whether to refine at Neumann/Robin boundaries
Adaptive RefineAtSource bool true Whether to refine where source terms are specified
Assembly BoxVolVarsDependOnAllElementDofs bool false Whether to update all volvars in the stencil or only update the volVars for the scv whose associated dof has been deflected.
Assembly FCDiamondVolVarsDependOnAllElementDofs bool false Whether to update all volvars in the stencil or only those of the associated scv
Assembly Multithreading bool true Whether to enable multi-threaded assembly
Assembly NumericDifference.BaseEpsilon Scalar 1e-10 The basic numeric epsilon used in the differentiation for deflecting primary variables
Assembly NumericDifference.PriVarMagnitude NumEqVector NumEqVector(-1) The magnitude of the primary variables used for finding a good numeric epsilon for deflecting primary variables.
Assembly NumericDifferenceMethod int - The numeric difference method (1: forward differences (default), 0: central differences, -1: backward differences)
Assembly PQ1BubbleVolVarsDependOnAllElementDofs bool false Whether to update all volvars in the stencil or only those of the associated scv
BinaryCoefficients GasDiffCoeff Scalar - The binary diffusion coefficient in gas
BinaryCoefficients LiquidDiffCoeff Scalar - The binary diffusion coefficient in liquid
Brine Salinity Scalar - The salinity
Component EnthalpyOfVaporization Scalar - The enthalpy of the vaporization
Component GasDensity Scalar - The density of the gas
Component GasDiffusionCoefficient Scalar 1.0 Binary diffusion coefficient for molecular water and the constant component
Component GasDynamicViscosity Scalar - The dynamic viscosity of the gas
Component GasHeatCapacity Scalar - The heat capacity of the gas
Component GasKinematicViscosity Scalar - The gas kinematic viscosity
Component GasThermalConductivity Scalar - The thermal conductivity of the gas
Component HenryComponentInWater Scalar 1.0 Henry coefficient for the constant component in liquid water
Component HenryWaterInComponent Scalar 1.0 Henry coefficient for water in the constant component
Component LiquidDensity Scalar - The density of the liquid
Component LiquidDiffusionCoefficient Scalar 1.0 Diffusion coefficient for the constant component in liquid water
Component LiquidDynamicViscosity Scalar - The dynamic viscosity of the liquid
Component LiquidHeatCapacity Scalar - Specific isobaric heat capacity of the component \(\mathrm{[J/(kg*K)]}\) as a liquid.
Component LiquidKinematicViscosity Scalar - The liquid kinematic viscosity
Component LiquidThermalConductivity Scalar - Thermal conductivity of the component \(\mathrm{[W/(m*K)]}\) as a liquid.
Component MolarMass Scalar - The mass in one mole of the component
Component Name std::string "component" A human readable name for the component
Component ReferenceTemperature Scalar 293.15 The reference temperature in \(\mathrm{[K]}\) used when calculating the specific internal energy of a constant component as a liquid.
Component SolidDensity Scalar - The density of the component in solid state
Component SolidHeatCapacity Scalar - Specific isobaric heat capacity of the component as a solid
Component SolidThermalConductivity Scalar - Thermal conductivity of the component as a solid
Component TriplePressure Scalar - The triple pressure of the component
Component TripleTemperature Scalar - The triple temperature of the component
DualNetwork Bi Scalar 1.0 The Biot number.
DualNetwork ConnectionAreaShapeFactor Scalar 0.9 The factor for the connection are shape.
DualNetwork ConvectionLambaExponent Scalar 0.4 The exponent for the convection lambda.
DualNetwork ConvectionLambaFactor Scalar 0.9 The multiplicative factor for the convection lambda.
DualNetwork FixedConvectionLambda Scalar -1.0 Fixed value for the convecion lambda if used.
DualNetwork FluidTemperatureMode std::string mean The computation mode of the fluid temperature.
DualNetwork Nu Scalar 1.0 The Nusselt number.
DualNetwork OverlapFactor Scalar - The overlap factor for the computation of exact pore radius.
DualNetwork SourceVerboseForDof int -1 Whether status should be printed.
DualNetwork SphereRadius Scalar 50e-6 The radius of a spherical pore.
DualNetwork UseAverageConvectionArea bool false Whether to use an averaged convection area.
DualNetwork UseExactConnectionAreaSphere bool false Whether to use the exact connection area.
DualNetwork UseExactConnectionLength bool false Whether to use the exact connection length.
DualNetwork UseExactPoreRadiusSolid bool false Whether to use the exact pore radius for the solid.
DualNetwork UseExactPoreRadiusVoid bool false Whether to use the exact pore radius for the void space.
ElectroChemistry ActivationBarrier Scalar - The activation barrier to calculate the exchange current density.
ElectroChemistry CellVoltage Scalar - The voltage of the fuel cell.
ElectroChemistry MaxIterations int - The maximum number of iterations in iteatively (Newton solver) calculating the current density.
ElectroChemistry NumElectrons Scalar - The number of electrons for the calculation of activation and concentration losses.
ElectroChemistry RefCurrentDensity Scalar - The reference current density to calculate the exchange current density.
ElectroChemistry RefO2PartialPressure Scalar - The reference oxygen partial pressure.
ElectroChemistry RefTemperature Scalar - The reference temperature to calculate the exchange current density.
ElectroChemistry ReversibleVoltage Scalar - The reversible voltage.
ElectroChemistry SpecificResistance Scalar - The specific resistance, see [2].
ElectroChemistry SurfaceIncreasingFactor Scalar - The surface-increasing factor to calculate the exchange current density.
ElectroChemistry ThermoneutralVoltage Scalar - Thermoneutral voltage for the non-isothermal electrochemistry model.
ElectroChemistry TransferCoefficient Scalar - The transport coefficient.
ElectroChemistry TransportNumberH20 Scalar - The water transport number to calculate the osmotic term in the membrane.
ElectroChemistry pO2Inlet Scalar - The oxygen pressure at the inlet.
FacetCoupling Xi Scalar 1.0 The xi factor for coupling conditions
Flux DifferencingScheme std::string "Minmod" Choice of a staggered TVD method
Flux EnableOutflowReversalWarning bool true Whether to print warning by flow reversal
Flux TvdApproach std::string "Uniform" If you use a staggered grid with a TVD approach: For a uniform grid "Uniform" is fine. For a nonuniform grid decide between "Li" and "Hou" (two literature-based methods).
Flux UpwindWeight Scalar - Upwind weight in staggered upwind method
FluxLimiterLET LowerWaterDepth Scalar 1e-5 The lower water depth
FluxLimiterLET UpperWaterDepth Scalar 1e-3 The upper water depth
FluxLimiterLET UpwindFluxLimiting bool false If this is set true, the upwind water depth from the flux direction is used. This can improve stability.
FluxOverAxisAlignedSurface Verbose bool false For enabling or disabling the console output
FluxOverSurface Verbose bool false For enabling or disabling the console output
Forchheimer MaxIterations std::size_t 30 The maximum number of Newton iterations for solving the Forchheimer equation
Forchheimer NewtonTolerance Scalar 1e-12 The error tolerance in the Newton method for solving the Forchheimer equation
FouriersLaw UseVolumeEqualPyramid bool false Whether to deduce pyramid base length from volume. The base side length for the frustum of the pyramid is obtained by assuming that the volume of the frustum is the same as half the volume of the pore body. Otherwise the side length is set as the diameter of the pore body.
FreeFlow EnableDilatationTerm bool false For enabling the turbulent dilation term.
FreeFlow EnableUnsymmetrizedVelocityGradient bool false For enabling unsymmetrized velocity gradient. If false consider the shear stress caused by the gradient of the velocities normal to our face of interest.
FreeFlow EnableUnsymmetrizedVelocityGradientForBeaversJoseph bool false For enabling unsymmetrized velocity gradient for the Beavers Joseph coupling condition. If true and if the current scvf is on a boundary and if a Dirichlet BC for the pressure or a BJ condition for the slip velocity is set there, assume a tangential velocity gradient of zero along the lateral face.
FreeFlow UseOldTransportingVelocity bool true Whether to use the old transporting velocity
Grid AddThroatVolumeToPoreVolume bool false Whether to add the throat volume to the pore volume.
Grid AllowIntersectingDiagonals bool true Whether to allow diagonals to intersect in the context of the generation of a structured-lattice pore-network.
Grid Angular0/1/2 std::vector<Scalar> - min/max value for angular coordinate. Cake grids can be created by either specifying Radial,Angular or Axial in all coordinate directions.
Grid Axial0/1/2 std::vector<Scalar> - min/max value for axial coordinate. Cake grids can be created by either specifying Radial,Angular or Axial in all coordinate directions.
Grid BinaryMask std::string - Name of the mask file.
Grid BoundaryPoreLabels std::vector<std::string> - With this, the boundary faces can be set in the format xmin xmax ymin ymax (zmin zmax).
Grid BoundarySegments bool false For the dune gmsh reader: Whether to insert boundary segments into the grid
Grid CapPoreRadii bool true If true a maximal pore radius is set.
Grid CapPoresOnBoundaries std::vector<int> std::vector<int>{} A vector of boundary indices of for which the pore volume should be halved in a direction within automatically determining the pore volume
Grid CellType std::string "Cube" "Cube" or "Simplex" to be used for structured grids
Grid Cells std::array<unsigned int, dim> {1, 1, 1} The number of elements in a structured uniform grid in x, y and z direction
Grid Cells0/1/2 std::vector<int> - For a grid with zones, number of cells of the leftmost zone, number of cells of the second-leftmost zone, ..., number of cells of the rightmost zone, spaceseparated. (assuming x-axis points to the right)
Grid CellsPerPore int - the number of cells above the porous medium
Grid ClosureType std::string "Green" Decide whether to add a green closure to locally refined grid sections or not: "Green" (Standard red/green refinement) or "None" (No closure, results in nonconforming meshes)
Grid Coordinates std::vector<typename Grid::ctype> - To construct a 1D grid with just a coordinates vector
Grid CouplingPlaneLowerLeft GlobalPosition Grid.LowerLeft the lower left point of the coupling plane
Grid CouplingPlaneUpperRight GlobalPosition - The upper right point of the coupling plane. Default value is based on the gridLowerLeft and uses the coordinate of gridUpperRight in the direction parallel to the coupling plane.
Grid CouplinglineNormal GlobalPosition {0,0,1} The normal direction of the coupled interface
Grid DeletionProbability decltype(directionProbability) - For a non-regular lattice, you must specify deletion probabilities for deleting throats in all directions. For example (3D): DeletionProbability = 0.5 0.5 0 0 0 0 0 0 0 0 0 0 0 deletes approximately 50% of all throats in x and y direction, while no deletion in any other direction takes place. In 2D four values are required (x (1,0),y (0,1) and two diagnals through cell midpoint (1,1),(1,-1)). In 3D thirteen values are required (x(1,0,0),y(0,1,0),z(0,0,1), six face diagonals (1,1,0),(1,-1,0),(1,0,1),(1,0,-1),(0,1,1),(0,1,-1) and four diagonals through cell midpoint (1,1,1),(1,1,-1),(-1,1,1),(-1,-1,1).
Grid DeletionRandomNumberSeed std::size_t - A seed for the random number generation for the random deletion of connecting throats.
Grid DomainMarkers bool false Whether the grid managers work with domain markers.
Grid DownstreamCells0/1/2 std::vector<Int> - (The number of the user-defined additional points + 1) in each normal direction in the downstream area of a snappy grid.
Grid DownstreamGrading0/1/2 std::vector<Scalar> - Grading factor for the user-defined additional points in each normal direction in the downstream area of a snappy grid.
Grid DownstreamPositions0/1/2 std::vector<Scalar> - User-defined additional points in the normal directions in the downstream area of a snappy grid.
Grid File std::string - A DGF or gmsh file to load from
Grid FixedCellsBetweenPores int -1 the number of cells between two pores
Grid FixedPoreRadiusForLabel std::vector<Scalar> std::vector<Scalar>{} Vector of pore radii to be set to the corresponding pores not belonging to a subregion indicated by PoreLabelsToSetFixedRadius.
Grid GmshPhysicalEntityThreshold std::size_t 0 Boundary element index threshold
Grid Grading0/1/2 std::vector<Scalar> - For a grid with zones, grading factors for the x-zones. 1.0 means all cells within this zone have equal extension in x-direction. Negative factors are possible.
Grid Image std::string - The image file if the sub grid is constructed from a raster image
Grid KeepOnlyConnected std::string - Whether non-connected cells should be removed.
Grid KeepPhysicalOverlap bool true Whether to keep the physical overlap in physical size or in number of cells upon refinement
Grid LeftBoundary CoordinateType 0.0 The start coordinate of a 1D grid
Grid LowerLeft GlobalPosition GlobalPosition(0.0) The lowerLeft corner of a structured grid
Grid MakeConsistentlyOriented bool true Whether to make sure that all element intersections follow the same local orientation and indexing no matter how the elements may be rotated or twisted.
Grid Marker char 0 To customize the subgrid generation.
Grid MaxPoreInscribedRadius Scalar - In the case of a uniform random distribution, this specifies the maximum pore radius.
Grid MeanPoreInscribedRadius Scalar - In the case of a lognormal random distribution, this specifies the mean pore radius.
Grid MinPoreInscribedRadius Scalar - In the case of a uniform random distribution, this specifies the minimum pore radius.
Grid MinThroatLength Scalar 1e-6 The minimum pore throat length.
Grid NumPores std::vector<unsigned int> - The number of pores for a 1D grid. For a more-dimensional grid the number of pores in x,y (and z) direction.
Grid NumSubregions std::size_t 0 The number of subregions within a pore-network model.
Grid Overlap int 1 The overlap size in cells
Grid OverwriteGridDataWithShapeSpecificValues bool true If Grid.ThroatCrossSectionShape is set, here one can set to overwrite the grid data with the shape-specific values.
Grid ParameterRandomNumberSeed unsigned int std::random_device{}() If PoreInscribedRadius is not set, this allows to specify a seed to get reproducible results.
Grid ParameterType std::string "lognormal" If PoreInscribedRadius is not set, this allows to specify the type of random distribution for the radii. Possible values are "lognormal" and "uniform".
Grid Partitioning std::array<int, dim> - A non-standard load-balancing, number of processors per direction
Grid Periodic std::bitset<dim> std::bitset<dim>{} True or false for each direction
Grid PixelDimensions GlobalPosition - For subgrid generation, this can be used to specify the UpperRight position. To calculate UpperRight this is in every dimension multiplied by the number of cells and added to LowerLeft.
Grid PoreGeometry std::string - Pore geometry shape. Possibilities are "Square", "Circle", "Cube", "Sphere", "Cylinder", "Tetrahedron", "Octahedron", "Icosahedron" or "Dodecahedron".
Grid PoreHeight Scalar -1.0 A fixed pore height.
Grid PoreInscribedRadius Scalar -1.0 If this is set, all pore radii of pore bodies not belonging to a subregion are set to this value. If this is not set, a random radius is set according to a user-specified distribution.
Grid PoreLabelsToApplyFactorForRadius std::vector<int> std::vector<int>{} Labels of pores of pores bodies not belonging to a subregion which should be treated by applying a factor for the radius.
Grid PoreLabelsToSetFixedRadius std::vector<int> std::vector<int>{} Labels of pores of pores bodies not belonging to a subregion which should be treated by setting a fixed radius.
Grid PoreRadiusFactorForLabel std::vector<Scalar> std::vector<Scalar>{} Vector of factors for the radii of the corresponding pores not belonging to a subregion indicated by PoreLabelsToApplyFactorForRadius.
Grid Positions0/1/2 std::vector<ctype> - For a grid with zones, x/y/z-positions of the left of the leftmost zone followed by the right of all zones (from left to right). (assuming x-axis points to the right)
Grid PriorityList BoundaryList - The priority which decides the order the vertices on the boundary are indexed. By default, vertices on min/max faces in x direction have the highest priority, followed by y and z.
Grid PruningSeedIndices std::vector<int> std::vector<int>{1} Indices from which to start the search process for finding elements not connected to pores at a Dirichlet boundary, which are then removed.
Grid Radial0/1/2 std::vector<Scalar> - min/max value for radial coordinate. Cake grids can be created by either specifying Radial,Angular or Axial in all coordinate directions.
Grid Refinement int 0 The number of global refines to perform
Grid RefinementType std::string "Local" e.g. UGGrid "Local" (New level consists only of the refined elements and the closure) or "Copy" (New level consists of the refined elements and the unrefined ones, too)
Grid RegularLattice bool false A regular lattice is when pore are always connected parallel to the main axes and never connected in other directions.
Grid RemoveThroatsOnBoundary std::vector<std::size_t> - Whether the throats on the boundary should be removed.
Grid Repeat std::array<int, dim> repeatsDefault Number of times to repeat the subgrid pattern in each dimension.
Grid RightBoundary CoordinateType - The end coordinate of a 1D grid
Grid SanitationMode std::string "KeepLargestCluster" The mode of sanitation. Sanitation is a post-processing to remove insular groups of elements that are not connected to a Dirichlet boundary. Possible modes are "UsePoreLabels" (keep cluster connected to a specific pore given by a pore label) and "KeepLargestCluster".
Grid Sanitize bool false Whether to sanitize the grid. Sanitizing is a post-processing to remove insular groups of elements that are not connected to a Dirichlet boundary.
Grid StandardDeviationPoreInscribedRadius Scalar - In the case of a lognormal random distribution, this specifies the standard deviation of the pore radius.
Grid Subregion0,1,....FixedPoreRadiusForLabel std::vector<Scalar> std::vector<Scalar>{} Vector of pore radii to be set to the corresponding pores within this subregion indicated by PoreLabelsToSetFixedRadius.
Grid Subregion0,1,....LowerLeft GlobalPosition - Gives the lower left corner position of the subregion grid in the context of a pore-network.
Grid Subregion0,1,....MaxPoreInscribedRadius Scalar - In the case of a uniform random distribution, this specifies the maximum pore radius.
Grid Subregion0,1,....MeanPoreInscribedRadius Scalar - In the case of a lognormal random distribution, this specifies the mean pore radius.
Grid Subregion0,1,....MinPoreInscribedRadius Scalar - In the case of a uniform random distribution, this specifies the minimum pore radius.
Grid Subregion0,1,....ParameterRandomNumberSeed unsigned int std::random_device{}() If PoreInscribedRadius is not set, this allows to specify a seed to get reproducible results.
Grid Subregion0,1,....ParameterType std::string "lognormal" If PoreInscribedRadius is not set, this allows to specify the type of random distribution for the radii. Possible values are "lognormal" and "uniform".
Grid Subregion0,1,....PoreInscribedRadius Scalar -1.0 If this is set, all pore radii of pore bodies of this subregion are set to this value. If this is not set, a random radius is set according to a user-specified distribution.
Grid Subregion0,1,....PoreLabelsToApplyFactorForRadius std::vector<int> std::vector<int>{} Labels of pores of pores bodies within this subregion which should be treated by applying a factor for the radius, case with subregions.
Grid Subregion0,1,....PoreLabelsToSetFixedRadius std::vector<int> std::vector<int>{} Labels of pores of pores bodies within this subregion which should be treated by setting a fixed radius.
Grid Subregion0,1,....PoreRadiusFactorForLabel std::vector<Scalar> std::vector<Scalar>{} Vector of factors for the radii of the corresponding pores within this subregion indicated by PoreLabelsToApplyFactorForRadius.
Grid Subregion0,1,....StandardDeviationPoreInscribedRadius Scalar - In the case of a lognormal random distribution, this specifies the standard deviation of the pore radius.
Grid Subregion0,1,....SubstractPoreInscribedRadiiFromThroatLength bool true Decide whether to subtract the pore radii from the throat length or not for a pore throat not belonging to a subregion.
Grid Subregion0,1,....SubstractRadiiFromThroatLength bool true Decide whether to subtract the pore radii from the throat length or not for a pore throat belonging to this subregion.
Grid Subregion0,1,....ThroatInscribedRadius Scalar -1.0 Radius of a pore throat belonging to this subregion.
Grid Subregion0,1,....ThroatInscribedRadiusN Scalar 0.1 Shape parameter for the calculation of the radius of a pore throat belonging to this subregion when ThroatInscribedRadius is not set.
Grid Subregion0,1,....ThroatLength Scalar -1.0 Length of a pore throat belonging to this subregion.
Grid Subregion0,1,....UpperRight GlobalPosition - Gives the upper right corner position of the subregion grid in the context of a pore-network.
Grid SubstractPoreInscribedRadiiFromThroatLength bool true Decide whether to subtract the pore radii from the throat length or not for a pore throat not belonging to a subregion.
Grid ThroatCrossSectionShape std::string - A geometry that should be used for all throatcrosssections. The possibilities are "ScaleneTriangle", "EquilateralTriangle", "Square", "Rectangle", "Circle", "TwoPlates", "Polygon".
Grid ThroatHeight Scalar - Throat height for a rectangle-shaped throat cross section.
Grid ThroatInscribedRadius Scalar -1.0 Radius of a pore throat not belonging to a subregion.
Grid ThroatInscribedRadiusN Scalar 0.1 Shape parameter for the calculation of the radius of a pore throat not belonging to a subregion when ThroatInscribedRadius is not set.
Grid ThroatLength Scalar -1.0 A user-specified fixed throat length.
Grid ThroatShapeFactor Scalar - Throat shape factor for a polygonal throat cross section or a scalene triangle one.
Grid UpperRight GlobalPosition - The upperright corner of a structured grid
Grid UpstreamCells0/1/2 std::vector<Int> - (The number of the user-defined additional points + 1) in each normal direction in the upstream area of a snappy grid.
Grid UpstreamGrading0/1/2 std::vector<Scalar> - Grading factor for the user-defined additional points in each normal direction in the upstream area of a snappy grid.
Grid UpstreamPositions0/1/2 std::vector<Scalar> - User-defined additional points in each normal direction in the upstream area of a snappy grid.
Grid Verbosity bool false Whether the grid construction should output to standard out
InvasionState AccuracyCriterion Scalar -1.0 Specifies the allowed relative deviation of the capillary pressure of the upstream pore from the throat's entry capillary pressure after an invasion event. This effectively forces the Newton scheme to use very small time steps at invasion events. A value of 0.9 means that pc must not be smaller than 0.9*pc_entry after the invasion.
InvasionState BlockNonwettingPhaseAtThroatLabel std::vector<int> std::vector<int>{} A vector of labels of throats. Block non-wetting phase flux out of the outlet.
InvasionState RestrictInvasionToGlobalCapillaryPressure bool false Whether to restrict the invasion behavior by a global capillary pressure defined in the problem.
InvasionState Verbosity bool true Whether to print detailed invasion information.
KEpsilon EnableZeroEqScaling bool true Whether to match the potential zeroeq eddy viscosities for two-layer model at the matching point
KEpsilon YPlusThreshold Scalar 30.0 yPlus below this value is considered as near-wall region
KOmega EnableDissipationLimiter bool true Whether to enable the dissipation limiter
KOmega EnableProductionLimiter bool false Whether to enable the production limiter
LinearPDESolver EnableDynamicOutput bool true Whether dynamic output should be enabled.
LinearPDESolver Verbosity int 2 The verbosity of the linear PDE solver.
LinearSolver GMResRestart int 10 cycles before restarting
LinearSolver MaxIterations int 250 The maximum iterations of the linear solver
LinearSolver MaxOrthogonalizationVectors int 10 Maximal number of previous vectors which are orthogonalized against the new search direction
LinearSolver Preconditioner.AmgAccumulationMode std::string - If and how data is agglomerated on coarser level to fewer processors. ("atOnce": do agglomeration once and to one process; "successive": Multiple agglomerations to fewer processes until all data is on one process; "none": Do no agglomeration at all and solve coarse level iteratively).
LinearSolver Preconditioner.AmgAdditive bool - Whether to use additive multigrid.
LinearSolver Preconditioner.AmgAlpha double - Scaling value for marking connections as strong.
LinearSolver Preconditioner.AmgBeta double - Threshold for marking nodes as isolated.
LinearSolver Preconditioner.AmgCoarsenTarget int - Maximum number of unknowns on the coarsest level.
LinearSolver Preconditioner.AmgCriterionSymmetric bool true If true use SymmetricCriterion (default), else UnSymmetricCriterion
LinearSolver Preconditioner.AmgDefaultAggregationDimension std::size_t std::to_string(dimension) Dimension of the problem (used for setting default aggregate size).
LinearSolver Preconditioner.AmgDefaultAggregationSizeMode std::string isotropic Whether to set default values depending on isotropy of problem uses parameters "defaultAggregationDimension" and "maxAggregateDistance" (isotropic: For and isotropic problem; anisotropic: for an anisotropic problem).
LinearSolver Preconditioner.AmgDiagonalRowIndex int 0 The index to use for the diagonal strength (default 0) if this is i and strengthMeasure is "diagonal", then block[i][i] will be used when determining strength of connection.
LinearSolver Preconditioner.AmgGamma std::size_t - 1 for V-cycle, 2 for W-cycle.
LinearSolver Preconditioner.AmgMaxAggregateDistance std::size_t 2 Maximum distance in an aggregte (in term of minimum edges needed to travel. one vertex to another within the aggregate).
LinearSolver Preconditioner.AmgMaxAggregateSize std::size_t - Maximum number of vertices an aggregate should consist of.
LinearSolver Preconditioner.AmgMaxLevel int 100 Maximum number of levels allowed in the hierarchy.
LinearSolver Preconditioner.AmgMinAggregateSize std::size_t - Minimum number of vertices an aggregate should consist of.
LinearSolver Preconditioner.AmgMinCoarseningRate int - Coarsening will stop if the rate is below this threshold.
LinearSolver Preconditioner.AmgPostSmoothingSteps std::size_t - Number of postsmoothing steps.
LinearSolver Preconditioner.AmgPreSmoothingSteps std::size_t - Number of presmoothing steps.
LinearSolver Preconditioner.AmgProlongationDampingFactor double - Damping factor for the prolongation.
LinearSolver Preconditioner.AmgSmootherIterations int - The number of iterations to perform.
LinearSolver Preconditioner.AmgSmootherRelaxation double - The relaxation factor
LinearSolver Preconditioner.AmgStrengthMeasure std::string diagonal What conversion to use to convert a matrix block to a scalar when determining strength of connection: diagonal (use a diagonal of row diagonalRowIndex, class Diagonal, default); rowSum (rowSum norm), frobenius (Frobenius norm); one (use always one and neglect the actual entries).
LinearSolver Preconditioner.DetermineRelaxationFactor bool true Whether within the Uzawa algorithm the parameter omega is the relaxation factor is estimated by use of AMG
LinearSolver Preconditioner.DirectSolverForA bool false Whether within the Uzawa algorithm a direct solver is used for inverting the 00 matrix block.
LinearSolver Preconditioner.ILUOrder int 0 The order of the ILU decomposition.
LinearSolver Preconditioner.ILUResort bool false true if a resort of the computed ILU for improved performance should be done.
LinearSolver Preconditioner.Iterations int 1 Usually specifies the number of times the preconditioner is applied
LinearSolver Preconditioner.PowerLawIterations std::size_t 5 Number of iterations done to estimate the relaxation factor within the Uzawa algorithm.
LinearSolver Preconditioner.Relaxation double 1.0 The relaxation parameter for the preconditioner
LinearSolver Preconditioner.Type std::string - The preconditioner type.
LinearSolver Preconditioner.Verbosity int 0 The preconditioner verbosity level
LinearSolver ResidualReduction double 1e-13(linear solver),1e-6(nonlinear) The residual reduction threshold, i.e. stopping criterion
LinearSolver Restart int 10 cycles before restarting
LinearSolver Type std::string - The type of linear solver, e.g. restartedflexiblegmressolver or uzawa
LinearSolver Verbosity int 0 The verbosity level of the linear solver
LoadSolution CellCenterPriVarNames std::vector<std::string> - Names of cell-centered primary variables of a model with staggered grid discretization
LoadSolution FacePriVarNames std::vector<std::string> - Names of primary variables on the cell faces of a model with staggered grid discretization
LoadSolution PriVarNames std::vector<std::string> - Primary variable names
LoadSolution PriVarNamesState... std::vector<std::string> - Primary variable names state, e.g. p_liq S_gas
MPFA Q CoordScalar = GridView::ctype - The quadrature point parameterizaion to be used on scvfs
MPFA ZeroEffectiveDiffusionCoefficientThreshold Scalar 1e-16 The threshold for zero effective diffusion coefficient, used for epsilon computation
MatrixConverter DeletePatternEntriesBelowAbsThreshold Scalar -1.0 Only set non-zero value if original matrix entry is larger than this.
MixedDimension IntegrationOrder int 1 The integration order for coupling source
MixedDimension KernelIntegrationCRL double 0.1 The characteristic relative length
MixedDimension KernelWidthFactor Scalar - The kernel width factor
MixedDimension NumCircleSegments int - The number of circle segments in the context of integration points.
MixedDimension Projection.ConsiderFacesWithinBoundingBoxCoupled bool false determines if all 3D boundary facets within the mesh bounding box should be considered as coupling
MixedDimension Projection.CoupledAngleFactor Scalar 0.3 angle threshold in which to search for coupled elements (angle in radians from surface normal vector)
MixedDimension Projection.CoupledBoundingBoxShrinkingFactor Scalar 1e-2 if ConsiderFacesWithinBoundingBoxCoupled=true shrink the bounding box in all directions by this factor
MixedDimension Projection.CoupledRadiusFactor Scalar 0.1 threshold distance in which to search for coupled elements (specified as multiple of radius)
MixedDimension Projection.EnableIntersectionOutput bool false set to true to enable debug VTK output for intersections
MixedDimension Projection.EstimateNumberOfPointSources std::size_t bulkFvGridGeometry.gridView().size(0) provide an estimate for the expected number of coupling points for memory allocation
MixedDimension Projection.SimplexIntegrationRefine std::size_t 4 The number of virtual refinement steps to determine coupled surface area.
MixedDimension UseCircleAverage bool true if we use the circle average as the 3D values or a point evaluation
MixedDimension WriteIntegrationPointsToFile bool false Whether to write integration points to a file
Newton AllowedSaturationChange Scalar -1.0 Maximum allowed (relative or absolute) shift of saturation between to consecutive time steps. If this is not set, any shift is allowed. If SaturationChangeIsRelative is true, relative shifts are considered (while not dividing by zero). If SaturationChangeIsRelative is false, absolute shifts are considered.
Newton EnableAbsoluteResidualCriterion bool false For Newton iterations to stop the absolute residual is demanded to be below a threshold value. At least two iterations.
Newton EnableChop bool false chop the Newton update at the beginning of the non-linear solver
Newton EnableDynamicOutput bool true Prints current information about assembly and solution process in the coarse of the simulation.
Newton EnablePartialReassembly bool false Every entity where the primary variables exhibit a relative shift summed up since the last linearization above 'eps' will be reassembled.
Newton EnableResidualCriterion bool false declare convergence if the initial residual is reduced by the factor ResidualReduction
Newton EnableShiftCriterion bool true For Newton iterations to stop the maximum relative shift abs(uLastIter - uNew)/scalarmax(1.0, abs(uLastIter + uNew)*0.5) is demanded to be below a threshold value. At least two iterations.
Newton LineSearchMinRelaxationFactor Scalar 0.125 A minimum relaxation factor for the line search process.
Newton MaxAbsoluteResidual Scalar 1e-5 The maximum acceptable absolute residual for declaring convergence
Newton MaxRelativeShift Scalar 1e-8 Set the maximum acceptable difference of any primary variable between two iterations for declaring convergence
Newton MaxSteps int 18 The number of iterations after we give up
Newton MaxTimeStepDivisions std::size_t 10 The maximum number of time-step divisions
Newton MinSteps int 2 The minimum number of iterations
Newton PlausibilityCheck bool false If this is set true, an error is thrown is a saturation is not between zero and one.
Newton ReassemblyMaxThreshold Scalar 1e2 * MaxRelativeShift 'maxEps' in reassembly threshold max( minEps, min(maxEps, omega*(currently achieved maximum relative shift)) ). Increasing/decreasing 'maxEps' leads to less/more reassembly if 'omega*shift' is large, i.e., for the first Newton iterations.
Newton ReassemblyMinThreshold Scalar 1e-1 * MaxRelativeShift 'minEps' in reassembly threshold max( minEps, min(maxEps, omega*(currently achieved maximum relative shift)) ). Increasing/decreasing 'minEps' leads to less/more reassembly if 'omega*shift' is small, i.e., for the last Newton iterations.
Newton ReassemblyShiftWeight Scalar 1e-3 'omega' in reassembly threshold max( minEps, min(maxEps, omega*(currently achieved maximum relative shift)) ). Increasing/decreasing 'maxEps' leads to less/more reassembly if 'omega*shift' is large, i.e., for the first Newton iterations.
Newton ResidualReduction Scalar 1e-5 The maximum acceptable residual norm reduction
Newton RetryTimeStepReductionFactor Scalar 0.5 Factor for reducing the current time-step
Newton SatisfyResidualAndShiftCriterion bool false declare convergence only if both criteria are met
Newton SaturationChangeIsRelative bool false See explanation of AllowedSaturationChange.
Newton TargetSteps int 10 The number of iterations which are considered "optimal"
Newton UseLineSearch bool false Whether to use line search
Newton Verbosity int 2 The verbosity level of the Newton solver
PointSource EnableBoxLumping bool true For a DOF-index to point source map distribute source using a check if point sources are inside a subcontrolvolume instead of using basis function weights.
PrimaryVariableSwitch Verbosity int 1 Verbosity level of the primary variable switch.
Problem EnableGravity bool - Whether to enable the gravity term
Problem EnableInertiaTerms bool - Whether to enable the inertia terms
Problem Name std::string "sim" Set a name for a problem
RANS EddyViscosityModel std::string "vanDriest" Choose the eddy viscosity model
RANS FlowDirectionAxis int 0 The flow direction axis
RANS IsFlatWallBounded bool false Set to true, if geometry consists of flat walls
RANS SSTModelVersion std::string "SST" the model version of the SST model
RANS SandGrainRoughness Scalar - The roughness of a sand grain
RANS TurbulentPrandtlNumber Scalar 1.0 The turbulent Prandtl number
RANS TurbulentSchmidtNumber Scalar 1.0 The turbulent Schmidt number
RANS UseStoredEddyViscosity bool false Whether to use the stored eddy viscosity
RANS WallNormalAxis int 1 The normal wall axis of a flat wall bounded flow
RANS WriteFlatWallBoundedFields bool isFlatWallBounded Whether to write output fields for flat wall geometries
Richards UsePrimaryVariableSwitch bool - Whether to use primary variable switch in richards model
ShallowWater EnableViscousFlux bool false Whether to include a viscous flux contribution.
ShallowWater HorizontalCoefficientOfMixingLengthModel Scalar 0.1 For the turbulence model base on the mixing length: The Smagorinsky-like horizontal turbulence coefficient.
ShallowWater TurbulentViscosity Scalar the fluid viscosity The (constant) background turbulent viscosity.
ShallowWater UseMixingLengthTurbulenceModel bool false Whether the mixing-length turbulence model is used.
ShallowWater VerticalCoefficientOfMixingLengthModel Scalar 1.0 For the turbulence model base on the mixing length: The Elder-like vertical turbulence coefficient.
SimpleH2O ReferenceTemperature Scalar 293.15 The reference temperature in \(\mathrm{[K]}\) for calculating the (liquid or gas) enthalpy of simple H2O.
SpatialParams ComputeAwsFromAnsAndPcMax bool true Compute volume-specific interfacial area between the wetting and solid phase from interfacial area between nonwetting and solid phase and maximum capillary pressure.
SpatialParams ContactAngle Scalar 0.0 This contact angle \([rad]\) is set both as the contact angle within a pore throat and the one within a pore body. It can be overloaded for solution-dependent values.
SpatialParams ForchCoeff Scalar 0.55 The Forchheimer coefficient
SpatialParams Permeability Scalar - The permeability
SpatialParams PoissonRatio Scalar - The Poisson ratio of the porous medium
SpatialParams Porosity Scalar - The porosity
SpatialParams SurfaceTension Scalar 0.0725 The value of the surface tension \([N/m]\). It defaults to the surface tension of water/air.
SpatialParams Temperature Scalar 293.15 The temperature
SpatialParams Tortuosity Scalar 0.5 The tortuosity
SpatialParams YoungsModulus Scalar - The Young's modulus \(\mathrm{[Pa]}\) of the porous medium
TimeLoop Restart double 0.0 The restart time stamp for a previously interrupted simulation
TimeStepper MaxTimeStepDivisions std::size_t 10 The maximum number of time-step divisions
TimeStepper RetryTimeStepReductionFactor Scalar 0.5 Factor for reducing the current time-step
Transmissibility ConsiderPoreResistance bool true Whether or not the pore resistance should be considered on runtime.
Vtk AddProcessRank bool true Whether to add a process rank
Vtk AddVelocity bool false Whether to enable velocity output
Vtk CoordPrecision std::string precisionString The output precision of coordinates.
Vtk Precision std::string "Float32" Precision of the vtk output
Vtk WriteFaceData bool false For the staggered grid approach, write face-related data into vtp files.
- A00 Scalar 0.0 A coefficient for capillary-pressure-saturation-interfacial-area relations described by a polynomial of second order.
- A01 Scalar - A coefficient for capillary-pressure-saturation-interfacial-area relations described by a polynomial of second order.
- A02 Scalar - A coefficient for capillary-pressure-saturation-interfacial-area relations described by a polynomial of second order.
- A1 Scalar - A coefficient for capillary-pressure-saturation-interfacial-area relations described by a polynomial of second order.
- A10 Scalar - A coefficient for capillary-pressure-saturation-interfacial-area relations described by a polynomial of second order.
- A11 Scalar - A coefficient for capillary-pressure-saturation-interfacial-area relations described by a polynomial of second order.
- A2 Scalar - A coefficient for capillary-pressure-saturation-interfacial-area relations described by a polynomial of second order.
- A20 Scalar - A coefficient for capillary-pressure-saturation-interfacial-area relations described by a polynomial of second order.
- A3 Scalar - A coefficient for capillary-pressure-saturation-interfacial-area relations described by a polynomial of second order.
- BrooksCoreyLambda Scalar - Parameter lambda in Brooks Corey.
- BrooksCoreyPcEntry Scalar - Entry capillary pressure in Brooks Corey.
- BrooksCoreyPcLowSweThreshold Scalar 0.01 For effective wetting phase saturations below this value, capillary pressure is given by a regularized capillary pressure-saturation curve.
- HeatpipeLawGamma Scalar - Parameter gamma in heat pipe law.
- HeatpipeLawP0 Scalar - Parameter p0 in heat pipe law.
- HighSwRegularizationMethod std::string - A regularization method for the capillary pressure at high wetting saturations. Possible values are "Linear", "Spline" and "PowerLaw".
- HighSwSplineZeroSlope bool true Whether to use a zero slope of the capillary pressure at high wetting saturations.
- KrnData std::vector<Scalar> - Relative permeability for the non-wetting phase data for spline material law.
- KrwData std::vector<Scalar> - Relative permeability for the wetting phase data for spline material law.
- LinearPcEntry Scalar - Entry capillary pressure for the linear capillary pressure and relative permeability <-> saturation relations.
- LinearPcMax Scalar - Maximum capillary pressure for the linear capillary pressure and relative permeability <-> saturation relations.
- ParameterFile std::string executablename.input Command line argument: overwrite parameter file if one was specified on the command line
- ParkerVanGenuchtenAlpha Scalar - Shape parameter \(\mathrm{\alpha}\) \(\mathrm{[1/Pa]}\) in Parker/vanGenuchten laws.
- ParkerVanGenuchtenBetaGn Scalar 1.0 Scaling parameter \(\mathrm{betaGn}\) \(\mathrm{[-]}\) in Parker/vanGenuchten laws.
- ParkerVanGenuchtenBetaGw Scalar 1.0 Scaling parameter \(\mathrm{betaGw}\) \(\mathrm{[-]}\) in Parker/vanGenuchten laws.
- ParkerVanGenuchtenBetaNw Scalar 1.0 Scaling parameter \(\mathrm{betaNw}\) \(\mathrm{[-]}\) in Parker/vanGenuchten laws.
- ParkerVanGenuchtenKrgLowSteThreshold Scalar 1e-3 The threshold saturation below which the relative permeability of the nonwetting phase gets regularized in Parker/vanGenuchten laws.
- ParkerVanGenuchtenKrnLowSweThreshold Scalar 0.1 The threshold saturation below which the relative permeability of the nonwetting phase gets regularized in Parker/vanGenuchten laws.
- ParkerVanGenuchtenKrwHighSweThreshold Scalar 0.9 The threshold saturation above which the relative permeability of the wetting phase gets regularized in Parker/vanGenuchten laws.
- ParkerVanGenuchtenN Scalar - Shape parameter \(\mathrm{n}\) \(\mathrm{[-]}\) in Parker/vanGenuchten laws.
- ParkerVanGenuchtenPcHighSweThreshold Scalar 0.99 Threshold saturation above which the capillary pressure is regularized in Parker/vanGenuchten laws.
- ParkerVanGenuchtenPcLowSweThreshold Scalar 0.01 Threshold saturation below which the capillary pressure is regularized in Parker/vanGenuchten laws. Most problems are very sensitive to this value (e.g. making it smaller might result in very high capillary pressures).
- ParkerVanGenuchtenRegardSnrForKrn bool false In Parker/vanGenuchten laws regard the relative non-wetting saturation in the permeability of the non-wetting phase, see Helmig1997.
- PcData std::vector<Scalar> - Capillary pressure data for spline material law.
- PcMax Scalar - Maximum capillary pressure for calculating the interfacial area between the nonwetting and wetting phase as in Nuske 2014 (https://elib.uni-stuttgart.de/handle/11682/614, page 60) [59].
- RegularizationHighSw Scalar std::numeric_limits<Scalar>::quiet_NaN() The capillary pressure at high wetting saturations.
- RegularizationHighSwFixedSlope Scalar std::numeric_limits<Scalar>::quiet_NaN() A fixed slope of the capillary pressure at high wetting saturations.
- RegularizationLowSw Scalar params.pcLowSw() The capillary pressure at low wetting saturations.
- Restart double - The restart time stamp for a previously interrupted simulation
- Sgr Scalar 0.0 Residual gas phase saturation.
- SmoothedLinearLawKrHighS Scalar - If the saturation is higher than this value, smoothed linear material law changes to a spline for the relative permeability.
- SmoothedLinearLawKrLowS Scalar - If the saturation is lower than this value, smoothed linear material law changes to a spline for the relative permeability.
- SmoothedLinearLawPcMax Scalar - The maximum capillary pressure used in the smoothed linear law.
- SmoothedLinearLawPe Scalar - The entry pressure used in the smoothed linear law.
- Snr Scalar 0.0 Residual non-wetting phase saturation.
- SplineNumSwSamples std::size_t 30 Number of sample points from which the wetting saturation spline is built.
- SplineSweInterval std::array<Scalar, 2> std::array<double, 2>{{0.1, 1.0} Effective wetting saturation interval for spline material law.
- SwData std::vector<Scalar> - Wetting saturation pressure data for spline material law.
- Swr Scalar 0.0 Residual wetting phase saturation.
- ThreePNAPLAdsorptionKdNAPL Scalar - kd parameter for the adsportion of NAPL in a 3 phase simulation.
- ThreePNAPLAdsorptionRhoBulk Scalar - bulk density for calculating the adsorption of NAPL in a 3 phase simulation.
- VanGenuchtenAlpha Scalar - Shape parameter \(\mathrm{\alpha}\) \(\mathrm{[1/Pa]}\) in vanGenuchten laws.
- VanGenuchtenConstantRegularization bool false If specified, a constant value is used for regularization in Parker/vanGenuchten.
- VanGenuchtenKrnLowSweThreshold Scalar 0.1 The threshold saturation below which the relative permeability of the nonwetting phase gets regularized in vanGenuchten laws.
- VanGenuchtenKrwHighSweThreshold Scalar 0.9 The threshold saturation above which the relative permeability of the wetting phase gets regularized in vanGenuchten laws.
- VanGenuchtenL Scalar 0.5 Shape parameter \(\mathrm{m}\) \(\mathrm{[-]}\) in vanGenuchten laws.
- VanGenuchtenN Scalar - Shape parameter \(\mathrm{n}\) \(\mathrm{[-]}\) in vanGenuchten laws.
- VanGenuchtenPcHighSweThreshold Scalar 0.99 Threshold saturation above which the capillary pressure is regularized in vanGenuchten laws.
- VanGenuchtenPcLowSweThreshold Scalar 0.01 Threshold saturation below which the capillary pressure is regularized in vanGenuchten laws.