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

Go to the source code of this file.

Classes

class  PhysicsBasedPreconditioner
 Implements a segregated solve preconditioner. More...
 

Functions

template<>
InputParameters validParams< PhysicsBasedPreconditioner > ()
 

Function Documentation

Definition at line 38 of file PhysicsBasedPreconditioner.C.

39 {
41 
42  params.addRequiredParam<std::vector<std::string>>(
43  "solve_order",
44  "The order the block rows will be solved in. Put the name of variables here "
45  "to stand for solving that variable's block row. A variable may appear more "
46  "than once (to create cylces if you like).");
47  params.addRequiredParam<std::vector<std::string>>("preconditioner", "TODO: docstring");
48 
49  params.addParam<std::vector<std::string>>(
50  "off_diag_row",
51  "The off diagonal row you want to add into the matrix, it will be associated "
52  "with an off diagonal column from the same position in off_diag_colum.");
53  params.addParam<std::vector<std::string>>("off_diag_column",
54  "The off diagonal column you want to add into the "
55  "matrix, it will be associated with an off diagonal "
56  "row from the same position in off_diag_row.");
57 
58  return params;
59 }
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...