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::HypreDiagScale Class Reference

Jacobi preconditioner in hypre. More...

#include <hypre.hpp>

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

Public Member Functions

 HypreDiagScale ()
 
 HypreDiagScale (HypreParMatrix &A)
 
virtual operator HYPRE_Solver () const
 Typecast to HYPRE_Solver – return the solver. More...
 
virtual HYPRE_PtrToParSolverFcn SetupFcn () const
 hypre's internal Setup function More...
 
virtual HYPRE_PtrToParSolverFcn SolveFcn () const
 hypre's internal Solve function More...
 
HypreParMatrixGetData ()
 
virtual ~HypreDiagScale ()
 
- 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 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) 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

Jacobi preconditioner in hypre.

Definition at line 666 of file hypre.hpp.

Constructor & Destructor Documentation

mfem::HypreDiagScale::HypreDiagScale ( )
inline

Definition at line 669 of file hypre.hpp.

mfem::HypreDiagScale::HypreDiagScale ( HypreParMatrix A)
inlineexplicit

Definition at line 670 of file hypre.hpp.

virtual mfem::HypreDiagScale::~HypreDiagScale ( )
inlinevirtual

Definition at line 679 of file hypre.hpp.

Member Function Documentation

HypreParMatrix* mfem::HypreDiagScale::GetData ( )
inline

Definition at line 678 of file hypre.hpp.

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

Typecast to HYPRE_Solver – return the solver.

Implements mfem::HypreSolver.

Definition at line 671 of file hypre.hpp.

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

hypre's internal Setup function

Implements mfem::HypreSolver.

Definition at line 673 of file hypre.hpp.

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

hypre's internal Solve function

Implements mfem::HypreSolver.

Definition at line 675 of file hypre.hpp.


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