MFEM  v3.4
Finite element discretization library
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
mfem::UMFPackSolver Class Reference

Direct sparse solver using UMFPACK. More...

#include <solvers.hpp>

Inheritance diagram for mfem::UMFPackSolver:
[legend]
Collaboration diagram for mfem::UMFPackSolver:
[legend]

Public Member Functions

 UMFPackSolver (bool _use_long_ints=false)
 For larger matrices, if the solver fails, set the parameter _use_long_ints = true. More...
 
 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. More...
 
virtual void SetOperator (const Operator &op)
 Factorize the given Operator op which must be a SparseMatrix. More...
 
void SetPrintLevel (int print_lvl)
 Set the print level field in the Control data member. More...
 
virtual void Mult (const Vector &b, Vector &x) const
 Operator application: y=A(x). More...
 
virtual void MultTranspose (const Vector &b, Vector &x) const
 Action of the transpose operator: y=A^t(x). The default behavior in class Operator is to generate an error. More...
 
virtual ~UMFPackSolver ()
 
- 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
 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 OperatorGetGradient (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 OperatorGetProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity. More...
 
virtual const OperatorGetRestriction () const
 Restriction operator from input 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...
 
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(). 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

double Control [UMFPACK_CONTROL]
 
double Info [UMFPACK_INFO]
 
- 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

void Init ()
 

Protected Attributes

bool use_long_ints
 
SparseMatrixmat
 
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. More...
 
int width
 Dimension of the input / number of columns in the matrix. More...
 

Additional Inherited Members

- Public Types inherited from mfem::Operator
enum  Type {
  ANY_TYPE, MFEM_SPARSEMAT, Hypre_ParCSR, PETSC_MATAIJ,
  PETSC_MATIS, PETSC_MATSHELL, PETSC_MATNEST, PETSC_MATHYPRE,
  PETSC_MATGENERIC
}
 Enumeration defining IDs for some classes derived from Operator. More...
 

Detailed Description

Direct sparse solver using UMFPACK.

Definition at line 344 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 360 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 365 of file solvers.hpp.

◆ ~UMFPackSolver()

mfem::UMFPackSolver::~UMFPackSolver ( )
virtual

Definition at line 1851 of file solvers.cpp.

Member Function Documentation

◆ Init()

void mfem::UMFPackSolver::Init ( )
protected

Definition at line 1673 of file solvers.cpp.

◆ Mult()

void mfem::UMFPackSolver::Mult ( const Vector x,
Vector y 
) const
virtual

Operator application: y=A(x).

Implements mfem::Operator.

Definition at line 1785 of file solvers.cpp.

◆ MultTranspose()

void mfem::UMFPackSolver::MultTranspose ( const Vector x,
Vector y 
) const
virtual

Action of the transpose operator: y=A^t(x). The default behavior in class Operator is to generate an error.

Reimplemented from mfem::Operator.

Definition at line 1817 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 1688 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 376 of file solvers.hpp.

Member Data Documentation

◆ AI

SuiteSparse_long* mfem::UMFPackSolver::AI
protected

Definition at line 350 of file solvers.hpp.

◆ AJ

SuiteSparse_long * mfem::UMFPackSolver::AJ
protected

Definition at line 350 of file solvers.hpp.

◆ Control

double mfem::UMFPackSolver::Control[UMFPACK_CONTROL]

Definition at line 355 of file solvers.hpp.

◆ Info

double mfem::UMFPackSolver::Info[UMFPACK_INFO]
mutable

Definition at line 356 of file solvers.hpp.

◆ mat

SparseMatrix* mfem::UMFPackSolver::mat
protected

Definition at line 348 of file solvers.hpp.

◆ Numeric

void* mfem::UMFPackSolver::Numeric
protected

Definition at line 349 of file solvers.hpp.

◆ use_long_ints

bool mfem::UMFPackSolver::use_long_ints
protected

Definition at line 347 of file solvers.hpp.


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