diff --git a/doc/doxygen/extradoc/parameterlist.txt b/doc/doxygen/extradoc/parameterlist.txt
index 182982d2fef4ef5aad3df37cfaed2140303af3e9..f93377a30086bbd1bb915e3716729a17ddc8f97e 100644
--- a/doc/doxygen/extradoc/parameterlist.txt
+++ b/doc/doxygen/extradoc/parameterlist.txt
@@ -25,6 +25,8 @@
* | - | HeatpipeLawGamma | Scalar | - | Parameter gamma in heat pipe law. |
* | - | HeatpipeLawP0 | Scalar | - | Parameter p0 in heat pipe law. |
* | - | KrnData | std::vector<Scalar> | - | Relative permeability for the non-wetting phase data for spline material 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. |
* | - | 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. |
@@ -42,6 +44,9 @@
* | - | 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) \cite nuske2014. |
+ * | - | 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. |
@@ -82,9 +87,12 @@
* | 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 | LiquidHeatCapacity | Scalar | - | Specific isobaric heat capacity of the component \f$\mathrm{[J/(kg*K)]}\f$ as a liquid. |
* | Component | LiquidKinematicViscosity | Scalar | - | The liquid kinematic viscosity |
+ * | Component | LiquidThermalConductivity | Scalar | - | Thermal conductivity of the component \f$\mathrm{[W/(m*K)]}\f$ 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 termperature in \f$\mathrm{[K]}\f$ 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 |
@@ -92,6 +100,7 @@
* | 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 | pO2Inlet | Scalar | - | The oxygen pressure at the inlet. |
* | 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. |
@@ -101,7 +110,6 @@
* | 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. |
* | \b FacetCoupling | Xi | Scalar | 1.0 | The xi factor for coupling conditions |
* | \b Flux | DifferencingScheme | std::string | Minmod | Choice of a staggered TVD method |
* | 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). |
@@ -113,17 +121,24 @@
* | \b 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 |
* | \b 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. |
- * | \b 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. |
+ * | 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. |
+ * | \b Grid | AddThroatVolumeToPoreVolume | bool | false | Whether to add the throat volume to the pore volume. |
+ * | Grid | AllowIntersectingDiagonals | bool | true | Wether 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 | BoundaryFaceMarker | BoundaryList | - | 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 | CellType | std::string | Cube | "Cube" or "Simplex" to be used for structured grids |
+ * | 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 | Cells | std::array<int, dim> | - | The number of elements in a structured uniform grid in x, y and z direction |
* | Grid | Cells0 | 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 | Cells1 | std::vector<int> | - | Spaceseparated list of the number of cells per zone in y-direction (see more details for x-direction in Cells1). |
* | Grid | Cells2 | std::vector<int> | - | Spaceseparated list of the number of cells per zone in z-direction (see more details for x-direction in Cells1). |
+ * | Grid | CellType | std::string | Cube | "Cube" or "Simplex" to be used for structured grids |
* | 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<ctype> | - | To construct a 1D grid with just a coordinates vector |
+ * | Grid | DeletionProbability | std::array<double, numDirections> | - | For a non-regular lattice, you must specifiy 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 | File | std::string | - | A DGF or gmsh file to load from |
* | Grid | GmshPhysicalEntityThreshold | std::size_t | 0 | |
@@ -135,18 +150,67 @@
* | Grid | LeftBoundary | Scalar | 0.0 | The start coordinate of a 1D grid |
* | Grid | LowerLeft | GlobalPosition | - | The lowerLeft corner of a structured grid |
* | Grid | Marker | bool | 0 | To customize the subgrid generation. |
+ * | Grid | MinThroatLength | Scalar | 1e-6 | The minimum pore throat length. |
+ * | Grid | NumPores | std::array<unsigned int, dimWorld>| - | 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 | 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 | Positions0 | std::vector<ctype> | - | For a grid with zones, x-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 | Positions1 | std::vector<ctype> | - | For a grid with zones, y-positions for zoning in y (more details in Positions0 for x). |
* | Grid | Positions2 | std::vector<ctype> | - | For a grid with zones, z-positions for zoning in z (more details in Positions0 for x).|
+ * | 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 | RightBoundary | Scalar | - | 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(makeFromDgf),true(makeFromStructure)| 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 | 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 | ThroatLength | Scalar | -1.0 | A user-specified fixed throat lenght. |
+ * | 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 | Verbosity | bool | false | Whether the grid construction should output to standard out |
+ * | 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. | 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. | 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. | 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>{} | Lables 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>{} | Lables 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. | StandardDeviationPoreInscribedRadius | Scalar | - | In the case of a lognormal random distribution, this specifies the standard deviation of the pore radius. |
+ * | Grid. | SubstractRadiiFromThroatLength | bool | true | Decide whether to substract the pore radii from the throat length or not for a pore throat not belonging to a subregion. |
+ * | 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 | Length of a pore throat not belonging to a subregion. |
+ * | \b 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>{} | Lables 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>{} | Lables 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,... | SubstractRadiiFromThroatLength | bool | true | Decide whether to substract 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. |
* | \b GridAdapt | AdaptionInterval | int | 1 | The time step interval for adaption |
* | GridAdapt | CoarsenTolerance | Scalar | 0.001 | Coarsening threshold to decide whether a cell should be marked for coarsening |
* | GridAdapt | EnableInitializationIndicator | bool | false | Whether to use initial grid adaption |
@@ -172,6 +236,10 @@
* | Impet | RestrictFluxInTransport | int | 0 | Restriction of flux on new pressure field if direction reverses from the pressure equation |
* | Impet | SubCFLFactor | Scalar | 1.0 | Scalar factor for scaling of local sub-time-step |
* | Impet | SwitchNormals | bool | false | Whether to switch direction of face normal vectors |
+ * | \b 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>{Labels::outlet} | 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. |
* | \b KEpsilon | EnableZeroEqScaling | bool | true | Whether to match the potential zeroeq eddy viscosities for two-layer model at the matching point |
* | KEpsilon | YPlusThreshold | Scalar | 30 | yPlus below this value is considered as near-wall region |
* | \b KOmega | EnableDissipationLimiter | bool | true | Whether to enable the dissipation limiter |
@@ -212,20 +280,14 @@
* | 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 | UMFPackOrdering | int | 1 | You can chosse from one of the following ordering strategies: 0: UMFPACK_ORDERING_CHOLMOD, 1: UMFPACK_ORDERING_AMD (default), 2: UMFPACK_ORDERING_GIVEN, 3: UMFPACK_ORDERING_METIS, 4: UMFPACK_ORDERING_BEST, 5: UMFPACK_ORDERING_NONE, 6: UMFPACK_ORDERING_USER. See https://fossies.org/linux/SuiteSparse/UMFPACK/Doc/UMFPACK_UserGuide.pdf page 17 for details.|
* | LinearSolver | Verbosity | int | 0 | The verbosity level of the linear solver |
* | \b 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 |
* | LoadSolution | PriVarNamesState1 | std::vector<std::string> | - | Primary variable names state, e.g. p_liq x^N2_liq |
* | LoadSolution | PriVarNamesState2 | std::vector<std::string> | - | Primary variable names state, e.g. p_liq x^H2O_gas |
- * | LoadSolution | PriVarNamesState... | std::vector<std::string> | - | Primary variable names state, e.g. p_liq S_gas |
- * | \b MPFA | CalcVelocityInTransport | bool | - | Indicates if velocity is reconstructed in the pressure step or in the transport step |
- * | MPFA | EnableComplexLStencil | bool | true | Whether to enable the two non-centered flux stencils |
- * | MPFA | EnableSimpleLStencil | bool | true | Whether to enable the two centered flux stencils |
- * | MPFA | EnableTPFA | bool | false | Whether to enable the use of TPFA if neighboring cells are of the same grid level |
- * | MPFA | Q | CoordScalar | - | The quadrature point parameterizaion to be used on scvfs |
- * | MPFA | TransmissibilityCriterion | int | 0 | |
- * | MPFA | TransmissibilityCriterionThreshold | Scalar | 1e-8 | |
* | \b MatrixConverter | DeletePatternEntriesBelowAbsThreshold | Scalar | -1.0 | Only set non-zero value if original matrix entry is larger than this. |
* | \b MixedDimension | IntegrationOrder | int | 1 | The integration order for coupling source |
* | MixedDimension | KernelIntegrationCRL | double | 0.1 | The characteristic relative length |
@@ -233,23 +295,34 @@
* | MixedDimension | NumCircleSegments | int | - | The number of circle segements in the context of integration points. |
* | 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 |
- * | \b Newton | EnableAbsoluteResidualCriterion | bool | - | For Newton iterations to stop the absolute residual is demanded to be below a threshold value. At least two iterations. |
+ * | \b MPFA | CalcVelocityInTransport | bool | - | Indicates if velocity is reconstructed in the pressure step or in the transport step |
+ * | MPFA | EnableComplexLStencil | bool | true | Whether to enable the two non-centered flux stencils |
+ * | MPFA | EnableSimpleLStencil | bool | true | Whether to enable the two centered flux stencils |
+ * | MPFA | EnableTPFA | bool | false | Whether to enable the use of TPFA if neighboring cells are of the same grid level |
+ * | MPFA | Q | CoordScalar | - | The quadrature point parameterizaion to be used on scvfs |
+ * | MPFA | TransmissibilityCriterion | int | 0 | |
+ * | MPFA | TransmissibilityCriterionThreshold | Scalar | 1e-8 | |
+ * | \b 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 | - | For Newton iterations to stop the absolute residual is demanded to be below a threshold value. At least two iterations. |
* | Newton | EnableChop | bool | - | 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 | - | Every entity where the primary variables exhibit a relative shift summed up since the last linearization above 'eps' will be reassembled. |
* | Newton | EnableResidualCriterion | bool | - | declare convergence if the initial residual is reduced by the factor ResidualReduction |
* | Newton | EnableShiftCriterion | bool | - | 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 serach process. |
* | Newton | MaxAbsoluteResidual | Scalar | - | The maximum acceptable absolute residual for declaring convergence |
* | Newton | MaxRelativeShift | Scalar | - | Set the maximum acceptable difference of any primary variable between two iterations for declaring convergence |
* | Newton | MaxSteps | int | - | The number of iterations after we give up |
* | Newton | MaxTimeStepDivisions | std::size_t | 10 | The maximum number of time-step divisions |
* | Newton | MinSteps | int | - | 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*shiftTolerance_ | '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*shiftTolerance_ | '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 | - | The maximum acceptable residual norm reduction |
* | Newton | RetryTimeStepReductionFactor | Scalar | 0.5 | Factor for reducing the current time-step |
* | Newton | SatisfyResidualAndShiftCriterion | bool | - | declare convergence only if both criteria are met |
+ * | Newton | SaturationChangeIsRelative | Scalar | false | See explanatio of AllowedSaturationChange. |
* | Newton | TargetSteps | int | - | The number of iterations which are considered "optimal" |
* | Newton | UseLineSearch | bool | - | Whether to use line search |
* | Newton | Verbosity | int | 2 | The verbosity level of the Newton solver |
@@ -268,11 +341,19 @@
* | RANS | UseStoredEddyViscosity | bool | true for lowrekepsilon, false else | 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 |
+ * | \b 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 | 1.0e-6 | 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. |
+ * | \b SimpleH2O | ReferenceTemperature | Scalar | 293.15 | The reference temperature in \f$\mathrm{[K]}\f$ for calculating the (liquid or gas) enthalpy of simple H2O. |
* | \b 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 \f$[rad]\f$ 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 | MinBoundaryPermeability | Scalar | - | The minimum permeability |
* | SpatialParams | Permeability | Scalar | - | The permeability |
* | SpatialParams | Porosity | Scalar | - | The porosity |
+ * | SpatialParams | SurfaceTension | Scalar | 0.0725 | The value of the surface tension \f$[N/m]\f$. It defaults to the surface tension of water/air. |
* | SpatialParams | Tortuosity | Scalar | 0.5 | The tortuosity |
* | \b TimeLoop | Restart | double | 0.0 | The restart time stamp for a previously interrupted simulation |
* | \b TimeManager | DtInitial | Scalar | - | The initial time step size |
@@ -280,6 +361,7 @@
* | TimeManager | Restart | Scalar | - | The restart time stamp for a previously interrupted simulation |
* | TimeManager | SubTimestepVerbosity | int | - | The verbosity level in local sub-time-steps |
* | TimeManager | TEnd | Scalar | - | The end time |
+ * | \b Transmissibility | ConsiderPoreResistance | bool | true | Whether or not the pore resistance should be considered on runtime. |
* | \b Vtk | AddProcessRank | bool | - | Whether to add a process rank |
* | Vtk | AddVelocity | bool | true | Whether to enable velocity output |
* | Vtk | CoordPrecision | std::string | value set to Vtk.Precision before | The output precision of coordinates. |
diff --git a/dumux/material/components/h2o.hh b/dumux/material/components/h2o.hh
index 48b176becee0d4efcce9079468876d9726cfb2bb..3d0b6cf21c0b1a8b407e62b2124366dec459eeb9 100644
--- a/dumux/material/components/h2o.hh
+++ b/dumux/material/components/h2o.hh
@@ -965,7 +965,7 @@ namespace FluidSystems {
* "Reid, R.C., Prausnitz, J.M., Poling, B.E.: The Properties of
* Gases and Liquids (1987)"
* Lucas corresponding states method
- * https://www.osti.gov/scitech/biblio/6504847} \cite reid1987
+ * https://www.osti.gov/scitech/biblio/6504847 \cite reid1987
*
* For temperatures above 500 K see:
* Nagel, T. et al.: THC-Processes (2018)
diff --git a/dumux/material/spatialparams/porenetwork/porenetwork2p.hh b/dumux/material/spatialparams/porenetwork/porenetwork2p.hh
index 8ec48f9de5649117a959cabd70ec2f3382672d1f..dfa97886238b91206fcbf97dc1104d5fae766c8c 100644
--- a/dumux/material/spatialparams/porenetwork/porenetwork2p.hh
+++ b/dumux/material/spatialparams/porenetwork/porenetwork2p.hh
@@ -103,7 +103,7 @@ public:
Scalar contactAngle(const Element& element,
const ElementVolumeVariables& elemVolVars) const
{
- static const Scalar theta = getParam<Scalar>("SpatialParameters.ContactAngle", 0.0);
+ static const Scalar theta = getParam<Scalar>("SpatialParams.ContactAngle", 0.0);
return theta;
}
@@ -120,7 +120,7 @@ public:
const SubControlVolume& scv,
const ElementSolutionVector& elemSol) const
{
- static const Scalar theta = getParam<Scalar>("SpatialParameters.ContactAngle", 0.0);
+ static const Scalar theta = getParam<Scalar>("SpatialParams.ContactAngle", 0.0);
return theta;
}
@@ -157,7 +157,7 @@ public:
}
/*!
- * \brief Returns the surface tension \f$ N/m\f$
+ * \brief Returns the surface tension \f$ [N/m] \f$
*
* \param element The current element
* \param scv The sub-control volume inside the element.