amrex::HypreIJIface Class Reference

#include <AMReX_HypreIJIface.H>

Public Types
using	HypreIntType = HYPRE_Int
using	HypreRealType = HYPRE_Real

Public Member Functions
	HypreIJIface (MPI_Comm comm, HypreIntType ilower, HypreIntType iupper, int verbose)
	~HypreIJIface ()
	HypreIJIface (HypreIJIface const &)=delete
	HypreIJIface (HypreIJIface &&)=delete
HypreIJIface &	operator= (HypreIJIface const &)=delete
HypreIJIface &	operator= (HypreIJIface &&)=delete
void	parse_inputs (const std::string &prefix="hypre")
void	solve (HypreRealType rel_tol, HypreRealType abs_tol, HypreIntType max_iter)
HYPRE_IJMatrix	A ()
	IJ matrix instance.
HYPRE_IJVector	b ()
	Right hand side IJ vector instance.
HYPRE_IJVector	x ()
	Solution IJ vector instance.
HypreIntType	getNumIters () const
	Number of iterations taken by the solver to reach the desired tolerance.
HypreRealType	getFinalResidualNorm () const
	Final residual norm after a linear solve.
bool	adjustSingularMatrix () const

Member Typedef Documentation

HypreIntType

using amrex::HypreIJIface::HypreIntType = HYPRE_Int

HypreRealType

using amrex::HypreIJIface::HypreRealType = HYPRE_Real

Constructor & Destructor Documentation

HypreIJIface() [1/3]

amrex::HypreIJIface::HypreIJIface	(	MPI_Comm	comm,
		HypreIntType	ilower,
		HypreIntType	iupper,
		int	verbose
	)

~HypreIJIface()

amrex::HypreIJIface::~HypreIJIface

(

)

HypreIJIface() [2/3]

amrex::HypreIJIface::HypreIJIface ( HypreIJIface const &  )

delete

HypreIJIface() [3/3]

amrex::HypreIJIface::HypreIJIface ( HypreIJIface &&  )

delete

Member Function Documentation

A()

HYPRE_IJMatrix amrex::HypreIJIface::A ( )

inline

IJ matrix instance.

adjustSingularMatrix()

bool amrex::HypreIJIface::adjustSingularMatrix ( ) const

inline

b()

HYPRE_IJVector amrex::HypreIJIface::b ( )

inline

Right hand side IJ vector instance.

getFinalResidualNorm()

HypreRealType amrex::HypreIJIface::getFinalResidualNorm ( ) const

inline

Final residual norm after a linear solve.

getNumIters()

HypreIntType amrex::HypreIJIface::getNumIters ( ) const

inline

Number of iterations taken by the solver to reach the desired tolerance.

operator=() [1/2]

HypreIJIface & amrex::HypreIJIface::operator= ( HypreIJIface &&  )

delete

operator=() [2/2]

HypreIJIface & amrex::HypreIJIface::operator= ( HypreIJIface const &  )

delete

parse_inputs()

void amrex::HypreIJIface::parse_inputs

(

const std::string &

prefix = "hypre"

)

solve()

void amrex::HypreIJIface::solve	(	HypreRealType	rel_tol,
		HypreRealType	abs_tol,
		HypreIntType	max_iter
	)

x()

HYPRE_IJVector amrex::HypreIJIface::x ( )

inline

Solution IJ vector instance.

---

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

• /home/runner/work/amrex/amrex/Src/Extern/HYPRE/AMReX_HypreIJIface.H
• /home/runner/work/amrex/amrex/Src/Extern/HYPRE/AMReX_HypreIJIface.cpp