mfem::Solver Class Reference

Base class for solvers. More...

#include <operator.hpp>

Inheritance diagram for mfem::Solver:

Collaboration diagram for mfem::Solver:

Public Member Functions
	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...
virtual void	SetOperator (const Operator &op)=0
	Set/update the solver for the given operator. 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 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...

Public Attributes
bool	iterative_mode
	If true, use the second argument of Mult() as an initial guess. 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...
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::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

Base class for solvers.

Definition at line 634 of file operator.hpp.

Constructor & Destructor Documentation

mfem::Solver::Solver ( int  s = 0, bool  iter_mode = false  )

inlineexplicit

Initialize a square Solver with size s.

Warning

Use a Boolean expression for the second parameter (not an int) to distinguish this call from the general rectangular constructor.

Definition at line 644 of file operator.hpp.

mfem::Solver::Solver ( int  h, int  w, bool  iter_mode = false  )

inline

Initialize a Solver with height h and width w.

Definition at line 648 of file operator.hpp.

Member Function Documentation

virtual void mfem::Solver::SetOperator ( const Operator &  op )

pure virtual

Set/update the solver for the given operator.

Implemented in mfem::HypreADS, mfem::HypreAMS, mfem::HypreBoomerAMG, mfem::HypreILU, mfem::HypreEuclid, mfem::HypreParaSails, mfem::HypreDiagScale, mfem::HypreFGMRES, mfem::HypreGMRES, mfem::KLUSolver, mfem::KINSolver, mfem::HyprePCG, mfem::PetscNonlinearSolver, mfem::UMFPackSolver, mfem::HypreSolver, mfem::HypreSmoother, mfem::PetscPreconditioner, mfem::BlockILU, mfem::DenseMatrixInverse, mfem::PetscLinearSolver, mfem::OptimizationSolver, mfem::NewtonSolver, mfem::MINRESSolver, mfem::BiCGSTABSolver, mfem::CGSolver, mfem::BlockLowerTriangularPreconditioner, mfem::SLISolver, mfem::ComplexUMFPackSolver, mfem::OperatorChebyshevSmoother, mfem::BlockDiagonalPreconditioner, mfem::OperatorJacobiSmoother, mfem::AmgXSolver, mfem::SuperLUSolver, mfem::IterativeSolver, mfem::Multigrid, mfem::STRUMPACKSolver, mfem::CPardisoSolver, mfem::navier::OrthoSolver, and mfem::SparseSmoother.

Member Data Documentation

bool mfem::Solver::iterative_mode

If true, use the second argument of Mult() as an initial guess.

Definition at line 638 of file operator.hpp.

---

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

• linalg/operator.hpp