Abstract class for PETSc's nonlinear solvers. More...

#include <petsc.hpp>

Inheritance diagram for mfem::PetscNonlinearSolver:

Collaboration diagram for mfem::PetscNonlinearSolver:

Public Member Functions
	PetscNonlinearSolver (MPI_Comm comm, const std::string &prefix=std::string())

	PetscNonlinearSolver (MPI_Comm comm, Operator &op, const std::string &prefix=std::string())

virtual	~PetscNonlinearSolver ()

virtual void	SetOperator (const Operator &op)
	Specification of the nonlinear operator. More...

void	SetJacobianType (Operator::Type type)

virtual void	Mult (const Vector &b, Vector &x) const
	Application of the solver. More...

void	SetObjective (void(obj)(Operator op, const Vector &x, double *f))
	Specification of an objective function to be used for line search. More...

void	SetPostCheck (void(post)(Operator op, const Vector &X, Vector &Y, Vector &W, bool &changed_y, bool &changed_w))

void	SetUpdate (void(update)(Operator op, int it, const mfem::Vector &F, const mfem::Vector &X, const mfem::Vector &D, const mfem::Vector &P))

	operator SNES () const
	Conversion function to PETSc's SNES type. More...

Public Member Functions inherited from mfem::PetscSolver
	PetscSolver ()
	Construct an empty PetscSolver. Initialize protected objects to NULL. More...

virtual	~PetscSolver ()
	Destroy the PetscParVectors allocated (if any). More...

void	Customize (bool customize=true) const
	Customize object with options set. More...

int	GetConverged ()

int	GetNumIterations ()

double	GetFinalNorm ()

void	SetMonitor (PetscSolverMonitor *ctx)
	Sets user-defined monitoring routine. More...

void	SetBCHandler (PetscBCHandler *bch)
	Sets the object to handle essential boundary conditions. More...

void	SetPreconditionerFactory (PetscPreconditionerFactory *factory)
	Sets the object for the creation of the preconditioner. More...

	operator PetscObject () const
	Conversion function to PetscObject. More...

MPI_Comm	GetComm () const
	Get the associated MPI communicator. More...

void	SetTol (double tol)

void	SetRelTol (double tol)

void	SetAbsTol (double tol)

void	SetMaxIter (int max_iter)

void	SetPrintLevel (int plev)

Public Member Functions inherited from mfem::Solver
	Solver (int s=0, bool iter_mode=false)
	Initialize a square Solver with size s. More...

	Solver (int h, int w, bool iter_mode=false)
	Initialize a Solver with height h and width w. More...

Public Member Functions inherited from mfem::Operator
void	InitTVectors (const Operator Po, const Operator Ri, const Operator *Pi, Vector &x, Vector &b, Vector &X, Vector &B) const
	Initializes memory for true vectors of linear system. More...

	Operator (int s=0)
	Construct a square Operator with given size s (default 0). More...

	Operator (int h, int w)
	Construct an Operator with the given height (output size) and width (input size). More...

int	Height () const
	Get the height (size of output) of the Operator. Synonym with NumRows(). More...

int	NumRows () const
	Get the number of rows (size of output) of the Operator. Synonym with Height(). More...

int	Width () const
	Get the width (size of input) of the Operator. Synonym with NumCols(). More...

int	NumCols () const
	Get the number of columns (size of input) of the Operator. Synonym with Width(). More...

virtual MemoryClass	GetMemoryClass () const
	Return the MemoryClass preferred by the Operator. More...

virtual void	MultTranspose (const Vector &x, Vector &y) const
	Action of the transpose operator: `y=A^t(x)`. The default behavior in class Operator is to generate an error. More...

virtual Operator &	GetGradient (const Vector &x) const
	Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error. More...

virtual const Operator *	GetProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. `NULL` means identity. More...

virtual const Operator *	GetRestriction () const
	Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. `NULL` means identity. More...

virtual const Operator *	GetOutputProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. `NULL` means identity. More...

virtual const Operator *	GetOutputRestriction () const
	Restriction operator from output vectors for the operator to linear algebra (linear system) vectors. `NULL` means identity. More...

void	FormLinearSystem (const Array< int > &ess_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B, int copy_interior=0)
	Form a constrained linear system using a matrix-free approach. More...

void	FormRectangularLinearSystem (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B)
	Form a column-constrained linear system using a matrix-free approach. More...

virtual void	RecoverFEMSolution (const Vector &X, const Vector &b, Vector &x)
	Reconstruct a solution vector x (e.g. a GridFunction) from the solution X of a constrained linear system obtained from Operator::FormLinearSystem() or Operator::FormRectangularLinearSystem(). More...

void	FormSystemOperator (const Array< int > &ess_tdof_list, Operator *&A)
	Return in A a parallel (on truedofs) version of this square operator. More...

void	FormRectangularSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Operator *&A)
	Return in A a parallel (on truedofs) version of this rectangular operator (including constraints). More...

void	FormDiscreteOperator (Operator *&A)
	Return in A a parallel (on truedofs) version of this rectangular operator. More...

void	PrintMatlab (std::ostream &out, int n=0, int m=0) const
	Prints operator with input size n and output size m in Matlab format. More...

virtual	~Operator ()
	Virtual destructor. More...

Type	GetType () const
	Return the type ID of the Operator class. More...

Additional Inherited Members
Public Types inherited from mfem::Operator
enum	DiagonalPolicy { DIAG_ZERO, DIAG_ONE, DIAG_KEEP }
	Defines operator diagonal policy upon elimination of rows and/or columns. More...

enum	Type { ANY_TYPE, MFEM_SPARSEMAT, Hypre_ParCSR, PETSC_MATAIJ, PETSC_MATIS, PETSC_MATSHELL, PETSC_MATNEST, PETSC_MATHYPRE, PETSC_MATGENERIC, Complex_Operator, MFEM_ComplexSparseMat, Complex_Hypre_ParCSR }
	Enumeration defining IDs for some classes derived from Operator. More...

Public Attributes inherited from mfem::Solver
bool	iterative_mode
	If true, use the second argument of Mult() as an initial guess. More...

Protected Member Functions inherited from mfem::PetscSolver
void	CreatePrivateContext ()

void	FreePrivateContext ()

Protected Member Functions inherited from mfem::Operator
void	FormConstrainedSystemOperator (const Array< int > &ess_tdof_list, ConstrainedOperator *&Aout)
	see FormSystemOperator() More...

void	FormRectangularConstrainedSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, RectangularConstrainedOperator *&Aout)
	see FormRectangularSystemOperator() More...

Operator *	SetupRAP (const Operator Pi, const Operator Po)
	Returns RAP Operator of this, taking in input/output Prolongation matrices. More...

Protected Attributes inherited from mfem::PetscSolver
bool	clcustom
	Boolean to handle SetFromOptions calls. More...

PetscObject	obj
	The actual PETSc object (KSP, PC, SNES or TS). More...

PetscClassId	cid
	The class id of the actual PETSc object. More...

PetscParVector *	B
	Right-hand side and solution vector. More...

PetscParVector *	X

PetscBCHandler *	bchandler
	Handler for boundary conditions. More...

void *	private_ctx
	Private context for solver. More...

bool	operatorset
	Boolean to handle SetOperator calls. More...

Protected Attributes inherited from mfem::Operator
int	height
	Dimension of the output / number of rows in the matrix. More...

int	width
	Dimension of the input / number of columns in the matrix. More...

Detailed Description

Abstract class for PETSc's nonlinear solvers.

Definition at line 754 of file petsc.hpp.

Constructor & Destructor Documentation

mfem::PetscNonlinearSolver::PetscNonlinearSolver	(	MPI_Comm	comm,
		const std::string &	prefix = `std::string()`
	)

Definition at line 3277 of file petsc.cpp.

mfem::PetscNonlinearSolver::PetscNonlinearSolver	(	MPI_Comm	comm,
		Operator &	op,
		const std::string &	prefix = `std::string()`
	)

Definition at line 3292 of file petsc.cpp.

mfem::PetscNonlinearSolver::~PetscNonlinearSolver ( )

virtual

Definition at line 3309 of file petsc.cpp.

Member Function Documentation

void mfem::PetscNonlinearSolver::Mult	(	const Vector &	b,
		Vector &	x
	)		const

virtual

Application of the solver.

Implements mfem::Operator.

Definition at line 3414 of file petsc.cpp.

mfem::PetscNonlinearSolver::operator SNES ( ) const

inline

Conversion function to PETSc's SNES type.

Definition at line 792 of file petsc.hpp.

void mfem::PetscNonlinearSolver::SetJacobianType ( Operator::Type type )

Specifies the desired format of the Jacobian in case a PetscParMatrix is not returned by the GetGradient method.

Definition at line 3370 of file petsc.cpp.

void mfem::PetscNonlinearSolver::SetObjective ( void(*)(Operator *op, const Vector &x, double *f) obj )

Specification of an objective function to be used for line search.

Definition at line 3376 of file petsc.cpp.

void mfem::PetscNonlinearSolver::SetOperator ( const Operator & op )

virtual

Specification of the nonlinear operator.

Implements mfem::Solver.

Definition at line 3317 of file petsc.cpp.

void mfem::PetscNonlinearSolver::SetPostCheck ( void(*)(Operator *op, const Vector &X, Vector &Y, Vector &W, bool &changed_y, bool &changed_w) post )

User-defined routine to be applied after a successful line search step. The user can change the current direction Y and/or the updated solution W (with W = X - lambda * Y) but not the previous solution X. If Y or W have been changed, the corresponding booleans need to updated.

Definition at line 3387 of file petsc.cpp.

void mfem::PetscNonlinearSolver::SetUpdate ( void(*)(Operator *op, int it, const mfem::Vector &F, const mfem::Vector &X, const mfem::Vector &D, const mfem::Vector &P) update )

General purpose update function to be called at the beginning of each step it is the current nonlinear iteration number F is the current function value, X the current solution D the previous step taken, and P the previous solution

Definition at line 3401 of file petsc.cpp.

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

linalg/petsc.hpp
linalg/petsc.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation