MFEM  v3.1
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
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:
Collaboration diagram for mfem::HypreSolver:

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. More...
virtual ~HypreSolver ()
- Public Member Functions inherited from mfem::Solver
 Solver (int s=0, bool iter_mode=false)
 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)
int Height () const
 Get the height (size of output) of the Operator. Synonym with NumRows. More...
int NumRows () const
int Width () const
 Get the width (size of input) of the Operator. Synonym with NumCols. More...
int NumCols () const
virtual void MultTranspose (const Vector &x, Vector &y) const
 Action of the transpose operator. More...
virtual OperatorGetGradient (const Vector &x) const
 Evaluate the gradient operator at the point x. More...
void PrintMatlab (std::ostream &out, int n=0, int m=0)
 Prints operator with input size n and output size m in matlab format. More...
virtual ~Operator ()

Protected Attributes

 The linear system matrix. More...
 Right-hand side and solution vector. More...
int setup_called
 Was hypre's Setup function called already? More...
- Protected Attributes inherited from mfem::Operator
int height
int width

Additional Inherited Members

- 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 522 of file hypre.hpp.

Constructor & Destructor Documentation

mfem::HypreSolver::HypreSolver ( )

Definition at line 1837 of file hypre.cpp.

mfem::HypreSolver::HypreSolver ( HypreParMatrix _A)

Definition at line 1844 of file hypre.cpp.

mfem::HypreSolver::~HypreSolver ( )

Definition at line 1899 of file hypre.cpp.

Member Function Documentation

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

Solve the linear system Ax=b.

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

Definition at line 1852 of file hypre.cpp.

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

Operator application.

Implements mfem::Operator.

Definition at line 1872 of file hypre.cpp.

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

Set/update the solver for the given operator.

Implements mfem::Solver.

Reimplemented in mfem::HypreBoomerAMG.

Definition at line 547 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

The linear system matrix.

Definition at line 526 of file hypre.hpp.

HypreParVector* mfem::HypreSolver::B

Right-hand side and solution vector.

Definition at line 529 of file hypre.hpp.

int mfem::HypreSolver::setup_called

Was hypre's Setup function called already?

Definition at line 532 of file hypre.hpp.

HypreParVector * mfem::HypreSolver::X

Definition at line 529 of file hypre.hpp.

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