ablate::utilities::PetscUtilities Class Reference

Classes
class	ErrorChecker

Static Public Member Functions
static void	Initialize (const char[]=nullptr)
static void	Set (const std::string &prefix, const std::map< std::string, std::string > &options, bool override=true)
static void	Set (const std::map< std::string, std::string > &options)
static void	Set (PetscOptions petscOptions, const std::map< std::string, std::string > &options)
static void	Set (PetscOptions petscOptions, const char name[], const char value[], bool override=true)
static void	PetscOptionsDestroyAndCheck (const std::string &name, PetscOptions *options)

Static Public Attributes
static utilities::PetscUtilities::ErrorChecker	checkError

Member Function Documentation

Initialize()

void ablate::utilities::PetscUtilities::Initialize ( const char  help[] = nullptr )

static

static call to setup petsc petsc and register cleanup call

PetscOptionsDestroyAndCheck()

void ablate::utilities::PetscUtilities::PetscOptionsDestroyAndCheck ( const std::string &  name, PetscOptions *  options  )

static

Clean up and check for unused options

Parameters

name
options

Set() [1/4]

void ablate::utilities::PetscUtilities::Set ( const std::map< std::string, std::string > &  options )

static

Support for setting global petsc options with a msp

Parameters

prefix
options

Set() [2/4]

void ablate::utilities::PetscUtilities::Set ( const std::string &  prefix, const std::map< std::string, std::string > &  options, bool  override = true  )

static

Support for setting global petsc options with a prefix and options map

Parameters

prefix
options
override	force override existing options if present (default true)

Set() [3/4]

static void ablate::utilities::PetscUtilities::Set ( PetscOptions  petscOptions, const char  name[], const char  value[], bool  override = true  )

static

Set specific petsc options object. If overide is false, this will not replace exisiting options

Parameters

petscOptions
name
value
override

Set() [4/4]

void ablate::utilities::PetscUtilities::Set ( PetscOptions  petscOptions, const std::map< std::string, std::string > &  options  )

static

Set specific petsc options object

Parameters

petscOptions
options

Member Data Documentation

checkError

utilities::PetscUtilities::ErrorChecker ablate::utilities::PetscUtilities::checkError

inlinestatic

static inline error checker for petsc based errors

---

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

• src/utilities/petscUtilities.hpp
• src/utilities/petscUtilities.cpp