geos::HypreInterface Class Reference

This class holds aliases based on the Hypre library. More...

#include <HypreInterface.hpp>

Public Types
using	ParallelMatrix = HypreMatrix
	Alias for HypreMatrix.
using	ParallelVector = HypreVector
	Alias for HypreVector.

Static Public Member Functions
static void	initialize ()
	Initializes the Hypre library.
static void	finalize ()
	Finalizes the Hypre library.
static std::unique_ptr< LinearSolverBase< HypreInterface > >	createSolver (LinearSolverParameters params)
	Create a hypre-based solver object. More...
static std::unique_ptr< PreconditionerBase< HypreInterface > >	createPreconditioner (LinearSolverParameters params)
	Create a hypre-based preconditioner object. More...
static std::unique_ptr< PreconditionerBase< HypreInterface > >	createPreconditioner (LinearSolverParameters params, array1d< HypreVector > const &nearNullKernel)
	Create a hypre-based preconditioner object. More...

Detailed Description

This class holds aliases based on the Hypre library.

Definition at line 37 of file HypreInterface.hpp.

Member Function Documentation

createPreconditioner() [1/2]

static std::unique_ptr< PreconditionerBase< HypreInterface > > geos::HypreInterface::createPreconditioner ( LinearSolverParameters  params )

static

Create a hypre-based preconditioner object.

Parameters

params

the preconditioner parameters

Returns

owning pointer to the newly created preconditioner

createPreconditioner() [2/2]

static std::unique_ptr< PreconditionerBase< HypreInterface > > geos::HypreInterface::createPreconditioner ( LinearSolverParameters  params, array1d< HypreVector > const &  nearNullKernel  )

static

Create a hypre-based preconditioner object.

Parameters

params	the preconditioner parameters
nearNullKernel	the user-provided near null kernel

Returns

owning pointer to the newly created preconditioner

createSolver()

static std::unique_ptr< LinearSolverBase< HypreInterface > > geos::HypreInterface::createSolver ( LinearSolverParameters  params )

static

Create a hypre-based solver object.

Parameters

params

the preconditioner parameters

Returns

owning pointer to the newly created solver

---

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

• coreComponents/linearAlgebra/interfaces/hypre/HypreInterface.hpp