MFEM  v3.3
Finite element discretization library
Public Member Functions | Protected Attributes | List of all members
mfem::HypreSolver Class Referenceabstract

Abstract class for hypre's solvers and preconditioners. More...

#include <hypre.hpp>

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

Public Member Functions

 HypreSolver ()
 
 HypreSolver (HypreParMatrix *_A)
 
virtual operator HYPRE_Solver () const =0
 Typecast to HYPRE_Solver – return the solver. More...
 
virtual HYPRE_PtrToParSolverFcn SetupFcn () const =0
 hypre's internal Setup function More...
 
virtual HYPRE_PtrToParSolverFcn SolveFcn () const =0
 hypre's internal Solve function More...
 
virtual void SetOperator (const Operator &op)
 Set/update the solver for the given operator. More...
 
virtual void Mult (const HypreParVector &b, HypreParVector &x) const
 Solve the linear system Ax=b. More...
 
virtual void Mult (const Vector &b, Vector &x) const
 Operator application: y=A(x). More...
 
virtual ~HypreSolver ()
 
- 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 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 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...
 

Protected Attributes

HypreParMatrixA
 The linear system matrix. More...
 
HypreParVectorB
 Right-hand side and solution vector. More...
 
HypreParVectorX
 
int setup_called
 Was hypre's Setup function called already? 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...
 

Additional Inherited Members

- Public Types inherited from mfem::Operator
enum  Type {
  MFEM_SPARSEMAT, HYPRE_PARCSR, PETSC_MATAIJ, PETSC_MATIS,
  PETSC_MATSHELL, PETSC_MATNEST
}
 Enumeration defining IDs for some classes derived from Operator. More...
 
- 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 class for hypre's solvers and preconditioners.

Definition at line 594 of file hypre.hpp.

Constructor & Destructor Documentation

mfem::HypreSolver::HypreSolver ( )

Definition at line 1913 of file hypre.cpp.

mfem::HypreSolver::HypreSolver ( HypreParMatrix _A)

Definition at line 1920 of file hypre.cpp.

mfem::HypreSolver::~HypreSolver ( )
virtual

Definition at line 1975 of file hypre.cpp.

Member Function Documentation

void mfem::HypreSolver::Mult ( const HypreParVector b,
HypreParVector x 
) const
virtual

Solve the linear system Ax=b.

Reimplemented in mfem::HypreGMRES, and mfem::HyprePCG.

Definition at line 1928 of file hypre.cpp.

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

Operator application: y=A(x).

Implements mfem::Operator.

Definition at line 1948 of file hypre.cpp.

virtual mfem::HypreSolver::operator HYPRE_Solver ( ) const
pure virtual
virtual void mfem::HypreSolver::SetOperator ( const Operator op)
inlinevirtual

Set/update the solver for the given operator.

Implements mfem::Solver.

Reimplemented in mfem::HypreBoomerAMG.

Definition at line 619 of file hypre.hpp.

virtual HYPRE_PtrToParSolverFcn mfem::HypreSolver::SetupFcn ( ) const
pure virtual
virtual HYPRE_PtrToParSolverFcn mfem::HypreSolver::SolveFcn ( ) const
pure virtual

Member Data Documentation

HypreParMatrix* mfem::HypreSolver::A
protected

The linear system matrix.

Definition at line 598 of file hypre.hpp.

HypreParVector* mfem::HypreSolver::B
mutableprotected

Right-hand side and solution vector.

Definition at line 601 of file hypre.hpp.

int mfem::HypreSolver::setup_called
mutableprotected

Was hypre's Setup function called already?

Definition at line 604 of file hypre.hpp.

HypreParVector * mfem::HypreSolver::X
mutableprotected

Definition at line 601 of file hypre.hpp.


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