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

Inheritance diagram for MeshWorker::VectorSelector:

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

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

std::size_t	memory_consumption () const

Public Member Functions inherited from Subscriptor
	Subscriptor ()

	Subscriptor (const Subscriptor &)

	Subscriptor (Subscriptor &&) noexcept

virtual	~Subscriptor ()

Subscriptor &	operator= (const Subscriptor &)

Subscriptor &	operator= (Subscriptor &&) noexcept

void	subscribe (const char *identifier=nullptr) const

void	unsubscribe (const char *identifier=nullptr) const

unsigned int	n_subscriptions () const

void	list_subscribers () const

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

Protected Attributes
NamedSelection	value_selection

NamedSelection	gradient_selection

NamedSelection	hessian_selection

Additional Inherited Members
Static Public Member Functions inherited from Subscriptor
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

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

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.

It is used for instance in IntegrationWorker to determine which values, derivatives or second derivatives are actually computed.

Author: Guido Kanschat 2009

Definition at line 46 of file vector_selector.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 385 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 411 of file vector_selector.h.

◆ empty()

bool MeshWorker::VectorSelector::empty ( ) const

inline

Check whether any vector is selected.

Definition at line 419 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 428 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 435 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 442 of file vector_selector.h.

◆ n_values()

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

inline

Number of vectors for values

Definition at line 449 of file vector_selector.h.

◆ n_gradients()

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

inline

Number of vectors for gradients

Definition at line 456 of file vector_selector.h.

◆ n_hessians()

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

inline

Number of vectors for Hessians

Definition at line 463 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 470 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 477 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 484 of file vector_selector.h.

◆ print() [1/2]

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

◆ print() [2/2]

template<class StreamType >

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

inline

Print the number of selections to the stream.

Definition at line 492 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 520 of file vector_selector.h.

Member Data Documentation

◆ value_selection

NamedSelection MeshWorker::VectorSelector::value_selection

protected

Selection of the vectors used to compute values.

Definition at line 155 of file vector_selector.h.

◆ gradient_selection

NamedSelection MeshWorker::VectorSelector::gradient_selection

protected

Selection of the vectors used to compute gradients.

Definition at line 160 of file vector_selector.h.

◆ hessian_selection

NamedSelection MeshWorker::VectorSelector::hessian_selection

protected

Selection of the vectors used to compute hessians.

Definition at line 165 of file vector_selector.h.

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

deal.II/meshworker/vector_selector.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

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()

Member Data Documentation

◆ value_selection

◆ gradient_selection

◆ hessian_selection