geosx::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.
using	LinearSolver = PetscSolver
	Alias for PetscSolver.

Static Public Member Functions
static void	initialize (int &argc, char **&argv)
	Initializes the MPI environment for the Petsc library. More...
static void	finalize ()
	Finalizes the MPI environment for the Petsc library. 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 > > geosx::PetscInterface::createPreconditioner ( LinearSolverParameters  params )

static

Create a PETSc-based preconditioner object.

Parameters

params

the parameters for preconditioner

Returns

owning pointer to the newly created preconditioner

createPreconditioner() [2/2]

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

static

Create a PETSc-based preconditioner object.

Parameters

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

Returns

owning pointer to the newly created preconditioner

finalize()

static void geosx::PetscInterface::finalize ( )

static

Finalizes the MPI environment for the Petsc library.

Essentially, it is a wrapper for PetscFinalize

initialize()

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

static

Initializes the MPI environment for the Petsc library.

Parameters

[in]	argc	standard argc as in any C main
[in]	argv	standard argv as in any C main

Essentially, it is a wrapper for PetscInitialize

---

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

• coreComponents/linearAlgebra/interfaces/petsc/PetscInterface.hpp