HypreSolver Class Reference

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

#include <hypre.hpp>

Inheritance diagram for HypreSolver:

Collaboration diagram for HypreSolver:

List of all members.

Public Member Functions
	HypreSolver ()
	HypreSolver (HypreParMatrix *_A)
virtual	operator HYPRE_Solver () const =0
	Typecast to HYPRE_Solver -- return the solver.
virtual HYPRE_PtrToParSolverFcn	SetupFcn () const =0
	hypre's internal Setup function
virtual HYPRE_PtrToParSolverFcn	SolveFcn () const =0
	hypre's internal Solve function
virtual void	Mult (const HypreParVector &b, HypreParVector &x) const
	Solve the linear system Ax=b.
virtual void	Mult (const Vector &b, Vector &x) const
	Operator application.
virtual	~HypreSolver ()
Protected Attributes
HypreParMatrix *	A
	The linear system matrix.
HypreParVector *	B
	Right-hand side and solution vector.
HypreParVector *	X
int	setup_called
	Was hypre's Setup function called already?

---

Detailed Description

Abstract class for hypre's solvers and preconditioners.

Definition at line 201 of file hypre.hpp.

---

Constructor & Destructor Documentation

HypreSolver::HypreSolver

(

)

HypreSolver::HypreSolver

(

HypreParMatrix *

_A

)

virtual HypreSolver::~HypreSolver

(

)

[virtual]

---

Member Function Documentation

virtual void HypreSolver::Mult	(	const HypreParVector &	b,
		HypreParVector &	x
	)		const [virtual]

Solve the linear system Ax=b.

Reimplemented in HyprePCG, and HypreGMRES.

virtual void HypreSolver::Mult	(	const Vector &	x,
		Vector &	y
	)		const [virtual]

Operator application.

Implements Operator.

virtual HypreSolver::operator HYPRE_Solver

(

)

const [pure virtual]

Typecast to HYPRE_Solver -- return the solver.

Implemented in HyprePCG, HypreGMRES, HypreIdentity, HypreDiagScale, HypreParaSails, HypreBoomerAMG, HypreAMS, and HypreADS.

virtual HYPRE_PtrToParSolverFcn HypreSolver::SetupFcn

(

)

const [pure virtual]

hypre's internal Setup function

Implemented in HyprePCG, HypreGMRES, HypreIdentity, HypreDiagScale, HypreParaSails, HypreBoomerAMG, HypreAMS, and HypreADS.

virtual HYPRE_PtrToParSolverFcn HypreSolver::SolveFcn

(

)

const [pure virtual]

hypre's internal Solve function

Implemented in HyprePCG, HypreGMRES, HypreIdentity, HypreDiagScale, HypreParaSails, HypreBoomerAMG, HypreAMS, and HypreADS.

---

Member Data Documentation

HypreParMatrix* HypreSolver::A [protected]

The linear system matrix.

Definition at line 205 of file hypre.hpp.

Referenced by HypreDiagScale::GetData().

HypreParVector* HypreSolver::B [mutable, protected]

Right-hand side and solution vector.

Definition at line 208 of file hypre.hpp.

int HypreSolver::setup_called [mutable, protected]

Was hypre's Setup function called already?

Definition at line 211 of file hypre.hpp.

HypreParVector * HypreSolver::X [mutable, protected]

Definition at line 208 of file hypre.hpp.

---

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

• hypre.hpp