Reference documentation for deal.II version 9.3.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 | Static Public Member Functions | Private Attributes | List of all members
hp::Collection< T > Class Template Reference

#include <deal.II/hp/collection.h>

Inheritance diagram for hp::Collection< T >:
[legend]

Public Member Functions

 Collection ()=default
 
void push_back (const std::shared_ptr< const T > &new_entry)
 
const T & operator[] (const unsigned int index) const
 
unsigned int size () const
 
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

std::vector< std::shared_ptr< const T > > entries
 

Detailed Description

template<typename T>
class hp::Collection< T >

This class implements a collection of objects.

It implements the concepts stated in the hp-Collections module described in the doxygen documentation.

Definition at line 40 of file collection.h.

Constructor & Destructor Documentation

◆ Collection()

template<typename T>
hp::Collection< T >::Collection ( )
default

Default constructor. Leads to an empty collection that can later be filled using push_back().

Member Function Documentation

◆ push_back()

template<typename T>
void hp::Collection< T >::push_back ( const std::shared_ptr< const T > &  new_entry)

Add a new object.

Definition at line 100 of file collection.h.

◆ operator[]()

template<typename T >
const T & hp::Collection< T >::operator[] ( const unsigned int  index) const
inline

Return the object which was specified by the user for the active FE index which is provided as a parameter to this method.

Precondition
index must be between zero and the number of elements of the collection.

Definition at line 117 of file collection.h.

◆ size()

template<typename T >
unsigned int hp::Collection< T >::size ( ) const
inline

Return the number of objects stored in this container.

Definition at line 109 of file collection.h.

◆ memory_consumption()

template<typename T >
std::size_t hp::Collection< T >::memory_consumption ( ) const

Determine an estimate for the memory consumption (in bytes) of this object.

Definition at line 91 of file 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

◆ entries

template<typename T>
std::vector<std::shared_ptr<const T> > hp::Collection< T >::entries
private

The real container, which stores pointers to the different objects.

Definition at line 81 of file collection.h.


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