Direct sparse solver using UMFPACK. More...

#include <solvers.hpp>

Inheritance diagram for mfem::UMFPackSolver:

Collaboration diagram for mfem::UMFPackSolver:

Public Member Functions
	UMFPackSolver (bool use_long_ints_=false)
	For larger matrices, if the solver fails, set the parameter use_long_ints_ = true.

	UMFPackSolver (SparseMatrix &A, bool use_long_ints_=false)
	Factorize the given SparseMatrix using the defaults. For larger matrices, if the solver fails, set the parameter use_long_ints_ = true.

virtual void	SetOperator (const Operator &op)
	Factorize the given Operator op which must be a SparseMatrix.

void	SetPrintLevel (int print_lvl)
	Set the print level field in the Control data member.

virtual void	Mult (const Vector &b, Vector &x) const
	Direct solution of the linear system using UMFPACK.

virtual void	MultTranspose (const Vector &b, Vector &x) const
	Direct solution of the transposed linear system using UMFPACK.

virtual	~UMFPackSolver ()

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

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

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.

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

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

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

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

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

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

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

virtual void	AddMult (const Vector &x, Vector &y, const real_t a=1.0) const
	Operator application: `y+=A(x)` (default) or `y+=a*A(x)`.

virtual void	AddMultTranspose (const Vector &x, Vector &y, const real_t a=1.0) const
	Operator transpose application: `y+=A^t(x)` (default) or `y+=a*A^t(x)`.

virtual void	ArrayMult (const Array< const Vector * > &X, Array< Vector * > &Y) const
	Operator application on a matrix: `Y=A(X)`.

virtual void	ArrayMultTranspose (const Array< const Vector * > &X, Array< Vector * > &Y) const
	Action of the transpose operator on a matrix: `Y=A^t(X)`.

virtual void	ArrayAddMult (const Array< const Vector * > &X, Array< Vector * > &Y, const real_t a=1.0) const
	Operator application on a matrix: `Y+=A(X)` (default) or `Y+=a*A(X)`.

virtual void	ArrayAddMultTranspose (const Array< const Vector * > &X, Array< Vector * > &Y, const real_t a=1.0) const
	Operator transpose application on a matrix: `Y+=A^t(X)` (default) or `Y+=a*A^t(X)`.

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.

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.

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

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

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

virtual const Operator *	GetOutputRestrictionTranspose () const
	Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators.

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

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.

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.

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

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

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

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

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

virtual void	PrintMatlab (std::ostream &out) const
	Prints operator in Matlab format.

virtual	~Operator ()
	Virtual destructor.

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

Public Attributes
real_t	Control [UMFPACK_CONTROL]

real_t	Info [UMFPACK_INFO]

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

Protected Member Functions
void	Init ()

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

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

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

Protected Attributes
bool	use_long_ints

SparseMatrix *	mat

void *	Numeric

SuiteSparse_long *	AI

SuiteSparse_long *	AJ

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

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

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 , Complex_DenseMat , MFEM_Block_Matrix , MFEM_Block_Operator }
	Enumeration defining IDs for some classes derived from Operator. More...

Detailed Description

Direct sparse solver using UMFPACK.

Definition at line 1095 of file solvers.hpp.

Constructor & Destructor Documentation

◆ UMFPackSolver() [1/2]

mfem::UMFPackSolver::UMFPackSolver ( bool use_long_ints_ = false )

inline

For larger matrices, if the solver fails, set the parameter use_long_ints_ = true.

Definition at line 1111 of file solvers.hpp.

◆ UMFPackSolver() [2/2]

mfem::UMFPackSolver::UMFPackSolver	(	SparseMatrix &	A,
		bool	use_long_ints_ = false )

inline

Factorize the given SparseMatrix using the defaults. For larger matrices, if the solver fails, set the parameter use_long_ints_ = true.

Definition at line 1116 of file solvers.hpp.

◆ ~UMFPackSolver()

mfem::UMFPackSolver::~UMFPackSolver ( )

virtual

Definition at line 3269 of file solvers.cpp.

Member Function Documentation

◆ Init()

void mfem::UMFPackSolver::Init ( )

protected

Definition at line 3087 of file solvers.cpp.

◆ Mult()

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

virtual

Direct solution of the linear system using UMFPACK.

Implements mfem::Operator.

Definition at line 3197 of file solvers.cpp.

◆ MultTranspose()

void mfem::UMFPackSolver::MultTranspose	(	const Vector &	b,
		Vector &	x ) const

virtual

Direct solution of the transposed linear system using UMFPACK.

Reimplemented from mfem::Operator.

Definition at line 3232 of file solvers.cpp.

◆ SetOperator()

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

virtual

Factorize the given Operator op which must be a SparseMatrix.

The factorization uses the parameters set in the Control data member.

Note: This method calls SparseMatrix::SortColumnIndices() with op, modifying the matrix if the column indices are not already sorted.

Implements mfem::Solver.

Definition at line 3102 of file solvers.cpp.

◆ SetPrintLevel()

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

inline

Set the print level field in the Control data member.

Definition at line 1127 of file solvers.hpp.

Member Data Documentation

◆ AI

SuiteSparse_long* mfem::UMFPackSolver::AI

protected

Definition at line 1101 of file solvers.hpp.

◆ AJ

SuiteSparse_long * mfem::UMFPackSolver::AJ

protected

Definition at line 1101 of file solvers.hpp.

◆ Control

real_t mfem::UMFPackSolver::Control[UMFPACK_CONTROL]

Definition at line 1106 of file solvers.hpp.

◆ Info

real_t mfem::UMFPackSolver::Info[UMFPACK_INFO]

mutable

Definition at line 1107 of file solvers.hpp.

◆ mat

SparseMatrix* mfem::UMFPackSolver::mat

protected

Definition at line 1099 of file solvers.hpp.

◆ Numeric

void* mfem::UMFPackSolver::Numeric

protected

Definition at line 1100 of file solvers.hpp.

◆ use_long_ints

bool mfem::UMFPackSolver::use_long_ints

protected

Definition at line 1098 of file solvers.hpp.

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

linalg/solvers.hpp
linalg/solvers.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UMFPackSolver() [1/2]

◆ UMFPackSolver() [2/2]

◆ ~UMFPackSolver()

Member Function Documentation

◆ Init()

◆ Mult()

◆ MultTranspose()

◆ SetOperator()

◆ SetPrintLevel()

Member Data Documentation

◆ AI

◆ AJ

◆ Control

◆ Info

◆ mat

◆ Numeric

◆ use_long_ints