MFEM  v3.3.2
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
mfem::KLUSolver Class Reference

Direct sparse solver using KLU. More...

#include <solvers.hpp>

Inheritance diagram for mfem::KLUSolver:
Collaboration diagram for mfem::KLUSolver:

Public Member Functions

 KLUSolver ()
 KLUSolver (SparseMatrix &A)
virtual void SetOperator (const Operator &op)
 Set/update the solver for the given operator. 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 ~KLUSolver ()
- 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...

Public Attributes

klu_common Common
- 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

klu_symbolic * Symbolic
klu_numeric * Numeric
- 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 {
 Enumeration defining IDs for some classes derived from Operator. More...

Detailed Description

Direct sparse solver using KLU.

Definition at line 384 of file solvers.hpp.

Constructor & Destructor Documentation

mfem::KLUSolver::KLUSolver ( )

Definition at line 394 of file solvers.hpp.

mfem::KLUSolver::KLUSolver ( SparseMatrix A)

Definition at line 397 of file solvers.hpp.

mfem::KLUSolver::~KLUSolver ( )

Definition at line 1935 of file solvers.cpp.

Member Function Documentation

void mfem::KLUSolver::Init ( )

Definition at line 1871 of file solvers.cpp.

void mfem::KLUSolver::Mult ( const Vector x,
Vector y 
) const

Operator application: y=A(x).

Implements mfem::Operator.

Definition at line 1907 of file solvers.cpp.

void mfem::KLUSolver::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.

Reimplemented from mfem::Operator.

Definition at line 1921 of file solvers.cpp.

void mfem::KLUSolver::SetOperator ( const Operator op)

Set/update the solver for the given operator.

Implements mfem::Solver.

Definition at line 1876 of file solvers.cpp.

Member Data Documentation

klu_common mfem::KLUSolver::Common

Definition at line 409 of file solvers.hpp.

SparseMatrix* mfem::KLUSolver::mat

Definition at line 387 of file solvers.hpp.

klu_numeric* mfem::KLUSolver::Numeric

Definition at line 389 of file solvers.hpp.

klu_symbolic* mfem::KLUSolver::Symbolic

Definition at line 388 of file solvers.hpp.

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