Reference documentation for deal.II version Git 16b398077e 2020-12-04 17:16:12 -0500
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
mg::Matrix< VectorType > Class Template Reference

#include <deal.II/multigrid/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)
 
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 ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

Private Attributes

MGLevelObject< LinearOperator< VectorType > > matrices
 

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 44 of file mg_matrix.h.

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 228 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 219 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 237 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 246 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 257 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 268 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 279 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 290 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 299 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 308 of file mg_matrix.h.

◆ 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 136 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 156 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 204 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.

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.

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.


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