#include <deal.II/multigrid/mg_matrix.h>

Detailed Description

template<typename VectorType = Vector<double>>
class mg::Matrix< VectorType >

Multilevel matrix. This matrix stores an MGLevelObject of LinearOperator objects. It implements the interface defined in MGMatrixBase, so that it can be used as a matrix in Multigrid.

Definition at line 43 of file mg_matrix.h.

Inheritance diagram for mg::Matrix< VectorType >:

[legend]

Public Member Functions
	Matrix ()=default

template<typename MatrixType >
	Matrix (const MGLevelObject< MatrixType > &M)

template<typename MatrixType >
void	initialize (const MGLevelObject< MatrixType > &M)

void	reset ()

const LinearOperator< VectorType > &	operator[] (unsigned int level) const

virtual void	vmult (const unsigned int level, VectorType &dst, const VectorType &src) const override

virtual void	vmult_add (const unsigned int level, VectorType &dst, const VectorType &src) const override

virtual void	Tvmult (const unsigned int level, VectorType &dst, const VectorType &src) const override

virtual void	Tvmult_add (const unsigned int level, VectorType &dst, const VectorType &src) const override

virtual unsigned int	get_minlevel () const override

virtual unsigned int	get_maxlevel () const override

std::size_t	memory_consumption () const

template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Querying the observer pointers an object has.
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)

Private Member Functions
EnableObserverPointer functionality
Classes derived from EnableObserverPointer provide a facility to subscribe to this object. This is mostly used by the ObserverPointer 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

void	check_no_subscribers () const noexcept

Private Attributes
MGLevelObject< LinearOperator< VectorType > >	matrices

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

Constructor & Destructor Documentation

◆ Matrix() [1/2]

template<typename VectorType = Vector<double>>

mg::Matrix< VectorType >::Matrix ( )

default

Default constructor for an empty object.

◆ Matrix() [2/2]

template<typename VectorType >

template<typename MatrixType >

mg::Matrix< VectorType >::Matrix ( const MGLevelObject< MatrixType > & M )

inline

Constructor setting up pointers to the matrices in M by calling initialize().

Definition at line 230 of file mg_matrix.h.

Member Function Documentation

◆ initialize()

template<typename VectorType >

template<typename MatrixType >

void mg::Matrix< VectorType >::initialize ( const MGLevelObject< MatrixType > & M )

inline

Initialize the object such that the level multiplication uses the matrices in M

Definition at line 202 of file mg_matrix.h.

◆ reset()

template<typename VectorType >

void mg::Matrix< VectorType >::reset ( )

inline

Reset the object.

Definition at line 221 of file mg_matrix.h.

◆ operator[]()

template<typename VectorType >

const LinearOperator< VectorType > & mg::Matrix< VectorType >::operator[] ( unsigned int level ) const

inline

Access matrix on a level.

Definition at line 239 of file mg_matrix.h.

◆ vmult()

template<typename VectorType >

void mg::Matrix< VectorType >::vmult	(	const unsigned int	level,
		VectorType &	dst,
		const VectorType &	src
	)		const

overridevirtual

Matrix-vector-multiplication on a certain level.

Implements MGMatrixBase< VectorType >.

Definition at line 248 of file mg_matrix.h.

◆ vmult_add()

template<typename VectorType >

void mg::Matrix< VectorType >::vmult_add	(	const unsigned int	level,
		VectorType &	dst,
		const VectorType &	src
	)		const

overridevirtual

Adding matrix-vector-multiplication on a certain level.

Implements MGMatrixBase< VectorType >.

Definition at line 259 of file mg_matrix.h.

◆ Tvmult()

template<typename VectorType >

void mg::Matrix< VectorType >::Tvmult	(	const unsigned int	level,
		VectorType &	dst,
		const VectorType &	src
	)		const

overridevirtual

Transpose matrix-vector-multiplication on a certain level.

Implements MGMatrixBase< VectorType >.

Definition at line 270 of file mg_matrix.h.

◆ Tvmult_add()

template<typename VectorType >

void mg::Matrix< VectorType >::Tvmult_add	(	const unsigned int	level,
		VectorType &	dst,
		const VectorType &	src
	)		const

overridevirtual

Adding transpose matrix-vector-multiplication on a certain level.

Implements MGMatrixBase< VectorType >.

Definition at line 281 of file mg_matrix.h.

◆ get_minlevel()

template<typename VectorType >

unsigned int mg::Matrix< VectorType >::get_minlevel ( ) const

overridevirtual

Return the minimal level for which matrices are stored.

Implements MGMatrixBase< VectorType >.

Definition at line 292 of file mg_matrix.h.

◆ get_maxlevel()

template<typename VectorType >

unsigned int mg::Matrix< VectorType >::get_maxlevel ( ) const

overridevirtual

Return the minimal level for which matrices are stored.

Implements MGMatrixBase< VectorType >.

Definition at line 301 of file mg_matrix.h.

◆ memory_consumption()

template<typename VectorType >

std::size_t mg::Matrix< VectorType >::memory_consumption ( ) const

inline

Memory used by this object.

Definition at line 310 of file mg_matrix.h.

◆ n_subscriptions()

unsigned int EnableObserverPointer::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 318 of file enable_observer_pointer.h.

◆ list_subscribers() [1/2]

template<typename StreamType >

void EnableObserverPointer::list_subscribers ( StreamType & stream ) const

inlineinherited

List the subscribers to the input stream.

Definition at line 335 of file enable_observer_pointer.h.

◆ list_subscribers() [2/2]

void EnableObserverPointer::list_subscribers ( ) const

inherited

List the subscribers to deallog.

Definition at line 200 of file enable_observer_pointer.cc.

◆ serialize()

template<class Archive >

void EnableObserverPointer::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 327 of file enable_observer_pointer.h.

◆ subscribe()

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

privateinherited

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

Definition at line 136 of file enable_observer_pointer.cc.

◆ unsubscribe()

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

privateinherited

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 154 of file enable_observer_pointer.cc.

◆ check_no_subscribers()

void EnableObserverPointer::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 58 of file enable_observer_pointer.cc.

Member Data Documentation

◆ matrices

template<typename VectorType = Vector<double>>

MGLevelObject<LinearOperator<VectorType> > mg::Matrix< VectorType >::matrices

private

Definition at line 106 of file mg_matrix.h.

◆ counter

std::atomic<unsigned int> EnableObserverPointer::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 212 of file enable_observer_pointer.h.

◆ counter_map

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

mutableprivateinherited

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

Definition at line 218 of file enable_observer_pointer.h.

◆ validity_pointers

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

mutableprivateinherited

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

Definition at line 224 of file enable_observer_pointer.h.

◆ object_info

const std::type_info* EnableObserverPointer::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 232 of file enable_observer_pointer.h.

◆ mutex

std::mutex EnableObserverPointer::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 239 of file enable_observer_pointer.h.

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

include/deal.II/multigrid/mg_matrix.h

Detailed Description

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Constructor & Destructor Documentation

◆ Matrix() [1/2]

◆ Matrix() [2/2]

Member Function Documentation

◆ initialize()

◆ reset()

◆ operator[]()

◆ vmult()

◆ vmult_add()

◆ Tvmult()

◆ Tvmult_add()

◆ get_minlevel()

◆ get_maxlevel()

◆ memory_consumption()

◆ n_subscriptions()

◆ list_subscribers() [1/2]

◆ list_subscribers() [2/2]

◆ serialize()

◆ subscribe()

◆ unsubscribe()

◆ check_no_subscribers()

Member Data Documentation

◆ matrices

◆ counter

◆ counter_map

◆ validity_pointers

◆ object_info

◆ mutex