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

Inheritance diagram for MeshWorker::VectorData< VectorType, dim, spacedim >:

Public Member Functions
	VectorData ()=default

	VectorData (const VectorSelector &)

void	initialize (const AnyData &)

void	initialize (const VectorType *, const std::string &name)

virtual void	fill (std::vector< std::vector< std::vector< typename VectorType::value_type >>> &values, std::vector< std::vector< std::vector< Tensor< 1, spacedim, typename VectorType::value_type >>>> &gradients, std::vector< std::vector< std::vector< Tensor< 2, spacedim, typename VectorType::value_type >>>> &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 override

virtual void	mg_fill (std::vector< std::vector< std::vector< typename VectorType::value_type >>> &values, std::vector< std::vector< std::vector< Tensor< 1, spacedim, typename VectorType::value_type >>>> &gradients, std::vector< std::vector< std::vector< Tensor< 2, spacedim, typename VectorType::value_type >>>> &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 override

std::size_t	memory_consumption () 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<class StreamType , typename DATA >
void	print (StreamType &s, const AnyData &v) const

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

Protected Attributes
AnyData	data

NamedSelection	value_selection

NamedSelection	gradient_selection

NamedSelection	hessian_selection

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

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

using	map_value_type = decltype(counter_map)::value_type

using	map_iterator = decltype(counter_map)::iterator

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

static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

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

void	check_no_subscribers () const noexcept

Detailed Description

template<typename VectorType, int dim, int spacedim = dim>
class MeshWorker::VectorData< VectorType, dim, spacedim >

Based on VectorSelector, this is the class that implements the function VectorDataBase::fill() for a certain type of vector, using AnyData to identify vectors by name.

Definition at line 306 of file vector_selector.h.

Constructor & Destructor Documentation

◆ VectorData() [1/2]

template<typename VectorType , int dim, int spacedim = dim>

MeshWorker::VectorData< VectorType, dim, spacedim >::VectorData ( )

default

Constructor.

◆ VectorData() [2/2]

template<typename VectorType , int dim, int spacedim = dim>

MeshWorker::VectorData< VectorType, dim, spacedim >::VectorData ( const VectorSelector & )

Constructor using a prefilled VectorSelector

Member Function Documentation

◆ initialize() [1/2]

template<typename VectorType , int dim, int spacedim = dim>

void MeshWorker::VectorData< VectorType, dim, spacedim >::initialize ( const AnyData & )

Initialize with an object of named vectors.

◆ initialize() [2/2]

template<typename VectorType , int dim, int spacedim = dim>

void MeshWorker::VectorData< VectorType, dim, spacedim >::initialize	(	const VectorType *	,
		const std::string &	name
	)

Initialize with a single vector 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<typename VectorType , int dim, int spacedim = dim>

virtual void MeshWorker::VectorData< VectorType, dim, spacedim >::fill	(	std::vector< std::vector< std::vector< typename VectorType::value_type >>> &	values,
		std::vector< std::vector< std::vector< Tensor< 1, spacedim, typename VectorType::value_type >>>> &	gradients,
		std::vector< std::vector< std::vector< Tensor< 2, spacedim, typename VectorType::value_type >>>> &	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

overridevirtual

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 from MeshWorker::VectorDataBase< dim, dim, VectorType::value_type >.

◆ mg_fill()

template<typename VectorType , int dim, int spacedim = dim>

virtual void MeshWorker::VectorData< VectorType, dim, spacedim >::mg_fill	(	std::vector< std::vector< std::vector< typename VectorType::value_type >>> &	values,
		std::vector< std::vector< std::vector< Tensor< 1, spacedim, typename VectorType::value_type >>>> &	gradients,
		std::vector< std::vector< std::vector< Tensor< 2, spacedim, typename VectorType::value_type >>>> &	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

overridevirtual

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 from MeshWorker::VectorDataBase< dim, dim, VectorType::value_type >.

◆ memory_consumption()

template<typename VectorType , int dim, int spacedim = dim>

std::size_t MeshWorker::VectorData< VectorType, dim, spacedim >::memory_consumption ( ) const

The memory used by this object.

◆ 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 420 of file vector_selector.h.

◆ empty()

bool MeshWorker::VectorSelector::empty ( ) const

inlineinherited

Check whether any vector is selected.

Definition at line 454 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 462 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 469 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 476 of file vector_selector.h.

◆ n_values()

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

inlineinherited

Number of vectors for values

Definition at line 483 of file vector_selector.h.

◆ n_gradients()

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

inlineinherited

Number of vectors for gradients

Definition at line 490 of file vector_selector.h.

◆ n_hessians()

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

inlineinherited

Number of vectors for Hessians

Definition at line 497 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 504 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 511 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 518 of file vector_selector.h.

◆ print() [1/2]

template<class 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 535 of file vector_selector.h.

◆ print() [2/2]

template<class StreamType >

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

inlineinherited

Print the number of selections to the stream.

Definition at line 526 of file vector_selector.h.

Member Data Documentation

◆ data

AnyData MeshWorker::VectorDataBase< dim, spacedim, VectorType::value_type >::data

protectedinherited

Definition at line 294 of file vector_selector.h.

◆ value_selection

NamedSelection MeshWorker::VectorSelector::value_selection

protectedinherited

Selection of the vectors used to compute values.

Definition at line 174 of file vector_selector.h.

◆ gradient_selection

NamedSelection MeshWorker::VectorSelector::gradient_selection

protectedinherited

Selection of the vectors used to compute gradients.

Definition at line 179 of file vector_selector.h.

◆ hessian_selection

NamedSelection MeshWorker::VectorSelector::hessian_selection

protectedinherited

Selection of the vectors used to compute hessians.

Definition at line 184 of file vector_selector.h.

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

include/deal.II/meshworker/vector_selector.h

Public Member Functions

Protected Attributes

Subscriptor functionality

Detailed Description

template<typename VectorType, int dim, int spacedim = dim> class MeshWorker::VectorData< VectorType, dim, spacedim >

Constructor & Destructor Documentation

◆ VectorData() [1/2]

◆ VectorData() [2/2]

Member Function Documentation

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ fill()

◆ mg_fill()

◆ memory_consumption()

◆ 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]

Member Data Documentation

◆ data

◆ value_selection

◆ gradient_selection

◆ hessian_selection

template<typename VectorType, int dim, int spacedim = dim>
class MeshWorker::VectorData< VectorType, dim, spacedim >