GEOSX
Public Types | Static Public Member Functions | List of all members
geos::PetscInterface Class Reference

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

#include <PetscInterface.hpp>

Public Types

using ParallelMatrix = PetscMatrix
 Alias for PetscMatrix.
 
using ParallelVector = PetscVector
 Alias for PetscVector.
 

Static Public Member Functions

static void initialize ()
 Initializes the Petsc library.
 
static void finalize ()
 Finalizes the Petsc library.
 
static std::unique_ptr< LinearSolverBase< PetscInterface > > createSolver (LinearSolverParameters params)
 Create a petsc-based solver object. More...
 
static std::unique_ptr< PreconditionerBase< PetscInterface > > createPreconditioner (LinearSolverParameters params)
 Create a PETSc-based preconditioner object. More...
 
static std::unique_ptr< PreconditionerBase< PetscInterface > > createPreconditioner (LinearSolverParameters params, array1d< PetscVector > const &nearNullKernel)
 Create a PETSc-based preconditioner object. More...
 

Detailed Description

This class holds aliases based on the Petsc library.

Definition at line 36 of file PetscInterface.hpp.

Member Function Documentation

◆ createPreconditioner() [1/2]

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

Create a PETSc-based preconditioner object.

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

◆ createPreconditioner() [2/2]

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

Create a PETSc-based preconditioner object.

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

◆ createSolver()

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

Create a petsc-based solver object.

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

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