Reference documentation for deal.II version GIT relicensing-233-g802318d791 2024-03-28 20:20:02+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\}}\)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
AnyData Class Reference

#include <deal.II/algorithms/any_data.h>

Inheritance diagram for AnyData:
Inheritance graph
[legend]

Public Member Functions

 AnyData ()=default
 Default constructor for empty object.
 
unsigned int size () const
 Number of stored data objects.
 
template<typename type >
void add (type entry, const std::string &name)
 Add a new data object.
 
void merge (const AnyData &other)
 Merge the data of another AnyData to the end of this object.
 
template<typename type >
type entry (const std::string &name)
 Access to stored data object by name.
 
template<typename type >
type entry (const std::string &name) const
 Read-only access to stored data object by name.
 
template<typename type >
type read (const std::string &name) const
 Dedicated read only access by name.
 
template<typename type >
const type * read_ptr (const std::string &name) const
 Dedicated read only access by name for pointer data.
 
template<typename type >
const type * try_read_ptr (const std::string &name) const
 
template<typename type >
const type * try_read (const std::string &name) const
 Dedicated read only access by name without exceptions.
 
template<typename type >
type entry (const unsigned int i)
 
template<typename type >
type entry (const unsigned int i) const
 Read-only access to stored data object by index.
 
template<typename type >
type read (const unsigned int i) const
 Dedicated read only access.
 
template<typename type >
const type * read_ptr (const unsigned int i) const
 Dedicated read only access to pointer object.
 
template<typename type >
const type * try_read_ptr (const unsigned int i) const
 Dedicated read only access to pointer object without exception.
 
template<typename type >
const type * try_read (const unsigned int i) const
 Dedicated read only access without exception.
 
const std::string & name (const unsigned int i) const
 Name of object at index.
 
unsigned int find (const std::string &name) const
 Find index of a named object.
 
unsigned int try_find (const std::string &name) const
 Try to find index of a named object.
 
template<typename type >
bool is_type (const unsigned int i) const
 Find out if object is of a certain type.
 
template<typename StreamType >
void list (StreamType &os) const
 List the contents to a stream.
 
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 ::ExceptionBaseExcNameNotFound (std::string arg1)
 An entry with this name does not exist in the AnyData object.
 
static ::ExceptionBaseExcTypeMismatch (std::string arg1, std::string arg2)
 The requested type and the stored type are different.
 
static ::ExceptionBaseExcNameMismatch (int arg1, std::string arg2)
 
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

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::vector< std::any > data
 The stored data.
 
std::vector< std::string > names
 The names of the stored data.
 
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

Store any amount of any type of data accessible by an identifier string.

Todo:
GK: Deprecate access to AnyData by index and change to a map.

Definition at line 35 of file any_data.h.

Member Typedef Documentation

◆ 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

◆ AnyData()

AnyData::AnyData ( )
default

Default constructor for empty object.

Member Function Documentation

◆ size()

unsigned int AnyData::size ( ) const
inline

Number of stored data objects.

Definition at line 221 of file any_data.h.

◆ add()

template<typename type >
void AnyData::add ( type  entry,
const std::string &  name 
)
inline

Add a new data object.

Definition at line 430 of file any_data.h.

◆ merge()

void AnyData::merge ( const AnyData other)
inline

Merge the data of another AnyData to the end of this object.

Definition at line 439 of file any_data.h.

◆ entry() [1/4]

template<typename type >
type AnyData::entry ( const std::string &  name)
inline

Access to stored data object by name.

Find the object with given name, try to convert it to type and return it. This function throws an exception if either the name does not exist or if the conversion fails. If such an exception is not desired, use try_read() instead.

Definition at line 349 of file any_data.h.

◆ entry() [2/4]

template<typename type >
type AnyData::entry ( const std::string &  name) const
inline

Read-only access to stored data object by name.

Find the object with given name, try to convert it to type and return it. This function throws an exception if either the name does not exist or if the conversion fails. If such an exception is not desired, use try_read() instead.

Definition at line 360 of file any_data.h.

◆ read() [1/2]

template<typename type >
type AnyData::read ( const std::string &  name) const
inline

Dedicated read only access by name.

For a constant object, this function equals entry(). For a non-const object, it forces read only access to the data. In particular, it throws an exception if the object is not found or cannot be converted to type. If such an exception is not desired, use try_read() instead.

Warning
Do not use this function for stored objects which are pointers. Use read_ptr() instead!

Definition at line 372 of file any_data.h.

◆ read_ptr() [1/2]

template<typename type >
const type * AnyData::read_ptr ( const std::string &  name) const
inline

Dedicated read only access by name for pointer data.

If the stored data object is a pointer to a constant object, the logic of access becomes fairly complicated. Namely, the standard read function may fail, depending on whether it was a const pointer or a regular pointer. This function fixes the logic and ascertains that the object does not become mutable by accident.

Definition at line 383 of file any_data.h.

◆ try_read_ptr() [1/2]

template<typename type >
const type * AnyData::try_read_ptr ( const std::string &  name) const
inline

Perform the same action as read_ptr(), but do not throw an exception if the pointer does not exist. Return a null pointer instead.

Definition at line 397 of file any_data.h.

◆ try_read() [1/2]

template<typename type >
const type * AnyData::try_read ( const std::string &  name) const
inline

Dedicated read only access by name without exceptions.

This function tries to find the name in the list and return a pointer to the associated object. If either the name is not found or the object cannot be converted to the return type, a null pointer is returned.

Definition at line 412 of file any_data.h.

◆ entry() [3/4]

template<typename type >
type AnyData::entry ( const unsigned int  i)
inline

Access to stored data object by index.

Definition at line 230 of file any_data.h.

◆ entry() [4/4]

template<typename type >
type AnyData::entry ( const unsigned int  i) const
inline

Read-only access to stored data object by index.

Definition at line 242 of file any_data.h.

◆ read() [2/2]

template<typename type >
type AnyData::read ( const unsigned int  i) const
inline

Dedicated read only access.

Definition at line 256 of file any_data.h.

◆ read_ptr() [2/2]

template<typename type >
const type * AnyData::read_ptr ( const unsigned int  i) const
inline

Dedicated read only access to pointer object.

Definition at line 270 of file any_data.h.

◆ try_read_ptr() [2/2]

template<typename type >
const type * AnyData::try_read_ptr ( const unsigned int  i) const
inline

Dedicated read only access to pointer object without exception.

Definition at line 284 of file any_data.h.

◆ try_read() [2/2]

template<typename type >
const type * AnyData::try_read ( const unsigned int  i) const
inline

Dedicated read only access without exception.

Definition at line 298 of file any_data.h.

◆ name()

const std::string & AnyData::name ( const unsigned int  i) const
inline

Name of object at index.

Definition at line 309 of file any_data.h.

◆ find()

unsigned int AnyData::find ( const std::string &  name) const
inline

Find index of a named object.

Try to find the object and return its index in the list. Throw an exception if the object has not been found.

Definition at line 330 of file any_data.h.

◆ try_find()

unsigned int AnyData::try_find ( const std::string &  name) const
inline

Try to find index of a named object.

Try to find the object and return its index in the list. returns numbers::invalid_unsigned_int if the name was not found.

Definition at line 317 of file any_data.h.

◆ is_type()

template<typename type >
bool AnyData::is_type ( const unsigned int  i) const
inline

Find out if object is of a certain type.

Definition at line 341 of file any_data.h.

◆ list()

template<typename StreamType >
void AnyData::list ( StreamType &  os) const
inline

List the contents to a stream.

Definition at line 451 of file any_data.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 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

◆ data

std::vector<std::any> AnyData::data
private

The stored data.

Definition at line 215 of file any_data.h.

◆ names

std::vector<std::string> AnyData::names
private

The names of the stored data.

Definition at line 217 of file any_data.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 file: