Reference documentation for deal.II version Git 3f1f337db3 2021-10-23 13:19:02 -0600
\(\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 | Public Attributes | List of all members
mg::SparseMatrixCollection< number > Class Template Reference

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

Inheritance diagram for mg::SparseMatrixCollection< number >:
[legend]

Public Member Functions

void resize (const unsigned int minlevel, const unsigned int maxlevel)
 
template<int dim, int spacedim>
void reinit (const DoFHandler< dim, spacedim > &dof_handler)
 
void set_zero ()
 
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)
 

Public Attributes

MGLevelObject< SparsityPatternsparsity
 
MGLevelObject< SparsityPatternsparsity_edge
 
MGLevelObject< SparseMatrix< number > > matrix
 
MGLevelObject< SparseMatrix< number > > matrix_down
 
MGLevelObject< SparseMatrix< number > > matrix_up
 
MGLevelObject< SparseMatrix< number > > matrix_in
 
MGLevelObject< SparseMatrix< number > > matrix_out
 

Detailed Description

template<typename number>
class mg::SparseMatrixCollection< number >

Handler and storage for all five SparseMatrix object involved in using multigrid with local refinement.

Definition at line 41 of file sparse_matrix_collection.h.

Member Function Documentation

◆ resize()

template<typename number >
void mg::SparseMatrixCollection< number >::resize ( const unsigned int  minlevel,
const unsigned int  maxlevel 
)

Definition at line 67 of file sparse_matrix_collection.h.

◆ reinit()

template<typename number >
template<int dim, int spacedim>
void mg::SparseMatrixCollection< number >::reinit ( const DoFHandler< dim, spacedim > &  dof_handler)

Definition at line 88 of file sparse_matrix_collection.h.

◆ set_zero()

template<typename number >
void mg::SparseMatrixCollection< number >::set_zero ( )

Definition at line 121 of file sparse_matrix_collection.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 301 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 318 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 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 310 of file subscriptor.h.

Member Data Documentation

◆ sparsity

template<typename number >
MGLevelObject<SparsityPattern> mg::SparseMatrixCollection< number >::sparsity

Definition at line 54 of file sparse_matrix_collection.h.

◆ sparsity_edge

template<typename number >
MGLevelObject<SparsityPattern> mg::SparseMatrixCollection< number >::sparsity_edge

Definition at line 55 of file sparse_matrix_collection.h.

◆ matrix

template<typename number >
MGLevelObject<SparseMatrix<number> > mg::SparseMatrixCollection< number >::matrix

Definition at line 57 of file sparse_matrix_collection.h.

◆ matrix_down

template<typename number >
MGLevelObject<SparseMatrix<number> > mg::SparseMatrixCollection< number >::matrix_down

Definition at line 58 of file sparse_matrix_collection.h.

◆ matrix_up

template<typename number >
MGLevelObject<SparseMatrix<number> > mg::SparseMatrixCollection< number >::matrix_up

Definition at line 59 of file sparse_matrix_collection.h.

◆ matrix_in

template<typename number >
MGLevelObject<SparseMatrix<number> > mg::SparseMatrixCollection< number >::matrix_in

Definition at line 60 of file sparse_matrix_collection.h.

◆ matrix_out

template<typename number >
MGLevelObject<SparseMatrix<number> > mg::SparseMatrixCollection< number >::matrix_out

Definition at line 61 of file sparse_matrix_collection.h.


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