This class provides an interface to the suite of preconditioners available from PETSc. More...

#include <petsc_preconditioner.h>

Inheritance diagram for libMesh::PetscPreconditioner< T >:

Public Member Functions
	PetscPreconditioner (const libMesh::Parallel::Communicator &comm_in)
	Constructor. More...

virtual	~PetscPreconditioner ()
	Destructor. More...

virtual void	apply (const NumericVector< T > &x, NumericVector< T > &y) override
	Computes the preconditioned vector `y` based on input vector `x`. More...

virtual void	clear () override
	Release all memory and clear data structures. More...

virtual void	init () override
	Initialize data structures if not done so already. More...

PC	pc ()

bool	initialized () const

virtual void	setup ()
	This is called every time the "operator might have changed". More...

void	set_matrix (SparseMatrix< Number > &mat)
	Sets the matrix to be preconditioned. More...

PreconditionerType	type () const

void	set_type (const PreconditionerType pct)
	Sets the type of preconditioner to use. More...

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static void	set_petsc_preconditioner_type (const PreconditionerType &preconditioner_type, PC &pc)
	Tells PETSc to use the user-specified preconditioner. More...

static std::unique_ptr< Preconditioner< T > >	build_preconditioner (const libMesh::Parallel::Communicator &comm, const SolverPackage solver_package=libMesh::default_solver_package())
	Builds a `Preconditioner` using the linear solver package specified by `solver_package`, returning the result wrapped in a std::unique_ptr for safety. More...

static Preconditioner< T > *	build (const libMesh::Parallel::Communicator &comm, const SolverPackage solver_package=libMesh::default_solver_package())
	Builds a `Preconditioner` using the linear solver package specified by `solver_package`. More...

static std::string	get_info ()
	Gets a string containing the reference information. More...

static void	print_info (std::ostream &out=libMesh::out)
	Prints the reference information, by default to `libMesh::out`. More...

static unsigned int	n_objects ()
	Prints the number of outstanding (created, but not yet destroyed) objects. More...

static void	enable_print_counter_info ()
	Methods to enable/disable the reference counter output from print_info() More...

static void	disable_print_counter_info ()

Protected Types
typedef std::map< std::string, std::pair< unsigned int, unsigned int > >	Counts
	Data structure to log the information. More...

Protected Member Functions
void	increment_constructor_count (const std::string &name)
	Increments the construction counter. More...

void	increment_destructor_count (const std::string &name)
	Increments the destruction counter. More...

Protected Attributes
PC	_pc
	Preconditioner context. More...

Mat	_mat
	PETSc Mat pulled out of the _matrix object during init(). More...

SparseMatrix< T > *	_matrix
	The matrix P... More...

PreconditionerType	_preconditioner_type
	Enum stating with type of preconditioner to use. More...

bool	_is_initialized
	Flag indicating if the data structures have been initialized. More...

const Parallel::Communicator &	_communicator

Static Protected Attributes
static Counts	_counts
	Actually holds the data. More...

static Threads::atomic< unsigned int >	_n_objects
	The number of objects. More...

static Threads::spin_mutex	_mutex
	Mutual exclusion object to enable thread-safe reference counting. More...

static bool	_enable_print_counter
	Flag to control whether reference count information is printed when print_info is called. More...

Static Private Member Functions
static void	set_petsc_subpreconditioner_type (PCType type, PC &pc)
	Some PETSc preconditioners (ILU, LU) don't work in parallel. More...

static void	set_petsc_subpreconditioner_type (const PCType type, PC &pc)

Detailed Description

template<typename T>
class libMesh::PetscPreconditioner< T >

This class provides an interface to the suite of preconditioners available from PETSc.

All overridden virtual functions are documented in preconditioner.h.

Author: Derek Gaston

Date: 2009

Definition at line 63 of file petsc_preconditioner.h.

Member Typedef Documentation

◆ Counts

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts

protectedinherited

Data structure to log the information.

The log is identified by the class name.

Definition at line 117 of file reference_counter.h.

Constructor & Destructor Documentation

◆ PetscPreconditioner()

template<typename T >

libMesh::PetscPreconditioner< T >::PetscPreconditioner ( const libMesh::Parallel::Communicator & comm_in )

Constructor.

Initializes PetscPreconditioner data structures

Definition at line 129 of file petsc_preconditioner.h.

                                                                                         :
   Preconditioner<T>(comm_in),
   _pc(PETSC_NULL)
 {
 }

◆ ~PetscPreconditioner()

template<typename T >

libMesh::PetscPreconditioner< T >::~PetscPreconditioner ( )

virtual

Destructor.

Definition at line 139 of file petsc_preconditioner.h.

 {
   this->clear ();
 }

Member Function Documentation

◆ apply()

template<typename T >

virtual void libMesh::PetscPreconditioner< T >::apply	(	const NumericVector< T > &	x,
		NumericVector< T > &	y
	)

overridevirtual

Computes the preconditioned vector y based on input vector x.

This is usually done by solving $ Py=x $ to get the action of $ P^-1 x $ .

Implements libMesh::Preconditioner< T >.

◆ build()

template<typename T>

static Preconditioner<T>* libMesh::Preconditioner< T >::build	(	const libMesh::Parallel::Communicator &	comm,
		const SolverPackage	solver_package = `libMesh::default_solver_package()`
	)

staticinherited

Builds a Preconditioner using the linear solver package specified by solver_package.

Deprecated:: Use build_preconditioner() instead.

◆ build_preconditioner()

template<typename T>

static std::unique_ptr<Preconditioner<T> > libMesh::Preconditioner< T >::build_preconditioner	(	const libMesh::Parallel::Communicator &	comm,
		const SolverPackage	solver_package = `libMesh::default_solver_package()`
	)

staticinherited

Builds a Preconditioner using the linear solver package specified by solver_package, returning the result wrapped in a std::unique_ptr for safety.

◆ clear()

template<typename T >

virtual void libMesh::PetscPreconditioner< T >::clear ( )

overridevirtual

Release all memory and clear data structures.

Reimplemented from libMesh::Preconditioner< T >.

◆ comm()

const Parallel::Communicator& libMesh::ParallelObject::comm ( ) const

inherited

Returns: A reference to the Parallel::Communicator object used by this mesh.

Definition at line 89 of file parallel_object.h.

References libMesh::ParallelObject::_communicator.

Referenced by libMesh::EpetraVector< T >::EpetraVector(), libMesh::Parallel::sync_element_data_by_parent_id(), libMesh::Parallel::sync_node_data_by_element_id(), and libMesh::Parallel::sync_node_data_by_element_id_once().

90 { return _communicator; }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

◆ disable_print_counter_info()

static void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

◆ enable_print_counter_info()

static void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

Methods to enable/disable the reference counter output from print_info()

◆ get_info()

static std::string libMesh::ReferenceCounter::get_info ( )

staticinherited

Gets a string containing the reference information.

◆ increment_constructor_count()

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string & name )

protectedinherited

Increments the construction counter.

Should be called in the constructor of any derived class that will be reference counted.

Definition at line 181 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
 
   p.first++;
 }

◆ increment_destructor_count()

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string & name )

protectedinherited

Increments the destruction counter.

Should be called in the destructor of any derived class that will be reference counted.

Definition at line 194 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
 
   p.second++;
 }

◆ init()

template<typename T >

virtual void libMesh::PetscPreconditioner< T >::init ( )

overridevirtual

Initialize data structures if not done so already.

Note: This MUST be called before the preconditioning object is used.

Reimplemented from libMesh::Preconditioner< T >.

◆ initialized()

template<typename T>

bool libMesh::Preconditioner< T >::initialized ( ) const

inherited

Returns: true if the data structures are initialized, false otherwise.

Definition at line 106 of file preconditioner.h.

106 { return _is_initialized; }

libMesh::Preconditioner::_is_initialized

bool _is_initialized

Flag indicating if the data structures have been initialized.

Definition: preconditioner.h:165

◆ n_objects()

static unsigned int libMesh::ReferenceCounter::n_objects ( )

staticinherited

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 83 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

84 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition: reference_counter.h:130

◆ n_processors()

processor_id_type libMesh::ParallelObject::n_processors ( ) const

inherited

Returns: The number of processors in the group.

Definition at line 95 of file parallel_object.h.

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::size().

Referenced by libMesh::MeshBase::partition().

96 { return cast_int<processor_id_type>(_communicator.size()); }

libMesh::Parallel::Communicator::size

processor_id_type size() const

Definition: communicator.h:175

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

◆ pc()

template<typename T >

PC libMesh::PetscPreconditioner< T >::pc ( )

Returns: The PETSc PC object. Can be useful for implementing more advanced algorithms.

Definition at line 87 of file petsc_preconditioner.h.

References libMesh::PetscPreconditioner< T >::_pc.

87 { return _pc; }

libMesh::PetscPreconditioner::_pc

PC _pc

Preconditioner context.

Definition: petsc_preconditioner.h:99

◆ print_info()

static void libMesh::ReferenceCounter::print_info ( std::ostream & out = libMesh::out )

staticinherited

Prints the reference information, by default to libMesh::out.

◆ processor_id()

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inherited

Returns: The rank of this processor in the group.

Definition at line 101 of file parallel_object.h.

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::rank().

Referenced by libMesh::DofMap::end_dof(), libMesh::DofMap::end_old_dof(), libMesh::DofMap::first_dof(), libMesh::DofMap::first_old_dof(), libMesh::DofMap::last_dof(), libMesh::MeshBase::n_active_local_elem(), libMesh::DofMap::n_local_dofs(), libMesh::MeshBase::n_local_elem(), libMesh::MeshBase::n_local_nodes(), and libMesh::MeshTools::weight().

102 { return cast_int<processor_id_type>(_communicator.rank()); }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

libMesh::Parallel::Communicator::rank

processor_id_type rank() const

Definition: communicator.h:173

◆ set_matrix()

template<typename T >

void libMesh::Preconditioner< T >::set_matrix ( SparseMatrix< Number > & mat )

inherited

Sets the matrix to be preconditioned.

Definition at line 181 of file preconditioner.h.

 {
   //If the matrix is changing then we (probably) need to reinitialize.
   _is_initialized = false;
   _matrix = &mat;
 }

◆ set_petsc_preconditioner_type()

template<typename T >

static void libMesh::PetscPreconditioner< T >::set_petsc_preconditioner_type	(	const PreconditionerType &	preconditioner_type,
		PC &	pc
	)

static

Tells PETSc to use the user-specified preconditioner.

◆ set_petsc_subpreconditioner_type() [1/2]

template<typename T >

static void libMesh::PetscPreconditioner< T >::set_petsc_subpreconditioner_type	(	PCType	type,
		PC &	pc
	)

staticprivate

Some PETSc preconditioners (ILU, LU) don't work in parallel.

This function is called from set_petsc_preconditioner_type() to set additional options for those so-called sub-preconditioners. This method ends up being static so that it can be called from set_petsc_preconditioner_type(). Not sure why set_petsc_preconditioner_type() needs to be static though...

◆ set_petsc_subpreconditioner_type() [2/2]

template<typename T >

static void libMesh::PetscPreconditioner< T >::set_petsc_subpreconditioner_type	(	const PCType	type,
		PC &	pc
	)

staticprivate

◆ set_type()

template<typename T >

void libMesh::Preconditioner< T >::set_type ( const PreconditionerType pct )

inherited

Sets the type of preconditioner to use.

Definition at line 190 of file preconditioner.h.

 {
   //If the preconditioner type changes we (probably) need to reinitialize.
   _is_initialized = false;
   _preconditioner_type = pct;
 }

◆ setup()

template<typename T>

virtual void libMesh::Preconditioner< T >::setup ( )

virtualinherited

This is called every time the "operator might have changed".

This is where you need to fill in your preconditioning matrix.

Definition at line 132 of file preconditioner.h.

132 {}

◆ type()

template<typename T>

PreconditionerType libMesh::Preconditioner< T >::type ( ) const

inherited

Returns: The type of preconditioner to use.

Definition at line 142 of file preconditioner.h.

142 { return _preconditioner_type; }

libMesh::Preconditioner::_preconditioner_type

PreconditionerType _preconditioner_type

Enum stating with type of preconditioner to use.

Definition: preconditioner.h:160

Member Data Documentation

◆ _communicator

const Parallel::Communicator& libMesh::ParallelObject::_communicator

protectedinherited

Definition at line 107 of file parallel_object.h.

Referenced by libMesh::ParallelObject::comm(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::operator=(), and libMesh::ParallelObject::processor_id().

◆ _counts

Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::increment_constructor_count(), and libMesh::ReferenceCounter::increment_destructor_count().

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter

staticprotectedinherited

Flag to control whether reference count information is printed when print_info is called.

Definition at line 141 of file reference_counter.h.

◆ _is_initialized

template<typename T>

bool libMesh::Preconditioner< T >::_is_initialized

protectedinherited

Flag indicating if the data structures have been initialized.

Definition at line 165 of file preconditioner.h.

Referenced by libMesh::Preconditioner< Number >::initialized().

◆ _mat

template<typename T >

Mat libMesh::PetscPreconditioner< T >::_mat

protected

PETSc Mat pulled out of the _matrix object during init().

Definition at line 104 of file petsc_preconditioner.h.

◆ _matrix

template<typename T>

SparseMatrix<T>* libMesh::Preconditioner< T >::_matrix

protectedinherited

The matrix P...

ie the matrix to be preconditioned. This is often the actual system matrix of a linear system.

Definition at line 155 of file preconditioner.h.

◆ _mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 of file reference_counter.h.

◆ _n_objects

Threads::atomic<unsigned int> libMesh::ReferenceCounter::_n_objects

staticprotectedinherited

The number of objects.

Print the reference count information when the number returns to 0.

Definition at line 130 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

◆ _pc

template<typename T >

PC libMesh::PetscPreconditioner< T >::_pc

protected

Preconditioner context.

Definition at line 99 of file petsc_preconditioner.h.

Referenced by libMesh::PetscPreconditioner< T >::pc().

◆ _preconditioner_type

template<typename T>

PreconditionerType libMesh::Preconditioner< T >::_preconditioner_type

protectedinherited

Enum stating with type of preconditioner to use.

Definition at line 160 of file preconditioner.h.

Referenced by libMesh::Preconditioner< Number >::type().

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

include/numerics/petsc_preconditioner.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Static Private Member Functions

Detailed Description

template<typename T> class libMesh::PetscPreconditioner< T >

Member Typedef Documentation

◆ Counts

Constructor & Destructor Documentation

◆ PetscPreconditioner()

◆ ~PetscPreconditioner()

Member Function Documentation

◆ apply()

◆ build()

◆ build_preconditioner()

◆ clear()

◆ comm()

◆ disable_print_counter_info()

◆ enable_print_counter_info()

◆ get_info()

◆ increment_constructor_count()

◆ increment_destructor_count()

◆ init()

◆ initialized()

◆ n_objects()

◆ n_processors()

◆ pc()

◆ print_info()

◆ processor_id()

◆ set_matrix()

◆ set_petsc_preconditioner_type()

◆ set_petsc_subpreconditioner_type() [1/2]

◆ set_petsc_subpreconditioner_type() [2/2]

◆ set_type()

◆ setup()

◆ type()

Member Data Documentation

◆ _communicator

◆ _counts

◆ _enable_print_counter

◆ _is_initialized

◆ _mat

◆ _matrix

◆ _mutex

◆ _n_objects

◆ _pc

◆ _preconditioner_type

template<typename T>
class libMesh::PetscPreconditioner< T >