SingleMatrixPreconditioner.C File Reference

Go to the source code of this file.


InputParameters validParams< SingleMatrixPreconditioner > ()

Function Documentation

Definition at line 27 of file SingleMatrixPreconditioner.C.

28 {
31  params.addParam<std::vector<NonlinearVariableName>>(
32  "off_diag_row",
33  "The off diagonal row you want to add into the matrix, it will be associated "
34  "with an off diagonal column from the same position in off_diag_colum.");
35  params.addParam<std::vector<NonlinearVariableName>>(
36  "off_diag_column",
37  "The off diagonal column you want to add into the matrix, it will be "
38  "associated with an off diagonal row from the same position in "
39  "off_diag_row.");
40  params.addParam<std::vector<NonlinearVariableName>>(
41  "coupled_groups",
42  "List multiple space separated groups of comma separated variables. "
43  "Off-diagonal jacobians will be generated for all pairs within a group.");
44  params.addParam<bool>("full",
45  false,
46  "Set to true if you want the full set of couplings. Simply "
47  "for convenience so you don't have to set every "
48  "off_diag_row and off_diag_column combination.");
50  return params;
51 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< MoosePreconditioner >()
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...