www.mooseframework.org
Classes | Functions
ReferenceResidualProblem.h File Reference

Go to the source code of this file.

Classes

class  ReferenceResidualProblem
 FEProblemBase derived class to enable convergence checking relative to a user-specified postprocessor. More...
 

Functions

template<>
InputParameters validParams< ReferenceResidualProblem > ()
 

Function Documentation

template<>
InputParameters validParams< ReferenceResidualProblem > ( )

Definition at line 18 of file ReferenceResidualProblem.C.

Referenced by validParams< AugmentedLagrangianContactProblem >().

19 {
20  InputParameters params = validParams<FEProblem>();
21  params.addClassDescription("Problem that checks for convergence relative to "
22  "a user-supplied reference quantity rather than "
23  "the initial residual");
24  params.addParam<std::vector<std::string>>(
25  "solution_variables", "Set of solution variables to be checked for relative convergence");
26  params.addParam<std::vector<std::string>>(
27  "reference_residual_variables",
28  "Set of variables that provide reference residuals for relative convergence check");
29  params.addParam<Real>("acceptable_multiplier",
30  1.0,
31  "Multiplier applied to relative tolerance for acceptable limit");
32  params.addParam<int>("acceptable_iterations",
33  0,
34  "Iterations after which convergence to acceptable limits is accepted");
35  return params;
36 }