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

PCG solver in hypre. More...

#include <hypre.hpp>

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

Public Member Functions

 HyprePCG (HypreParMatrix &_A)
 
void SetTol (double tol)
 
void SetMaxIter (int max_iter)
 
void SetLogging (int logging)
 
void SetPrintLevel (int print_lvl)
 
void SetPreconditioner (HypreSolver &precond)
 Set the hypre solver to be used as a preconditioner. More...
 
void SetResidualConvergenceOptions (int res_frequency=-1, double rtol=0.0)
 
void SetZeroInintialIterate ()
 non-hypre setting More...
 
void GetNumIterations (int &num_iterations)
 
virtual operator HYPRE_Solver () const
 The typecast to HYPRE_Solver returns the internal pcg_solver. More...
 
virtual HYPRE_PtrToParSolverFcn SetupFcn () const
 PCG Setup function. More...
 
virtual HYPRE_PtrToParSolverFcn SolveFcn () const
 PCG Solve function. More...
 
virtual void Mult (const HypreParVector &b, HypreParVector &x) const
 Solve Ax=b with hypre's PCG. More...
 
virtual ~HyprePCG ()
 
- Public Member Functions inherited from mfem::HypreSolver
 HypreSolver ()
 
 HypreSolver (HypreParMatrix *_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. 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) const
 Prints operator with input size n and output size m in matlab format. More...
 
virtual ~Operator ()
 

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...
 
- Protected Attributes inherited from mfem::HypreSolver
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
 
int width
 

Detailed Description

PCG solver in hypre.

Definition at line 565 of file hypre.hpp.

Constructor & Destructor Documentation

mfem::HyprePCG::HyprePCG ( HypreParMatrix _A)

Definition at line 1953 of file hypre.cpp.

mfem::HyprePCG::~HyprePCG ( )
virtual

Definition at line 2078 of file hypre.cpp.

Member Function Documentation

void mfem::HyprePCG::GetNumIterations ( int &  num_iterations)
inline

Definition at line 589 of file hypre.hpp.

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

Solve Ax=b with hypre's PCG.

Reimplemented from mfem::HypreSolver.

Definition at line 2005 of file hypre.cpp.

virtual mfem::HyprePCG::operator HYPRE_Solver ( ) const
inlinevirtual

The typecast to HYPRE_Solver returns the internal pcg_solver.

Implements mfem::HypreSolver.

Definition at line 597 of file hypre.hpp.

void mfem::HyprePCG::SetLogging ( int  logging)

Definition at line 1974 of file hypre.cpp.

void mfem::HyprePCG::SetMaxIter ( int  max_iter)

Definition at line 1969 of file hypre.cpp.

void mfem::HyprePCG::SetPreconditioner ( HypreSolver precond)

Set the hypre solver to be used as a preconditioner.

Definition at line 1984 of file hypre.cpp.

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

Definition at line 1979 of file hypre.cpp.

void mfem::HyprePCG::SetResidualConvergenceOptions ( int  res_frequency = -1,
double  rtol = 0.0 
)

Use the L2 norm of the residual for measuring PCG convergence, plus (optionally) 1) periodically recompute true residuals from scratch; and 2) enable residual-based stopping criteria.

Definition at line 1992 of file hypre.cpp.

void mfem::HyprePCG::SetTol ( double  tol)

Definition at line 1964 of file hypre.cpp.

virtual HYPRE_PtrToParSolverFcn mfem::HyprePCG::SetupFcn ( ) const
inlinevirtual

PCG Setup function.

Implements mfem::HypreSolver.

Definition at line 600 of file hypre.hpp.

void mfem::HyprePCG::SetZeroInintialIterate ( )
inline

non-hypre setting

Definition at line 587 of file hypre.hpp.

virtual HYPRE_PtrToParSolverFcn mfem::HyprePCG::SolveFcn ( ) const
inlinevirtual

PCG Solve function.

Implements mfem::HypreSolver.

Definition at line 603 of file hypre.hpp.


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