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

Inheritance diagram for hp::MappingCollection< dim, spacedim >:

[legend]

Public Member Functions
	MappingCollection ()=default

	MappingCollection (const Mapping< dim, spacedim > &mapping)

template<class... MappingTypes>
	MappingCollection (const MappingTypes &...mappings)

	MappingCollection (const MappingCollection< dim, spacedim > &mapping_collection)

	MappingCollection (MappingCollection< dim, spacedim > &&) noexcept(std::is_nothrow_move_constructible< std::vector< std::shared_ptr< const Mapping< dim, spacedim > > > >::value &&std::is_nothrow_move_constructible< std::function< unsigned int(const typename hp::MappingCollection< dim, spacedim > &, const unsigned int)> >::value)=default

MappingCollection< dim, spacedim > &	operator= (MappingCollection< dim, spacedim > &&)=default

void	push_back (const Mapping< dim, spacedim > &new_mapping)

void	push_back (const std::shared_ptr< const T > &new_entry)

const T &	operator[] (const unsigned int index) const

unsigned int	size () const

bool	empty () const

std::size_t	memory_consumption () const

CollectionIterator< T >	begin () const

CollectionIterator< T >	end () 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

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

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 std::mutex	mutex

Detailed Description

template<int dim, int spacedim = dim>
class hp::MappingCollection< dim, spacedim >

This class implements a collection of mapping objects in the same way as the hp::FECollection implements a collection of finite element classes.

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

Although it is recommended to supply an appropriate mapping for each finite element kind used in a hp-computation, the MappingCollection class implements a conversion constructor from a single mapping. Therefore it is possible to offer only a single mapping to the hp::FEValues class instead of a hp::MappingCollection. This is for the convenience of the user, as many simple geometries do not require different mappings along the boundary to achieve optimal convergence rates. Hence providing a single mapping object will usually suffice. See the hp::FEValues class for the rules which mapping will be selected for a given cell.

Definition at line 56 of file mapping_collection.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

◆ MappingCollection() [1/5]

template<int dim, int spacedim = dim>

hp::MappingCollection< dim, spacedim >::MappingCollection ( )

default

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

◆ MappingCollection() [2/5]

template<int dim, int spacedim>

hp::MappingCollection< dim, spacedim >::MappingCollection ( const Mapping< dim, spacedim > & mapping )

explicit

Conversion constructor. This constructor creates a MappingCollection from a single mapping. More mappings can be added with push_back(), if desired, though it would probably be clearer to add all mappings the same way.

Definition at line 28 of file mapping_collection.cc.

◆ MappingCollection() [3/5]

template<int dim, int spacedim>

template<class... MappingTypes>

hp::MappingCollection< dim, spacedim >::MappingCollection ( const MappingTypes &... mappings )

explicit

Constructor. This constructor creates a MappingCollection from one or more mapping objects passed to the constructor. For this call to be valid, all arguments need to be of types derived from class Mapping<dim,spacedim>.

Definition at line 159 of file mapping_collection.h.

◆ MappingCollection() [4/5]

template<int dim, int spacedim>

hp::MappingCollection< dim, spacedim >::MappingCollection ( const MappingCollection< dim, spacedim > & mapping_collection )

Copy constructor.

Definition at line 37 of file mapping_collection.cc.

◆ MappingCollection() [5/5]

template<int dim, int spacedim = dim>

hp::MappingCollection< dim, spacedim >::MappingCollection ( MappingCollection< dim, spacedim > && ) const &

defaultnoexcept

Move constructor.

Note: The implementation of standard datatypes may change with different libraries, so their move members may or may not be flagged non-throwing. We need to explicitly set the noexcept specifier according to its member variables to still get the performance benefits (and to satisfy clang-tidy).

Member Function Documentation

◆ operator=()

template<int dim, int spacedim = dim>

MappingCollection< dim, spacedim > & hp::MappingCollection< dim, spacedim >::operator= ( MappingCollection< dim, spacedim > && )

default

Move assignment operator.

◆ push_back() [1/2]

template<int dim, int spacedim>

void hp::MappingCollection< dim, spacedim >::push_back ( const Mapping< dim, spacedim > & new_mapping )

Add a new mapping to the MappingCollection. Generally, you will want to use the same order for mappings as for the elements of the hp::FECollection object you use. However, the same considerations as discussed with the hp::QCollection::push_back() function also apply in the current context.

This class creates a copy of the given mapping object, i.e., you can do things like push_back(MappingQ<dim>(3));. The internal copy is later destroyed by this object upon destruction of the entire collection.

Definition at line 48 of file mapping_collection.cc.

◆ push_back() [2/2]

template<typename T >

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

inherited

Add a new object.

Definition at line 306 of file collection.h.

◆ operator[]()

template<typename T >

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

inlineinherited

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 333 of file collection.h.

◆ size()

template<typename T >

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

inlineinherited

Return the number of objects stored in this container.

Definition at line 315 of file collection.h.

◆ empty()

template<typename T >

bool hp::Collection< T >::empty ( ) const

inlineinherited

The return value of this function is equivalent to size() == 0

Definition at line 324 of file collection.h.

◆ memory_consumption()

template<typename T >

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

inherited

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

Definition at line 297 of file collection.h.

◆ begin()

template<typename T >

CollectionIterator< T > hp::Collection< T >::begin ( ) const

inherited

Returns: An iterator pointing to the beginning of the underlying data (const version).

Definition at line 343 of file collection.h.

◆ end()

template<typename T >

CollectionIterator< T > hp::Collection< T >::end ( ) const

inherited

Returns: An iterator pointing to the end of the underlying data (const version).

Definition at line 352 of file collection.h.

◆ 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

◆ entries

template<typename T >

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

privateinherited

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

Definition at line 287 of file collection.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 files:

include/deal.II/hp/fe_collection.h
include/deal.II/hp/mapping_collection.h
source/hp/mapping_collection.cc

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ map_value_type

◆ map_iterator

Constructor & Destructor Documentation

◆ MappingCollection() [1/5]

◆ MappingCollection() [2/5]

◆ MappingCollection() [3/5]

◆ MappingCollection() [4/5]

◆ MappingCollection() [5/5]

Member Function Documentation

◆ operator=()

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ operator[]()

◆ size()

◆ empty()

◆ memory_consumption()

◆ begin()

◆ end()

◆ subscribe()

◆ unsubscribe()

◆ n_subscriptions()

◆ list_subscribers() [1/2]

◆ list_subscribers() [2/2]

◆ serialize()

◆ check_no_subscribers()

Member Data Documentation

◆ entries

◆ counter

◆ counter_map

◆ validity_pointers

◆ object_info

◆ mutex