#include <deal.II/meshworker/vector_selector.h>

Inheritance diagram for MeshWorker::VectorSelector:

[legend]

Public Member Functions
void	add (const std::string &name, const bool values=true, const bool gradients=false, const bool hessians=false)

void	initialize (const AnyData &)

bool	empty () const

bool	has_values () const

bool	has_gradients () const

bool	has_hessians () const

unsigned int	n_values () const

unsigned int	n_gradients () const

unsigned int	n_hessians () const

unsigned int	value_index (const unsigned int i) const

unsigned int	gradient_index (const unsigned int i) const

unsigned int	hessian_index (const unsigned int i) const

template<typename StreamType , typename DATA >
void	print (StreamType &s, const AnyData &v) const

template<typename StreamType >
void	print (StreamType &s) const

std::size_t	memory_consumption () 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)

Protected Attributes
NamedSelection	value_selection

NamedSelection	gradient_selection

NamedSelection	hessian_selection

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

A class that selects vectors from a list of named vectors.

Since the number of vectors in an AnyData object may grow with every nesting of applications or loops, it is important to be able to select those, which are actually used in computing residuals etc. This class organizes the selection.

Definition at line 47 of file vector_selector.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.

Member Function Documentation

◆ add()

void MeshWorker::VectorSelector::add	(	const std::string &	name,
		const bool	values = `true`,
		const bool	gradients = `false`,
		const bool	hessians = `false`
	)

inline

Add a vector to the selection of finite element functions. The arguments are the name of the vector and indicators, which information is to be extracted from the vector. The name refers to an entry in a AnyData object, which will be identified by initialize(). The three bool parameters indicate, whether values, gradients and Hessians of the finite element function are to be computed on each cell or face.

Definition at line 416 of file vector_selector.h.

◆ initialize()

void MeshWorker::VectorSelector::initialize ( const AnyData & src )

inline

Does the same as the function above but it is possible to select a block of the global vector. Initialize the selection field with a data vector. While add() only enters the names of vectors, which will be used in the integration loop over cells and faces, this function links the names to actual vectos in a AnyData object.

Note: This function caches the index associated with a name. Therefore, it must be called every time after the AnyData object has changed.

Definition at line 442 of file vector_selector.h.

◆ empty()

bool MeshWorker::VectorSelector::empty ( ) const

inline

Check whether any vector is selected.

Definition at line 450 of file vector_selector.h.

◆ has_values()

bool MeshWorker::VectorSelector::has_values ( ) const

inline

Return true if values are selected for any vector.

Definition at line 458 of file vector_selector.h.

◆ has_gradients()

bool MeshWorker::VectorSelector::has_gradients ( ) const

inline

Return true if gradients are selected for any vector.

Definition at line 465 of file vector_selector.h.

◆ has_hessians()

bool MeshWorker::VectorSelector::has_hessians ( ) const

inline

Return true if hessians are selected for any vector.

Definition at line 472 of file vector_selector.h.

◆ n_values()

unsigned int MeshWorker::VectorSelector::n_values ( ) const

inline

Number of vectors for values

Definition at line 479 of file vector_selector.h.

◆ n_gradients()

unsigned int MeshWorker::VectorSelector::n_gradients ( ) const

inline

Number of vectors for gradients

Definition at line 486 of file vector_selector.h.

◆ n_hessians()

unsigned int MeshWorker::VectorSelector::n_hessians ( ) const

inline

Number of vectors for Hessians

Definition at line 493 of file vector_selector.h.

◆ value_index()

unsigned int MeshWorker::VectorSelector::value_index ( const unsigned int i ) const

inline

The vector index for the ith value

Definition at line 500 of file vector_selector.h.

◆ gradient_index()

unsigned int MeshWorker::VectorSelector::gradient_index ( const unsigned int i ) const

inline

The vector index for the ith gradient

Definition at line 507 of file vector_selector.h.

◆ hessian_index()

unsigned int MeshWorker::VectorSelector::hessian_index ( const unsigned int i ) const

inline

The vector index for the ith Hessian

Definition at line 514 of file vector_selector.h.

◆ print() [1/2]

template<typename StreamType , typename DATA >

void MeshWorker::VectorSelector::print	(	StreamType &	s,
		const AnyData &	v
	)		const

inline

Print the contents of the selection to the stream.

Definition at line 531 of file vector_selector.h.

◆ print() [2/2]

template<typename StreamType >

void MeshWorker::VectorSelector::print ( StreamType & s ) const

inline

Print the number of selections to the stream.

Definition at line 522 of file vector_selector.h.

◆ memory_consumption()

std::size_t MeshWorker::VectorSelector::memory_consumption ( ) const

inline

The memory used by this object.

Definition at line 547 of file vector_selector.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

◆ value_selection

NamedSelection MeshWorker::VectorSelector::value_selection

protected

Selection of the vectors used to compute values.

Definition at line 170 of file vector_selector.h.

◆ gradient_selection

NamedSelection MeshWorker::VectorSelector::gradient_selection

protected

Selection of the vectors used to compute gradients.

Definition at line 175 of file vector_selector.h.

◆ hessian_selection

NamedSelection MeshWorker::VectorSelector::hessian_selection

protected

Selection of the vectors used to compute hessians.

Definition at line 180 of file vector_selector.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/meshworker/vector_selector.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ map_value_type

◆ map_iterator

Member Function Documentation

◆ add()

◆ initialize()

◆ empty()

◆ has_values()

◆ has_gradients()

◆ has_hessians()

◆ n_values()

◆ n_gradients()

◆ n_hessians()

◆ value_index()

◆ gradient_index()

◆ hessian_index()

◆ print() [1/2]

◆ print() [2/2]

◆ memory_consumption()

◆ subscribe()

◆ unsubscribe()

◆ n_subscriptions()

◆ list_subscribers() [1/2]

◆ list_subscribers() [2/2]

◆ serialize()

◆ check_no_subscribers()

Member Data Documentation

◆ value_selection

◆ gradient_selection

◆ hessian_selection

◆ counter

◆ counter_map

◆ validity_pointers

◆ object_info

◆ mutex