Skip to content

Commit

Permalink
Misc fixups on param groups and doco
Browse files Browse the repository at this point in the history
- fix math in AdamsPredictor
- suppress matprop params in Times as unlikely to be used
- add a param group for splits
refs #20535
  • Loading branch information
GiudGiud committed Dec 25, 2024
1 parent 0e31158 commit 6019f94
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 6 deletions.
2 changes: 1 addition & 1 deletion framework/doc/content/source/predictors/AdamsPredictor.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ B = - \dfrac{\Delta t}{\Delta t_{old}} (1 + \dfrac{\Delta t}{2\Delta t_{old}} +
!equation
C = \dfrac{\Delta t}{\Delta t_{old}} \dfrac{\Delta t}{2\Delta t_{older}}

with $\dfrac{\Delta t}$, $\dfrac{\Delta t_{old}}$ and $\dfrac{\Delta t_{older}}$
with $\Delta t$, $\Delta t_{old}$ and $\Delta t_{older}$
being the current, previous and antepenultimate time steps sizes.

## Example input syntax
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ ElementIntegralVariablePostprocessor::validParams()
params.addRequiredCoupledVar("variable", "The name of the variable that this object operates on");
params.addClassDescription("Computes a volume integral of the specified variable");
params.addParam<bool>(
"use_absolute_value", false, "Whether to use abolsute value of the variable or not");
"use_absolute_value", false, "Whether to use absolute value of the variable or not");
return params;
}

Expand Down
6 changes: 4 additions & 2 deletions framework/src/splits/Split.C
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ Split::validParams()
params.addParam<std::vector<SubdomainName>>(
"blocks", {}, "Mesh blocks Split operates on (omitting this implies \"all blocks\"");
params.addParam<std::vector<BoundaryName>>(
"sides", {}, "Sidesets Split operates on (omitting this implies \"no sidesets\"");
"sides", {}, "Sidesets Split operates on (omitting this implies \"all sidesets\")");
params.addParam<std::vector<BoundaryName>>(
"unsides",
{},
"Sidesets Split excludes (omitting this implies \"do not exclude any sidesets\"");
"Sidesets Split excludes (omitting this implies \"do not exclude any sidesets\")");
params.addParam<std::vector<std::string>>(
"splitting", {}, "The names of the splits (subsystems) in the decomposition of this split");
params.addParam<std::vector<BoundaryName>>(
Expand All @@ -40,6 +40,8 @@ Split::validParams()
params.addParam<std::vector<NonlinearVariableName>>(
"unside_by_var_var_name",
"A map from boundary name to unside by variable, e.g. only unside for a given variable.");
params.addParamNamesToGroup("sides unsides unside_by_var_boundary_name unside_by_var_var_name",
"Sideset restriction");

MooseEnum SplittingTypeEnum("additive multiplicative symmetric_multiplicative schur", "additive");
params.addParam<MooseEnum>("splitting_type", SplittingTypeEnum, "Split decomposition type");
Expand Down
6 changes: 6 additions & 0 deletions framework/src/times/Times.C
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ Times::validParams()
params.addRequiredParam<bool>("auto_broadcast",
"Wether Times should be broadcasted across all ranks");
params.addParamNamesToGroup("auto_broadcast auto_sort unique_times unique_tolerance", "Advanced");

// Unlikely to ever be used as Times do not loop over the mesh and use material properties,
// let alone stateful
params.suppressParameter<MaterialPropertyName>("prop_getter_suffix");
params.suppressParameter<bool>("use_interpolated_state");

params.registerBase("Times");
return params;
}
Expand Down
3 changes: 1 addition & 2 deletions framework/src/variables/MooseVariableBase.C
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,8 @@ MooseVariableBase::validParams()
"nl0",
"If this variable is a solver variable, this is the "
"solver system to which it should be added.");
params.addParamNamesToGroup("scaling eigen", "Advanced");

params.addParam<bool>("use_dual", false, "True to use dual basis for Lagrange multipliers");
params.addParamNamesToGroup("scaling eigen use_dual", "Advanced");

params.registerBase("MooseVariableBase");
params.addPrivateParam<SystemBase *>("_system_base");
Expand Down

0 comments on commit 6019f94

Please sign in to comment.