#include <deal.II/base/quadrature_point_data.h>

Inheritance diagram for CellDataStorage< CellIteratorType, DataType >:

Public Member Functions
	CellDataStorage ()=default

	~CellDataStorage () override=default

template<typename T = DataType>
void	initialize (const CellIteratorType &cell, const unsigned int number_of_data_points_per_cell)

template<typename T = DataType>
void	initialize (const CellIteratorType &cell_start, const typename std_cxx20::type_identity< CellIteratorType >::type &cell_end, const unsigned int number_of_data_points_per_cell)

bool	erase (const CellIteratorType &cell)

void	clear ()

template<typename T = DataType>
std::vector< std::shared_ptr< T > >	get_data (const CellIteratorType &cell)

template<typename T = DataType>
std::vector< std::shared_ptr< const T > >	get_data (const CellIteratorType &cell) const

template<typename T = DataType>
std::optional< std::vector< std::shared_ptr< T > > >	try_get_data (const CellIteratorType &cell)

template<typename T = DataType>
std::optional< std::vector< std::shared_ptr< const T > > >	try_get_data (const CellIteratorType &cell) const

template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

EnableObserverPointer functionality
Classes derived from EnableObserverPointer provide a facility to subscribe to this object. This is mostly used by the ObserverPointer 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 ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (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

Static Private Member Functions
static ::ExceptionBase &	ExcCellDataTypeMismatch ()

static ::ExceptionBase &	ExcTriangulationMismatch ()

Private Attributes
ObserverPointer< const Triangulation< dimension, space_dimension >, CellDataStorage< CellIteratorType, DataType > >	tria

std::map< CellId, std::vector< std::shared_ptr< DataType > > >	map

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

Static Private Attributes
static constexpr unsigned int	dimension

static constexpr unsigned int	space_dimension

static std::mutex	mutex

Detailed Description

template<typename CellIteratorType, typename DataType>
class CellDataStorage< CellIteratorType, DataType >

A class for storing at each cell represented by iterators of type CellIteratorType a vector of data DataType . The underlying structure and the initialize() method of this class are designed in such a way that one could use different child classes derived from the base DataType class to store data on a given cell. This implies the usage of pointers, in our case – std::shared_ptr.

The type DataType is arbitrary, but when using a class derived from TransferableQuadraturePointData one can use the facilities of parallel::distributed::ContinuousQuadratureDataTransfer.

Note: The data type stored on each cell can be different. However, within the cell this class stores a vector of objects of a single data type. For this reason, this class may not be sufficiently flexible when, for example, adopting a level-set approach to describe material behavior.

Definition at line 63 of file quadrature_point_data.h.

Member Typedef Documentation

◆ map_value_type

using EnableObserverPointer::map_value_type = decltype(counter_map)::value_type

privateinherited

The data type used in counter_map.

Definition at line 238 of file enable_observer_pointer.h.

◆ map_iterator

using EnableObserverPointer::map_iterator = decltype(counter_map)::iterator

privateinherited

The iterator type used in counter_map.

Definition at line 243 of file enable_observer_pointer.h.

Constructor & Destructor Documentation

◆ CellDataStorage()

template<typename CellIteratorType , typename DataType >

CellDataStorage< CellIteratorType, DataType >::CellDataStorage ( )

default

Default constructor.

◆ ~CellDataStorage()

template<typename CellIteratorType , typename DataType >

CellDataStorage< CellIteratorType, DataType >::~CellDataStorage ( )

overridedefault

Default destructor.

Member Function Documentation

◆ initialize() [1/2]

template<typename CellIteratorType , typename DataType >

template<typename T = DataType>

void CellDataStorage< CellIteratorType, DataType >::initialize	(	const CellIteratorType &	cell,
		const unsigned int	number_of_data_points_per_cell
	)

Initialize data on the cell to store number_of_data_points_per_cell of objects of type T . The typename T is possibly another class which is derived from the base DataType class. In order to initialize the vector of objects we have to assume that the class T has a default constructor. This function has to be called on every cell where data is to be stored.

After the data is initialized, it can be modified using the get_data() function.

Note: Subsequent calls of this function with the same cell will not alter the objects associated with it. In order to remove the stored data, use the erase() function.; It is possible to use different types T for different cells which may reflect, for example, different constitutive models of continuum mechanics in different parts of the domain.; The first time this method is called, it stores a ObserverPointer to the Triangulation object that owns the cell. The future invocations of this method expects the cell to be from the same stored triangulation.

Precondition: The type T needs to either equal DataType, or be a class derived from DataType. T needs to be default constructible.

◆ initialize() [2/2]

template<typename CellIteratorType , typename DataType >

template<typename T = DataType>

void CellDataStorage< CellIteratorType, DataType >::initialize	(	const CellIteratorType &	cell_start,
		const typename std_cxx20::type_identity< CellIteratorType >::type &	cell_end,
		const unsigned int	number_of_data_points_per_cell
	)

Same as above but for a range of iterators starting at cell_start until, but not including, cell_end for all locally owned cells, i.e. for which cell->is_locally_owned()==true .

◆ erase()

template<typename CellIteratorType , typename DataType >

bool CellDataStorage< CellIteratorType, DataType >::erase ( const CellIteratorType & cell )

Removes data stored at the cell. Returns true if the data was removed. If no data is attached to the cell, this function will not do anything and returns false.

Note: This function will also check that there are no outstanding references to the data stored on this cell. That is to say, that the only references to the stored data are that made by this class.

◆ clear()

template<typename CellIteratorType , typename DataType >

void CellDataStorage< CellIteratorType, DataType >::clear ( )

Clear all the data stored in this object.

◆ get_data() [1/2]

template<typename CellIteratorType , typename DataType >

template<typename T = DataType>

std::vector< std::shared_ptr< T > > CellDataStorage< CellIteratorType, DataType >::get_data ( const CellIteratorType & cell )

Get a vector of the data located at cell . A possible additional typename T is the class to which the base class DataType could be cast. Since DataType is stored as shared pointers, there is minimal overhead in returning a vector by value instead of by reference. This allows flexibility if class T is not the same as DataType on a cell-by-cell basis.

Precondition: The type T needs to match the class provided to initialize() .; cell must be from the same Triangulation that is used to initialize() the cell data.

◆ get_data() [2/2]

template<typename CellIteratorType , typename DataType >

template<typename T = DataType>

std::vector< std::shared_ptr< const T > > CellDataStorage< CellIteratorType, DataType >::get_data ( const CellIteratorType & cell ) const

Get a vector of constant pointers to data located at cell . A possible additional typename T is the class to which the base class DataType could be cast. Since DataType is stored as shared pointers, there is minimal overhead in returning a vector by value instead of by reference. This allows flexibility if class T is not the same as DataType on a cell-by-cell basis.

Precondition: The type T needs to match the class provided to initialize() .; cell must be from the same Triangulation that is used to initialize() the cell data.

◆ try_get_data() [1/2]

template<typename CellIteratorType , typename DataType >

template<typename T = DataType>

std::optional< std::vector< std::shared_ptr< T > > > CellDataStorage< CellIteratorType, DataType >::try_get_data ( const CellIteratorType & cell )

Returns a std::optional indicating whether cell contains an associated data or not. If data is available, dereferencing the std::optional reveals a vector of pointers to the underlying data at the quadrature points. A possible additional typename T is the class to which the base class DataType could be cast. Since DataType is stored as shared pointers, there is minimal overhead in returning a vector by value instead of by reference. This allows flexibility if class T is not the same as DataType on a cell-by-cell basis.

Precondition: The type T needs to match the class provided to initialize().; cell must be from the same Triangulation that is used to initialize() the cell data.

◆ try_get_data() [2/2]

template<typename CellIteratorType , typename DataType >

template<typename T = DataType>

std::optional< std::vector< std::shared_ptr< const T > > > CellDataStorage< CellIteratorType, DataType >::try_get_data ( const CellIteratorType & cell ) const

Returns a std::optional indicating whether cell contains an associated data or not. If data is available, dereferencing the std::optional reveals a vector of constant pointers to the underlying data at the quadrature points. A possible additional typename T is the class to which the base class DataType could be cast. Since DataType is stored as shared pointers, there is minimal overhead in returning a vector by value instead of by reference. This allows flexibility if class T is not the same as DataType on a cell-by-cell basis.

Precondition: The type T needs to match the class provided to initialize().; cell must be from the same Triangulation that is used to initialize() the cell data.

◆ subscribe()

void EnableObserverPointer::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 131 of file enable_observer_pointer.cc.

◆ unsubscribe()

void EnableObserverPointer::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 151 of file enable_observer_pointer.cc.

◆ n_subscriptions()

unsigned int EnableObserverPointer::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 322 of file enable_observer_pointer.h.

◆ list_subscribers() [1/2]

template<typename StreamType >

void EnableObserverPointer::list_subscribers ( StreamType & stream ) const

inlineinherited

List the subscribers to the input stream.

Definition at line 339 of file enable_observer_pointer.h.

◆ list_subscribers() [2/2]

void EnableObserverPointer::list_subscribers ( ) const

inherited

List the subscribers to deallog.

Definition at line 199 of file enable_observer_pointer.cc.

◆ serialize()

template<class Archive >

void EnableObserverPointer::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 331 of file enable_observer_pointer.h.

◆ check_no_subscribers()

void EnableObserverPointer::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 53 of file enable_observer_pointer.cc.

Member Data Documentation

◆ dimension

template<typename CellIteratorType , typename DataType >

constexpr unsigned int CellDataStorage< CellIteratorType, DataType >::dimension

staticconstexprprivate

Initial value:

=

CellIteratorType::AccessorType::dimension

Number of dimensions

Definition at line 216 of file quadrature_point_data.h.

◆ space_dimension

template<typename CellIteratorType , typename DataType >

constexpr unsigned int CellDataStorage< CellIteratorType, DataType >::space_dimension

staticconstexprprivate

Initial value:

=

CellIteratorType::AccessorType::space_dimension

Number of space dimensions

Definition at line 222 of file quadrature_point_data.h.

◆ tria

template<typename CellIteratorType , typename DataType >

ObserverPointer<const Triangulation<dimension, space_dimension>, CellDataStorage<CellIteratorType, DataType> > CellDataStorage< CellIteratorType, DataType >::tria

private

To ensure that all the cells in the CellDataStorage come from the same Triangulation, we need to store a reference to that Triangulation within the class.

Definition at line 232 of file quadrature_point_data.h.

◆ map

template<typename CellIteratorType , typename DataType >

std::map<CellId, std::vector<std::shared_ptr<DataType> > > CellDataStorage< CellIteratorType, DataType >::map

private

A map to store a vector of data on each cell. We need to use CellId as the key because it remains unique during adaptive refinement.

Definition at line 239 of file quadrature_point_data.h.

◆ counter

std::atomic<unsigned int> EnableObserverPointer::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 227 of file enable_observer_pointer.h.

◆ counter_map

std::map<std::string, unsigned int> EnableObserverPointer::counter_map

mutableprivateinherited

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

Definition at line 233 of file enable_observer_pointer.h.

◆ validity_pointers

std::vector<std::atomic<bool> *> EnableObserverPointer::validity_pointers

mutableprivateinherited

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

Definition at line 249 of file enable_observer_pointer.h.

◆ object_info

const std::type_info* EnableObserverPointer::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 257 of file enable_observer_pointer.h.

◆ mutex

std::mutex EnableObserverPointer::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 280 of file enable_observer_pointer.h.

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

include/deal.II/base/quadrature_point_data.h

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ map_value_type

◆ map_iterator

Constructor & Destructor Documentation

◆ CellDataStorage()

◆ ~CellDataStorage()

Member Function Documentation

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ erase()

◆ clear()

◆ get_data() [1/2]

◆ get_data() [2/2]

◆ try_get_data() [1/2]

◆ try_get_data() [2/2]

◆ subscribe()

◆ unsubscribe()

◆ n_subscriptions()

◆ list_subscribers() [1/2]

◆ list_subscribers() [2/2]

◆ serialize()

◆ check_no_subscribers()

Member Data Documentation

◆ dimension

◆ space_dimension

◆ tria

◆ map

◆ counter

◆ counter_map

◆ validity_pointers

◆ object_info

◆ mutex