PETScWrappers::PreconditionBase Class Reference

#include <deal.II/lac/petsc_precondition.h>

Inheritance diagram for PETScWrappers::PreconditionBase:

Public Member Functions
	PreconditionBase (const MPI_Comm mpi_communicator)
	PreconditionBase ()
virtual	~PreconditionBase ()
void	clear ()
void	vmult (VectorBase &dst, const VectorBase &src) const
void	Tvmult (VectorBase &dst, const VectorBase &src) const
void	setup ()
const PC &	get_pc () const
MPI_Comm	get_mpi_communicator () const
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
Subscriptor functionality
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.
void	subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
void	unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
unsigned int	n_subscriptions () const
template<typename StreamType >
void	list_subscribers (StreamType &stream) const
void	list_subscribers () const

Static Public Member Functions
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Protected Member Functions
void	create_pc_with_mat (const MatrixBase &)
void	create_pc_with_comm (const MPI_Comm)

Protected Attributes
PC	pc

Private Types
using	map_value_type = decltype(counter_map)::value_type
using	map_iterator = decltype(counter_map)::iterator

Private Member Functions
void	check_no_subscribers () const noexcept

Private Attributes
std::atomic< unsigned int >	counter
std::map< std::string, unsigned int >	counter_map
std::vector< std::atomic< bool > * >	validity_pointers
const std::type_info *	object_info

Static Private Attributes
static std::mutex	mutex

Detailed Description

Base class for preconditioner classes using the PETSc functionality. The classes in this hierarchy don't do a whole lot, except for providing a function that sets the preconditioner and certain parameters on the preconditioning context of the solver. These classes are basically here only to allow a similar interface as already used for the deal.II solver and preconditioner classes.

Note that derived classes only provide interfaces to the relevant functionality of PETSc. PETSc does not implement all preconditioners for all matrix types. In particular, some preconditioners are not going to work for parallel jobs, such as for example the ILU preconditioner.

Definition at line 59 of file petsc_precondition.h.

Member Typedef Documentation

map_value_type

using Subscriptor::map_value_type = decltype(counter_map)::value_type

privateinherited

The data type used in counter_map.

Definition at line 229 of file subscriptor.h.

map_iterator

using Subscriptor::map_iterator = decltype(counter_map)::iterator

privateinherited

The iterator type used in counter_map.

Definition at line 234 of file subscriptor.h.

Constructor & Destructor Documentation

PreconditionBase() [1/2]

PETScWrappers::PreconditionBase::PreconditionBase ( const MPI_Comm mpi_communicator )

explicit

Constructor.

Definition at line 35 of file petsc_precondition.cc.

PreconditionBase() [2/2]

PETScWrappers::PreconditionBase::PreconditionBase

(

)

Constructor.

Definition at line 41 of file petsc_precondition.cc.

~PreconditionBase()

PETScWrappers::PreconditionBase::~PreconditionBase ( )

virtual

Destructor.

Definition at line 45 of file petsc_precondition.cc.

Member Function Documentation

clear()

void PETScWrappers::PreconditionBase::clear

(

)

Destroys the preconditioner, leaving an object like just after having called the default constructor.

Definition at line 56 of file petsc_precondition.cc.

vmult()

void PETScWrappers::PreconditionBase::vmult	(	VectorBase &	dst,
		const VectorBase &	src ) const

Apply the preconditioner once to the given src vector.

Definition at line 66 of file petsc_precondition.cc.

Tvmult()

void PETScWrappers::PreconditionBase::Tvmult	(	VectorBase &	dst,
		const VectorBase &	src ) const

Apply the transpose preconditioner once to the given src vector.

Definition at line 75 of file petsc_precondition.cc.

setup()

void PETScWrappers::PreconditionBase::setup

(

)

Explicitly call setup. This is usually not needed since PETSc will automatically call the setup function when needed.

Definition at line 84 of file petsc_precondition.cc.

get_pc()

const PC & PETScWrappers::PreconditionBase::get_pc

(

)

const

Give access to the underlying PETSc object.

Definition at line 125 of file petsc_precondition.cc.

get_mpi_communicator()

MPI_Comm PETScWrappers::PreconditionBase::get_mpi_communicator

(

)

const

Return the underlying MPI communicator.

Definition at line 93 of file petsc_precondition.cc.

create_pc_with_mat()

void PETScWrappers::PreconditionBase::create_pc_with_mat ( const MatrixBase & matrix )

protected

Internal function to create the PETSc preconditioner object. Fails if called twice.

Definition at line 99 of file petsc_precondition.cc.

create_pc_with_comm()

void PETScWrappers::PreconditionBase::create_pc_with_comm ( const MPI_Comm comm )

protected

Internal function to create the PETSc preconditioner object.

Definition at line 117 of file petsc_precondition.cc.

subscribe()

void Subscriptor::subscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const

inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 135 of file subscriptor.cc.

unsubscribe()

void Subscriptor::unsubscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const

inherited

Unsubscribes a user from the object.

Note

The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 155 of file subscriptor.cc.

n_subscriptions()

unsigned int Subscriptor::n_subscriptions ( ) const

inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 300 of file subscriptor.h.

list_subscribers() [1/2]

template<typename StreamType >

void Subscriptor::list_subscribers ( StreamType & stream ) const

inlineinherited

List the subscribers to the input stream.

Definition at line 317 of file subscriptor.h.

list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const

inherited

List the subscribers to deallog.

Definition at line 203 of file subscriptor.cc.

serialize()

template<class Archive >

void Subscriptor::serialize ( Archive & ar, const unsigned int version )

inlineinherited

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 309 of file subscriptor.h.

check_no_subscribers()

void Subscriptor::check_no_subscribers ( ) const

privatenoexceptinherited

Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.

Note

Since this function is just a consistency check it does nothing in release mode.

If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 52 of file subscriptor.cc.

Member Data Documentation

pc

PC PETScWrappers::PreconditionBase::pc

protected

The PETSc preconditioner object

Definition at line 120 of file petsc_precondition.h.

counter

std::atomic<unsigned int> Subscriptor::counter

mutableprivateinherited

Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).

The creator (and owner) of an object is counted in the map below if HE manages to supply identification.

We use the mutable keyword in order to allow subscription to constant objects also.

This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic class template.

Definition at line 218 of file subscriptor.h.

counter_map

std::map<std::string, unsigned int> Subscriptor::counter_map

mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 224 of file subscriptor.h.

validity_pointers

std::vector<std::atomic<bool> *> Subscriptor::validity_pointers

mutableprivateinherited

In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.

Definition at line 240 of file subscriptor.h.

object_info

const std::type_info* Subscriptor::object_info

mutableprivateinherited

Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.

Definition at line 248 of file subscriptor.h.

mutex

std::mutex Subscriptor::mutex

staticprivateinherited

A mutex used to ensure data consistency when accessing the mutable members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers().

Definition at line 271 of file subscriptor.h.

---

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

• include/deal.II/lac/petsc_precondition.h
• source/lac/petsc_precondition.cc