Abstract base class for iterative solver. More...

#include <solvers.hpp>

Inheritance diagram for mfem::IterativeSolver:

Collaboration diagram for mfem::IterativeSolver:

Public Member Functions
	IterativeSolver ()

	IterativeSolver (MPI_Comm comm_)

void	SetRelTol (double rtol)

void	SetAbsTol (double atol)

void	SetMaxIter (int max_it)

void	SetPrintLevel (int print_lvl)

int	GetNumIterations () const

int	GetConverged () const

double	GetFinalNorm () const

virtual void	SetPreconditioner (Solver &pr)
	This should be called before SetOperator. More...

virtual void	SetOperator (const Operator &op)
	Also calls SetOperator for the preconditioner if there is one. More...

void	SetMonitor (IterativeSolverMonitor &m)
	Set the iterative solver monitor. More...

MPI_Comm	GetComm () const
	Return the associated MPI communicator, or MPI_COMM_NULL if no communicator is set. More...

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	Mult (const Vector &x, Vector &y) const =0
	Operator application: `y=A(x)`. 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 void	AssembleDiagonal (Vector &diag) const
	Computes the diagonal entries into diag. Typically, this operation only makes sense for linear Operators. In some cases, only an approximation of the diagonal is computed. 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 *	GetOutputRestrictionTranspose () const
	Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators. 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...

Protected Member Functions
double	Dot (const Vector &x, const Vector &y) const

double	Norm (const Vector &x) const

void	Monitor (int it, double norm, const Vector &r, const Vector &x, bool final=false) const

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, using input/output Prolongation matrices Pi corresponds to "P", Po corresponds to "Rt". More...

Protected Attributes
const Operator *	oper

Solver *	prec

IterativeSolverMonitor *	monitor = nullptr

int	max_iter

int	print_level

double	rel_tol

double	abs_tol

int	final_iter

int	converged

double	final_norm

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

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

Detailed Description

Abstract base class for iterative solver.

Definition at line 66 of file solvers.hpp.

Constructor & Destructor Documentation

mfem::IterativeSolver::IterativeSolver ( )

Definition at line 28 of file solvers.cpp.

mfem::IterativeSolver::IterativeSolver ( MPI_Comm comm_ )

Definition at line 42 of file solvers.cpp.

Member Function Documentation

double mfem::IterativeSolver::Dot	(	const Vector &	x,
		const Vector &	y
	)		const

protected

Definition at line 55 of file solvers.cpp.

MPI_Comm mfem::IterativeSolver::GetComm ( ) const

inline

Return the associated MPI communicator, or MPI_COMM_NULL if no communicator is set.

Definition at line 120 of file solvers.hpp.

int mfem::IterativeSolver::GetConverged ( ) const

inline

Definition at line 104 of file solvers.hpp.

double mfem::IterativeSolver::GetFinalNorm ( ) const

inline

Definition at line 105 of file solvers.hpp.

int mfem::IterativeSolver::GetNumIterations ( ) const

inline

Definition at line 103 of file solvers.hpp.

void mfem::IterativeSolver::Monitor	(	int	it,
		double	norm,
		const Vector &	r,
		const Vector &	x,
		bool	final = `false`
	)		const

protected

Definition at line 109 of file solvers.cpp.

double mfem::IterativeSolver::Norm ( const Vector & x ) const

inlineprotected

Definition at line 87 of file solvers.hpp.

void mfem::IterativeSolver::SetAbsTol ( double atol )

inline

Definition at line 99 of file solvers.hpp.

void mfem::IterativeSolver::SetMaxIter ( int max_it )

inline

Definition at line 100 of file solvers.hpp.

void mfem::IterativeSolver::SetMonitor ( IterativeSolverMonitor & m )

inline

Set the iterative solver monitor.

Definition at line 114 of file solvers.hpp.

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

virtual

Also calls SetOperator for the preconditioner if there is one.

Implements mfem::Solver.

Reimplemented in mfem::KINSolver, mfem::OptimizationSolver, mfem::NewtonSolver, mfem::MINRESSolver, mfem::BiCGSTABSolver, mfem::CGSolver, mfem::PenaltyConstrainedSolver, mfem::SLISolver, mfem::EliminationSolver, and mfem::ConstrainedSolver.

Definition at line 98 of file solvers.cpp.

void mfem::IterativeSolver::SetPreconditioner ( Solver & pr )

virtual

This should be called before SetOperator.

Reimplemented in mfem::KINSolver, mfem::OptimizationSolver, mfem::LBFGSSolver, mfem::MINRESSolver, and mfem::TMOPNewtonSolver.

Definition at line 92 of file solvers.cpp.

void mfem::IterativeSolver::SetPrintLevel ( int print_lvl )

Definition at line 71 of file solvers.cpp.

void mfem::IterativeSolver::SetRelTol ( double rtol )

inline

Definition at line 98 of file solvers.hpp.

Member Data Documentation

double mfem::IterativeSolver::abs_tol

protected

Definition at line 80 of file solvers.hpp.

int mfem::IterativeSolver::converged

mutableprotected

Definition at line 83 of file solvers.hpp.

int mfem::IterativeSolver::final_iter

mutableprotected

Definition at line 83 of file solvers.hpp.

double mfem::IterativeSolver::final_norm

mutableprotected

Definition at line 84 of file solvers.hpp.

int mfem::IterativeSolver::max_iter

protected

Definition at line 79 of file solvers.hpp.

IterativeSolverMonitor* mfem::IterativeSolver::monitor = nullptr

protected

Definition at line 77 of file solvers.hpp.

const Operator* mfem::IterativeSolver::oper

protected

Definition at line 75 of file solvers.hpp.

Solver* mfem::IterativeSolver::prec

protected

Definition at line 76 of file solvers.hpp.

int mfem::IterativeSolver::print_level

protected

Definition at line 79 of file solvers.hpp.

double mfem::IterativeSolver::rel_tol

protected

Definition at line 80 of file solvers.hpp.

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

linalg/solvers.hpp
linalg/solvers.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation