Reference documentation for deal.II version Git cd4d0b9268 2020-11-30 14:25:08 -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 | List of all members
MGMatrixBase< VectorType > Class Template Referenceabstract

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

Inheritance diagram for MGMatrixBase< VectorType >:
[legend]

Public Member Functions

virtual ~MGMatrixBase () override=default
 
virtual void vmult (const unsigned int level, VectorType &dst, const VectorType &src) const =0
 
virtual void vmult_add (const unsigned int level, VectorType &dst, const VectorType &src) const =0
 
virtual void Tvmult (const unsigned int level, VectorType &dst, const VectorType &src) const =0
 
virtual void Tvmult_add (const unsigned int level, VectorType &dst, const VectorType &src) const =0
 
virtual unsigned int get_minlevel () const =0
 
virtual unsigned int get_maxlevel () const =0
 
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)
 

Detailed Description

template<typename VectorType>
class MGMatrixBase< VectorType >

Multilevel matrix base. This class sets up the interface needed by multilevel algorithms. It has no relation to the actual matrix type and takes the vector class as only template argument.

Usually, the derived class mg::Matrix, which operates on an MGLevelObject of matrices, will be sufficient for applications.

Definition at line 47 of file mg_base.h.

Constructor & Destructor Documentation

◆ ~MGMatrixBase()

template<typename VectorType>
virtual MGMatrixBase< VectorType >::~MGMatrixBase ( )
overridevirtualdefault

Member Function Documentation

◆ vmult()

template<typename VectorType>
virtual void MGMatrixBase< VectorType >::vmult ( const unsigned int  level,
VectorType dst,
const VectorType src 
) const
pure virtual

Matrix-vector-multiplication on a certain level.

Implemented in MGMatrixSelect< MatrixType, number >, and mg::Matrix< VectorType >.

◆ vmult_add()

template<typename VectorType>
virtual void MGMatrixBase< VectorType >::vmult_add ( const unsigned int  level,
VectorType dst,
const VectorType src 
) const
pure virtual

Adding matrix-vector-multiplication on a certain level.

Implemented in MGMatrixSelect< MatrixType, number >, and mg::Matrix< VectorType >.

◆ Tvmult()

template<typename VectorType>
virtual void MGMatrixBase< VectorType >::Tvmult ( const unsigned int  level,
VectorType dst,
const VectorType src 
) const
pure virtual

Transpose matrix-vector-multiplication on a certain level.

Implemented in MGMatrixSelect< MatrixType, number >, and mg::Matrix< VectorType >.

◆ Tvmult_add()

template<typename VectorType>
virtual void MGMatrixBase< VectorType >::Tvmult_add ( const unsigned int  level,
VectorType dst,
const VectorType src 
) const
pure virtual

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

Implemented in MGMatrixSelect< MatrixType, number >, and mg::Matrix< VectorType >.

◆ get_minlevel()

template<typename VectorType>
virtual unsigned int MGMatrixBase< VectorType >::get_minlevel ( ) const
pure virtual

Return the minimal level for which matrices are stored.

Implemented in mg::Matrix< VectorType >.

◆ get_maxlevel()

template<typename VectorType>
virtual unsigned int MGMatrixBase< VectorType >::get_maxlevel ( ) const
pure virtual

Return the minimal level for which matrices are stored.

Implemented in mg::Matrix< VectorType >.

◆ 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.


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