Reference documentation for deal.II version 9.2.0
\(\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 | 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
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&) noexcept
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&) noexcept
 
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
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Additional Inherited Members

- Static Public Member Functions inherited from Subscriptor
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.

Author
Guido Kanschat, 2002

Definition at line 49 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 >.

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

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

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

◆ get_minlevel()

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

Return the minimal level for which matrices are stored.

◆ get_maxlevel()

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

Return the minimal level for which matrices are stored.


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