FieldSplitPreconditioner.C File Reference

Go to the source code of this file.


InputParameters validParams< FieldSplitPreconditioner > ()

Function Documentation

Definition at line 32 of file FieldSplitPreconditioner.C.

33 {
36  params.addParam<std::vector<std::string>>(
37  "off_diag_row",
38  "The off diagonal row you want to add into the matrix, it will be associated "
39  "with an off diagonal column from the same position in off_diag_colum.");
40  params.addParam<std::vector<std::string>>("off_diag_column",
41  "The off diagonal column you want to add into the "
42  "matrix, it will be associated with an off diagonal "
43  "row from the same position in off_diag_row.");
44  // We should use full coupling Jacobian matrix by default
45  params.addParam<bool>("full",
46  true,
47  "Set to true if you want the full set of couplings. Simply "
48  "for convenience so you don't have to set every off_diag_row "
49  "and off_diag_column combination.");
50  params.addRequiredParam<std::vector<std::string>>(
51  "topsplit", "entrance to splits, the top split will specify how splits will go.");
52  return params;
53 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< MoosePreconditioner >()
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
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...