Reference documentation for deal.II version 9.6.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\}}\)
Loading...
Searching...
No Matches
SparsityPatternBase Class Referenceabstract

#include <deal.II/lac/sparsity_pattern_base.h>

Inheritance diagram for SparsityPatternBase:

Public Types

using size_type = types::global_dof_index
 

Public Member Functions

 SparsityPatternBase ()
 
 SparsityPatternBase (const size_type rows, const size_type cols)
 
 SparsityPatternBase (const SparsityPatternBase &sparsity_pattern)=default
 
 SparsityPatternBase (SparsityPatternBase &&sparsity_pattern) noexcept=default
 
SparsityPatternBaseoperator= (const SparsityPatternBase &sparsity_pattern)=default
 
SparsityPatternBaseoperator= (SparsityPatternBase &&sparsity_pattern) noexcept=default
 
size_type n_rows () const
 
size_type n_cols () const
 
virtual void add_row_entries (const size_type &row, const ArrayView< const size_type > &columns, const bool indices_are_sorted=false)=0
 
virtual void add_entries (const ArrayView< const std::pair< size_type, size_type > > &entries)
 
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)
 

Protected Member Functions

virtual void resize (const size_type rows, const size_type cols)
 

Protected Attributes

size_type rows
 
size_type cols
 

Private Types

using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 

Private Member Functions

void check_no_subscribers () const noexcept
 

Private Attributes

std::atomic< unsigned intcounter
 
std::map< std::string, unsigned intcounter_map
 
std::vector< std::atomic< bool > * > validity_pointers
 
const std::type_info * object_info
 

Static Private Attributes

static std::mutex mutex
 

Detailed Description

Base class for all sparsity patterns, defining a common interface by which new values can be added.

Definition at line 38 of file sparsity_pattern_base.h.

Member Typedef Documentation

◆ size_type

Declare type for container size.

Definition at line 44 of file sparsity_pattern_base.h.

◆ map_value_type

using Subscriptor::map_value_type = decltype(counter_map)::value_type
privateinherited

The data type used in counter_map.

Definition at line 229 of file subscriptor.h.

◆ map_iterator

using Subscriptor::map_iterator = decltype(counter_map)::iterator
privateinherited

The iterator type used in counter_map.

Definition at line 234 of file subscriptor.h.

Constructor & Destructor Documentation

◆ SparsityPatternBase() [1/4]

SparsityPatternBase::SparsityPatternBase ( )

Constructor. Sets up an empty (zero-by-zero) sparsity pattern.

◆ SparsityPatternBase() [2/4]

SparsityPatternBase::SparsityPatternBase ( const size_type rows,
const size_type cols )

Constructor. Sets up a rows by cols sparsity pattern.

◆ SparsityPatternBase() [3/4]

SparsityPatternBase::SparsityPatternBase ( const SparsityPatternBase & sparsity_pattern)
default

Copy constructor.

◆ SparsityPatternBase() [4/4]

SparsityPatternBase::SparsityPatternBase ( SparsityPatternBase && sparsity_pattern)
defaultnoexcept

Move constructor.

Member Function Documentation

◆ operator=() [1/2]

SparsityPatternBase & SparsityPatternBase::operator= ( const SparsityPatternBase & sparsity_pattern)
default

Assignment operator.

◆ operator=() [2/2]

SparsityPatternBase & SparsityPatternBase::operator= ( SparsityPatternBase && sparsity_pattern)
defaultnoexcept

Move assignment operator.

◆ n_rows()

size_type SparsityPatternBase::n_rows ( ) const

Return number of rows of this matrix, which equals the dimension of the image space.

◆ n_cols()

size_type SparsityPatternBase::n_cols ( ) const

Return number of columns of this matrix, which equals the dimension of the range space.

◆ add_row_entries()

virtual void SparsityPatternBase::add_row_entries ( const size_type & row,
const ArrayView< const size_type > & columns,
const bool indices_are_sorted = false )
pure virtual

◆ add_entries()

void SparsityPatternBase::add_entries ( const ArrayView< const std::pair< size_type, size_type > > & entries)
virtual

General function for adding new entries from an unsorted list of pairs.

This function is useful when multiple entries need to be added which do not correspond to a particular row, e.g., when assembling a flux sparsity pattern.

Reimplemented in BlockSparsityPatternBase< SparsityPatternType >, BlockSparsityPatternBase< DynamicSparsityPattern >, BlockSparsityPatternBase< SparsityPattern >, DynamicSparsityPattern, LinearAlgebra::TpetraWrappers::SparsityPattern< MemorySpace >, LinearAlgebra::TpetraWrappers::SparsityPattern< ::MemorySpace::Host >, LinearAlgebra::TpetraWrappers::SparsityPattern< MemorySpace >, SparsityPattern, and TrilinosWrappers::SparsityPattern.

Definition at line 25 of file sparsity_pattern_base.cc.

◆ resize()

virtual void SparsityPatternBase::resize ( const size_type rows,
const size_type cols )
protectedvirtual

Internal function for updating the stored size of the sparsity pattern.

◆ 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 135 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 155 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 203 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 309 of file subscriptor.h.

◆ check_no_subscribers()

void Subscriptor::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 52 of file subscriptor.cc.

Member Data Documentation

◆ rows

size_type SparsityPatternBase::rows
protected

Number of rows that this sparsity pattern shall represent.

Definition at line 121 of file sparsity_pattern_base.h.

◆ cols

size_type SparsityPatternBase::cols
protected

Number of columns that this sparsity pattern shall represent.

Definition at line 126 of file sparsity_pattern_base.h.

◆ counter

std::atomic<unsigned int> Subscriptor::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 218 of file subscriptor.h.

◆ counter_map

std::map<std::string, unsigned int> Subscriptor::counter_map
mutableprivateinherited

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

Definition at line 224 of file subscriptor.h.

◆ validity_pointers

std::vector<std::atomic<bool> *> Subscriptor::validity_pointers
mutableprivateinherited

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

Definition at line 240 of file subscriptor.h.

◆ object_info

const std::type_info* Subscriptor::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 248 of file subscriptor.h.

◆ mutex

std::mutex Subscriptor::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 271 of file subscriptor.h.


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