Reference documentation for deal.II version GIT 969cfe8cd8 2022-06-28 20:20:01+00:00
\(\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 | 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
 
CollectionIterator< T > begin () const
 
CollectionIterator< T > end () const
 

Private Attributes

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

Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

std::atomic< unsigned int > counter
 
std::map< std::string, unsigned int > counter_map
 
std::vector< std::atomic< bool > * > validity_pointers
 
const std::type_info * object_info
 
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)
 
using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 
static std::mutex mutex
 
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
void check_no_subscribers () const noexcept
 

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 180 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 255 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 273 of file collection.h.

◆ size()

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

Return the number of objects stored in this container.

Definition at line 264 of file collection.h.

◆ memory_consumption()

template<typename T >
std::size_t hp::Collection< T >::memory_consumption

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

Definition at line 246 of file collection.h.

◆ begin()

template<typename T >
CollectionIterator< T > hp::Collection< T >::begin
Returns
An iterator pointing to the beginning of the underlying data (const version).

Definition at line 283 of file collection.h.

◆ end()

template<typename T >
CollectionIterator< T > hp::Collection< T >::end
Returns
An iterator pointing to the end of the underlying data (const version).

Definition at line 292 of file collection.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 236 of file collection.h.


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