FiniteDifferencePreconditioner.C File Reference

Go to the source code of this file.


InputParameters validParams< FiniteDifferencePreconditioner > ()

Function Documentation

Definition at line 26 of file FiniteDifferencePreconditioner.C.

27 {
30  params.addParam<std::vector<std::string>>(
31  "off_diag_row",
32  "The off diagonal row you want to add into the matrix, it will be associated "
33  "with an off diagonal column from the same position in off_diag_colum.");
34  params.addParam<std::vector<std::string>>("off_diag_column",
35  "The off diagonal column you want to add into the "
36  "matrix, it will be associated with an off diagonal "
37  "row from the same position in off_diag_row.");
38  params.addParam<bool>("full",
39  false,
40  "Set to true if you want the full set of couplings. Simply "
41  "for convenience so you don't have to set every "
42  "off_diag_row and off_diag_column combination.");
43  params.addParam<bool>("implicit_geometric_coupling",
44  false,
45  "Set to true if you want to add entries into the "
46  "matrix for degrees of freedom that might be coupled "
47  "by inspection of the geometric search objects.");
49  MooseEnum finite_difference_type("standard coloring", "coloring");
50  params.addParam<MooseEnum>("finite_difference_type",
51  finite_difference_type,
52  "standard: standard finite difference"
53  "coloring: finite difference based on coloring");
55  return params;
56 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< MoosePreconditioner >()
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:37
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...