GEOSX
Public Types | Static Public Member Functions | List of all members
geosx::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.
 
using LinearSolver = HypreSolver
 Alias for HypreSolver.
 

Static Public Member Functions

static void initialize (int &argc, char **&argv)
 Initializes the MPI environment for the Hypre library. More...
 
static void finalize ()
 Finalizes the MPI environment for the Hypre library.
 
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 36 of file HypreInterface.hpp.

Member Function Documentation

◆ createPreconditioner() [1/2]

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

Create a hypre-based preconditioner object.

Parameters
paramsthe preconditioner parameters
Returns
owning pointer to the newly created preconditioner

◆ createPreconditioner() [2/2]

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

Create a hypre-based preconditioner object.

Parameters
paramsthe preconditioner parameters
nearNullKernelthe user-provided near null kernel
Returns
owning pointer to the newly created preconditioner

◆ initialize()

static void geosx::HypreInterface::initialize ( int &  argc,
char **&  argv 
)
static

Initializes the MPI environment for the Hypre library.

Parameters
[in]argcstandard argc as in any C main
[in]argvstandard argv as in any C main

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