NOX::Petsc::Interface Class Reference

Used by NOX::Petsc::Group to provide a link to the external code for F and Jacobian evaluations (if needed). More...

#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.

Detailed Description

Used by NOX::Petsc::Group to provide a link to the external code for F and Jacobian evaluations (if needed).

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.

---

The documentation for this class was generated from the following file:

• NOX_Petsc_Interface.H