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

Public Member Functions inherited from mfem::Solver
	Solver (int s=0, bool iter_mode=false)

	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
	Operator (int s=0)
	Construct a square Operator with given size s (default 0) More...

	Operator (int h, int w)

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

int	NumRows () const

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

int	NumCols () const

virtual void	Mult (const Vector &x, Vector &y) const =0
	Operator application. More...

virtual void	MultTranspose (const Vector &x, Vector &y) const
	Action of the transpose operator. More...

virtual Operator &	GetGradient (const Vector &x) const
	Evaluate the gradient operator at the point x. 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 ()

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

double	Norm (const Vector &x) const

Protected Attributes
const Operator *	oper

Solver *	prec

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

int	width

Additional Inherited Members
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 31 of file solvers.hpp.

Constructor & Destructor Documentation

mfem::IterativeSolver::IterativeSolver ( )

Definition at line 23 of file solvers.cpp.

mfem::IterativeSolver::IterativeSolver ( MPI_Comm _comm )

Definition at line 37 of file solvers.cpp.

Member Function Documentation

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

protected

Definition at line 50 of file solvers.cpp.

int mfem::IterativeSolver::GetConverged ( ) const

inline

Definition at line 66 of file solvers.hpp.

double mfem::IterativeSolver::GetFinalNorm ( ) const

inline

Definition at line 67 of file solvers.hpp.

int mfem::IterativeSolver::GetNumIterations ( ) const

inline

Definition at line 65 of file solvers.hpp.

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

inlineprotected

Definition at line 51 of file solvers.hpp.

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

inline

Definition at line 61 of file solvers.hpp.

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

inline

Definition at line 62 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::SLBQPOptimizer, mfem::NewtonSolver, mfem::MINRESSolver, mfem::BiCGSTABSolver, mfem::CGSolver, and mfem::SLISolver.

Definition at line 98 of file solvers.cpp.

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

virtual

This should be called before SetOperator.

Reimplemented in mfem::SLBQPOptimizer, and mfem::MINRESSolver.

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 60 of file solvers.hpp.

Member Data Documentation

double mfem::IterativeSolver::abs_tol

protected

Definition at line 44 of file solvers.hpp.

int mfem::IterativeSolver::converged

mutableprotected

Definition at line 47 of file solvers.hpp.

int mfem::IterativeSolver::final_iter

mutableprotected

Definition at line 47 of file solvers.hpp.

double mfem::IterativeSolver::final_norm

mutableprotected

Definition at line 48 of file solvers.hpp.

int mfem::IterativeSolver::max_iter

protected

Definition at line 43 of file solvers.hpp.

const Operator* mfem::IterativeSolver::oper

protected

Definition at line 40 of file solvers.hpp.

Solver* mfem::IterativeSolver::prec

protected

Definition at line 41 of file solvers.hpp.

int mfem::IterativeSolver::print_level

protected

Definition at line 43 of file solvers.hpp.

double mfem::IterativeSolver::rel_tol

protected

Definition at line 44 of file solvers.hpp.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation