From be43b03805887e2109daf0efc91126b3d40fd439 Mon Sep 17 00:00:00 2001 From: Mathis Kelm Date: Mon, 26 Sep 2022 15:22:01 +0200 Subject: [PATCH] [doc] Update parameterlist --- .../extradoc/known_parameter_warnings.json | 12 +++-- doc/doxygen/extradoc/parameterlist.txt | 23 +++++---- doc/doxygen/extradoc/parameters.json | 48 ++++++++++++++++--- 3 files changed, 62 insertions(+), 21 deletions(-) diff --git a/doc/doxygen/extradoc/known_parameter_warnings.json b/doc/doxygen/extradoc/known_parameter_warnings.json index 0b34f60e10..67800a6547 100644 --- a/doc/doxygen/extradoc/known_parameter_warnings.json +++ b/doc/doxygen/extradoc/known_parameter_warnings.json @@ -12,7 +12,6 @@ "grading[i] = getParamFromGroup>(modelParamGroup, \"Grid.Grading\" + std::to_string(i), grading[i]);" ], "dumux/io/grid/porenetwork/structuredlatticegridcreator.hh": [ - "grading[i] = getParamFromGroup>(modelParamGroup, \"Grid.Grading\" + std::to_string(i), grading[i]);", "positions[i] = getParamFromGroup>(paramGroup_, \"Grid.Positions\" + std::to_string(i), std::vector{});", "grading[i] = getParamFromGroup>(paramGroup_, \"Grid.Grading\" + std::to_string(i), grading[i]);" ], @@ -37,10 +36,7 @@ "const Scalar inputThroatInscribedRadius = getParamFromGroup(paramGroup_, prefix + \"ThroatInscribedRadius\", -1.0);", "const Scalar throatN = getParamFromGroup(paramGroup_, prefix + \"ThroatInscribedRadiusN\", 0.1);", "const Scalar inputThroatLength = getParamFromGroup(paramGroup_, prefix + \"ThroatLength\", -1.0);", - "const bool substractRadiiFromThroatLength = getParamFromGroup(paramGroup_, prefix + \"SubstractRadiiFromThroatLength\", true);", - "// TODO remove if/else after 3.5 and use const bool subtractRadiiFromThroatLength = getParamFromGroup(paramGroup_, prefix + \"SubtractPoreInscribedRadiiFromThroatLength\", true);", - "subtractRadiiFromThroatLength = getParamFromGroup(paramGroup_, prefix + \"SubstractRadiiFromThroatLength\");", - "subtractRadiiFromThroatLength = getParamFromGroup(paramGroup_, prefix + \"SubtractPoreInscribedRadiiFromThroatLength\", true);" + "const bool subtractRadiiFromThroatLength = getParamFromGroup(paramGroup_, prefix + \"SubtractPoreInscribedRadiiFromThroatLength\", true);" ], "dumux/freeflow/navierstokes/staggered/velocitygradients.hh": [ "static const bool unsymmetrizedGradientForBJ = getParamFromGroup(problem.paramGroup(),", @@ -66,5 +62,11 @@ ], "dumux/assembly/boxlocalassembler.hh": [ "static const bool updateAllVolVars = getParamFromGroup(" + ], + "dumux/assembly/fcdiamondlocalassembler.hh": [ + "static const bool updateAllVolVars = getParamFromGroup(" + ], + "dumux/assembly/pq1bubblelocalassembler.hh": [ + "static const bool updateAllVolVars = getParamFromGroup(" ] } diff --git a/doc/doxygen/extradoc/parameterlist.txt b/doc/doxygen/extradoc/parameterlist.txt index 6618c447dd..ede44f0769 100644 --- a/doc/doxygen/extradoc/parameterlist.txt +++ b/doc/doxygen/extradoc/parameterlist.txt @@ -24,10 +24,12 @@ * | 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 | - * | \b Assembly | Multithreading | bool | true | Whether to enable multi-threaded assembly | + * | \b 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 | 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 | * | \b BinaryCoefficients | GasDiffCoeff | Scalar | - | The binary diffusion coefficient in gas | * | BinaryCoefficients | LiquidDiffCoeff | Scalar | - | The binary diffusion coefficient in liquid | * | \b Brine | Salinity | Scalar | - | The salinity | @@ -48,7 +50,7 @@ * | 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 temperature in \f$\mathrm{[K]}\f$ used when calculating the specific internal energy of a constant component as a liquid. | + * | Component | ReferenceTemperature | Scalar | 293.15 | The reference temperature 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 | @@ -85,10 +87,9 @@ * | 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 | * | \b 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 | 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 | - | 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 | - | 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 | BoundaryPoreLabels | std::vector | - | 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. | @@ -146,6 +147,7 @@ * | 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 | - | Whether the throats on the boundary should be removed. | + * | Grid | Repeat | std::array | 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. | @@ -162,12 +164,13 @@ * | Grid | Subregion0,1,....PoreLabelsToSetFixedRadius | std::vector | std::vector{} | Labels of pores of pores bodies within this subregion which should be treated by setting a fixed radius. | * | Grid | Subregion0,1,....PoreRadiusFactorForLabel | std::vector | std::vector{} | 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 subtract the pore radii from the throat length or not for a pore throat belonging to this subregion. | + * | 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 | SubstractRadiiFromThroatLength | 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 | 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. | @@ -180,7 +183,7 @@ * | Grid | UpstreamPositions0/1/2 | std::vector | - | 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 | * | \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 | std::vector{Labels::outlet} | A vector of labels of throats. Block non-wetting phase flux out of the outlet. | + * | InvasionState | BlockNonwettingPhaseAtThroatLabel | std::vector | std::vector{} | 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 | @@ -235,7 +238,7 @@ * | \b 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 | 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 | @@ -282,7 +285,7 @@ * | RANS | SSTModelVersion | std::string | "SST" | the model version of the SST model | * | 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 | UseStoredEddyViscosity | bool | true | 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. | diff --git a/doc/doxygen/extradoc/parameters.json b/doc/doxygen/extradoc/parameters.json index 52ba5902d8..1c352df424 100644 --- a/doc/doxygen/extradoc/parameters.json +++ b/doc/doxygen/extradoc/parameters.json @@ -341,6 +341,18 @@ "Whether to refine where source terms are specified" ] }, + "Assembly.FCDiamondVolVarsDependOnAllElementDofs": { + "defaultValue": [ + "false" + ], + "explanation": [ + "Whether to update all volvars in the stencil or only those of the associated scv" + ], + "mode": "manual", + "type": [ + "bool" + ] + }, "Assembly.Multithreading": { "explanation": [ "Whether to enable multi-threaded assembly" @@ -361,6 +373,18 @@ "The numeric difference method (1: forward differences (default), 0: central differences, -1: backward differences)" ] }, + "Assembly.PQ1BubbleVolVarsDependOnAllElementDofs": { + "defaultValue": [ + "false" + ], + "explanation": [ + "Whether to update all volvars in the stencil or only those of the associated scv" + ], + "mode": "manual", + "type": [ + "bool" + ] + }, "BinaryCoefficients.GasDiffCoeff": { "explanation": [ "The binary diffusion coefficient in gas" @@ -675,11 +699,6 @@ "std::vector" ] }, - "Grid.BoundaryFaceMarker": { - "explanation": [ - "With this, the boundary faces can be set in the format xmin xmax ymin ymax (zmin zmax)." - ] - }, "Grid.BoundaryPoreLabels": { "explanation": [ "With this, the boundary faces can be set in the format xmin xmax ymin ymax (zmin zmax)." @@ -1100,6 +1119,11 @@ "Whether the throats on the boundary should be removed." ] }, + "Grid.Repeat": { + "explanation": [ + "Number of times to repeat the subgrid pattern in each dimension." + ] + }, "Grid.RightBoundary": { "explanation": [ "The end coordinate of a 1D grid" @@ -1331,7 +1355,19 @@ "GlobalPosition" ] }, - "Grid.SubstractRadiiFromThroatLength": { + "Grid.Subregion0,1,....SubstractPoreInscribedRadiiFromThroatLength": { + "defaultValue": [ + "true" + ], + "explanation": [ + "Decide whether to subtract the pore radii from the throat length or not for a pore throat not belonging to a subregion." + ], + "mode": "manual", + "type": [ + "bool" + ] + }, + "Grid.SubstractPoreInscribedRadiiFromThroatLength": { "defaultValue": [ "true" ], -- GitLab