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

Inheritance diagram for MeshWorker::VectorDataBase< dim, spacedim, Number >:

[legend]

Public Member Functions
	VectorDataBase ()=default

	VectorDataBase (const VectorSelector &)

void	initialize (const AnyData &)

virtual	~VectorDataBase () override=default

virtual void	fill (std::vector< std::vector< std::vector< Number > > > &values, std::vector< std::vector< std::vector< Tensor< 1, spacedim, Number > > > > &gradients, std::vector< std::vector< std::vector< Tensor< 2, spacedim, Number > > > > &hessians, const FEValuesBase< dim, spacedim > &fe, const std::vector< types::global_dof_index > &index, const unsigned int component, const unsigned int n_comp, const unsigned int start, const unsigned int size) const

virtual void	mg_fill (std::vector< std::vector< std::vector< Number > > > &values, std::vector< std::vector< std::vector< Tensor< 1, spacedim, Number > > > > &gradients, std::vector< std::vector< std::vector< Tensor< 2, spacedim, Number > > > > &hessians, const FEValuesBase< dim, spacedim > &fe, const unsigned int level, const std::vector< types::global_dof_index > &index, const unsigned int component, const unsigned int n_comp, const unsigned int start, const unsigned int size) const

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

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)

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 ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Protected Attributes
AnyData	data

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

template<int dim, int spacedim = dim, typename Number = double>
class MeshWorker::VectorDataBase< dim, spacedim, Number >

Based on VectorSelector, this is the class used by IntegrationInfo to compute values of source vectors in quadrature points.

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

◆ VectorDataBase() [1/2]

template<int dim, int spacedim = dim, typename Number = double>

MeshWorker::VectorDataBase< dim, spacedim, Number >::VectorDataBase ( )

default

Constructor

◆ VectorDataBase() [2/2]

template<int dim, int spacedim = dim, typename Number = double>

MeshWorker::VectorDataBase< dim, spacedim, Number >::VectorDataBase ( const VectorSelector & )

Constructor from a base class object

◆ ~VectorDataBase()

template<int dim, int spacedim = dim, typename Number = double>

virtual MeshWorker::VectorDataBase< dim, spacedim, Number >::~VectorDataBase ( )

overridevirtualdefault

Virtual, but empty destructor.

Member Function Documentation

◆ initialize()

template<int dim, int spacedim = dim, typename Number = double>

void MeshWorker::VectorDataBase< dim, spacedim, Number >::initialize ( const AnyData & )

Initialize with a AnyData object and cache the indices in the VectorSelector base class.

Note: Make sure the VectorSelector base class was filled with reasonable data before calling this function.

◆ fill()

template<int dim, int spacedim = dim, typename Number = double>

virtual void MeshWorker::VectorDataBase< dim, spacedim, Number >::fill	(	std::vector< std::vector< std::vector< Number > > > &	values,
		std::vector< std::vector< std::vector< Tensor< 1, spacedim, Number > > > > &	gradients,
		std::vector< std::vector< std::vector< Tensor< 2, spacedim, Number > > > > &	hessians,
		const FEValuesBase< dim, spacedim > &	fe,
		const std::vector< types::global_dof_index > &	index,
		const unsigned int	component,
		const unsigned int	n_comp,
		const unsigned int	start,
		const unsigned int	size ) const

virtual

The only function added to VectorSelector is an abstract virtual function implemented in the derived class template and called by IntegrationInfo.

Depending on the selections made in our base class, this fills the first three arguments with the local data of the finite element functions. It is usually called either for the whole FESystem, or for each base element separately.

Parameters

values	is the vector filled with the values of the finite element function in the quadrature points.
gradients	is the vector filled with the derivatives of the finite element function in the quadrature points.
hessians	is the vector filled with the second derivatives of the finite element function in the quadrature points.
fe	is the FEValuesBase object which is used to compute the function values. Its UpdateFlags must have been set appropriately.
index	is the local index vector. If `fe` refers to base elements of the system, this vector should be sorted by block and the arguments `start` and `size` below specify the subset of `indices` used.
component	is the first index in `values`, `gradients` and `hessians` entered in this function.
n_comp	is the number of components to be filled.
start	is the first index of this block in `indices`, or zero if no base elements are used.
size	is the number of dofs per cell of the current element or base element.

Reimplemented in MeshWorker::VectorData< VectorType, dim, spacedim >, and MeshWorker::VectorData< VectorType, dim, dim >.

◆ mg_fill()

template<int dim, int spacedim = dim, typename Number = double>

virtual void MeshWorker::VectorDataBase< dim, spacedim, Number >::mg_fill	(	std::vector< std::vector< std::vector< Number > > > &	values,
		std::vector< std::vector< std::vector< Tensor< 1, spacedim, Number > > > > &	gradients,
		std::vector< std::vector< std::vector< Tensor< 2, spacedim, Number > > > > &	hessians,
		const FEValuesBase< dim, spacedim > &	fe,
		const unsigned int	level,
		const std::vector< types::global_dof_index > &	index,
		const unsigned int	component,
		const unsigned int	n_comp,
		const unsigned int	start,
		const unsigned int	size ) const

virtual

Fill the local data vector from level vectors. Performs exactly what the other fill() does, but uses the cell level to access a single level out of a hierarchy of level vectors, instead of a global data vector on the active cells.

Reimplemented in MeshWorker::VectorData< VectorType, dim, spacedim >, and MeshWorker::VectorData< VectorType, dim, dim >.

◆ add()

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

inlineinherited

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.

◆ empty()

bool MeshWorker::VectorSelector::empty ( ) const

inlineinherited

Check whether any vector is selected.

Definition at line 450 of file vector_selector.h.

◆ has_values()

bool MeshWorker::VectorSelector::has_values ( ) const

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

Number of vectors for values

Definition at line 479 of file vector_selector.h.

◆ n_gradients()

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

inlineinherited

Number of vectors for gradients

Definition at line 486 of file vector_selector.h.

◆ n_hessians()

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

The memory used by this object.

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

template<int dim, int spacedim = dim, typename Number = double>

AnyData MeshWorker::VectorDataBase< dim, spacedim, Number >::data

protected

Definition at line 290 of file vector_selector.h.

◆ value_selection

NamedSelection MeshWorker::VectorSelector::value_selection

protectedinherited

Selection of the vectors used to compute values.

Definition at line 170 of file vector_selector.h.

◆ gradient_selection

NamedSelection MeshWorker::VectorSelector::gradient_selection

protectedinherited

Selection of the vectors used to compute gradients.

Definition at line 175 of file vector_selector.h.

◆ hessian_selection

NamedSelection MeshWorker::VectorSelector::hessian_selection

protectedinherited

Selection of the vectors used to compute hessians.

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

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

Constructor & Destructor Documentation

◆ VectorDataBase() [1/2]

◆ VectorDataBase() [2/2]

◆ ~VectorDataBase()

Member Function Documentation

◆ initialize()

◆ fill()

◆ mg_fill()

◆ add()

◆ 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

◆ data

◆ value_selection

◆ gradient_selection

◆ hessian_selection

◆ counter

◆ counter_map

◆ validity_pointers

◆ object_info

◆ mutex