#include <NOX_Petsc_Interface.H>
Public Member Functions | |
Interface () | |
Constructor. | |
virtual | ~Interface () |
Destructor. | |
virtual bool | computeF (const Vec &x, Vec &RHS)=0 |
Compute F given the specified input vector, x. Returns true if computation was successful. | |
virtual bool | computeJacobian (const Vec &x, Mat &Jac)=0 |
Compute Jacobian given the specified input vector, x. Returns true if computation was successful. | |
virtual bool | computePreconditioner (Mat &M)=0 |
Compute the matrix M that will be used as the preconditioner. Returns true if computation was successful. | |
virtual bool | preconditionVector (Vec &y)=0 |
Return the action of the preconditioner on a vector. Returns true if computation was successful. |
At a minimum the user must supply a computeF(). If the user is supplying their own Petsc Mat for the Jacobian, then they must supply a computeJacobian(). Preconditioning functions are only needed if the user wishes to supply their own preconditioner. Otherwise Petsc SLES has built-in preconditioners to use.
Definition at line 58 of file NOX_Petsc_Interface.H.
NOX::Petsc::Interface::Interface | ( | ) | [inline] |
virtual NOX::Petsc::Interface::~Interface | ( | ) | [inline, virtual] |
virtual bool NOX::Petsc::Interface::computeF | ( | const Vec & | x, | |
Vec & | RHS | |||
) | [pure virtual] |
Compute F given the specified input vector, x. Returns true if computation was successful.
Referenced by NOX::Petsc::Group::computeF().
virtual bool NOX::Petsc::Interface::computeJacobian | ( | const Vec & | x, | |
Mat & | Jac | |||
) | [pure virtual] |
Compute Jacobian given the specified input vector, x. Returns true if computation was successful.
Referenced by NOX::Petsc::Group::computeJacobian().
virtual bool NOX::Petsc::Interface::computePreconditioner | ( | Mat & | M | ) | [pure virtual] |
Compute the matrix M that will be used as the preconditioner. Returns true if computation was successful.
virtual bool NOX::Petsc::Interface::preconditionVector | ( | Vec & | y | ) | [pure virtual] |
Return the action of the preconditioner on a vector. Returns true if computation was successful.