Reference documentation for deal.II version Git d435e92be9 2020-09-23 09:04:26 -0400
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
MeshWorker::MGVectorData< VectorType, dim, spacedim > Class Template Reference

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

Inheritance diagram for MeshWorker::MGVectorData< VectorType, dim, spacedim >:
[legend]

Public Member Functions

 MGVectorData ()=default
 
 MGVectorData (const VectorSelector &)
 
void initialize (const AnyData &)
 
void initialize (const MGLevelObject< VectorType > *, const std::string &name)
 
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
 
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)
 

Static Public Member Functions

static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

Protected Attributes

AnyData data
 
NamedSelection value_selection
 
NamedSelection gradient_selection
 
NamedSelection hessian_selection
 

Detailed Description

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

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

Definition at line 386 of file vector_selector.h.

Constructor & Destructor Documentation

◆ MGVectorData() [1/2]

template<typename VectorType , int dim, int spacedim = dim>
MeshWorker::MGVectorData< VectorType, dim, spacedim >::MGVectorData ( )
default

Constructor.

◆ MGVectorData() [2/2]

template<typename VectorType , int dim, int spacedim = dim>
MeshWorker::MGVectorData< VectorType, dim, spacedim >::MGVectorData ( const VectorSelector )

Constructor using a prefilled VectorSelector

Member Function Documentation

◆ initialize() [1/3]

template<typename VectorType , int dim, int spacedim = dim>
void MeshWorker::MGVectorData< VectorType, dim, spacedim >::initialize ( const AnyData )

Initialize with an object of named vectors

◆ initialize() [2/3]

template<typename VectorType , int dim, int spacedim = dim>
void MeshWorker::MGVectorData< VectorType, dim, spacedim >::initialize ( const MGLevelObject< 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.

◆ initialize() [3/3]

template<typename VectorType , int dim, int spacedim = dim>
void MeshWorker::VectorData< VectorType, dim, spacedim >::initialize ( const VectorType ,
const std::string &  name 
)
inherited

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
overridevirtualinherited

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
valuesis the vector filled with the values of the finite element function in the quadrature points.
gradientsis the vector filled with the derivatives of the finite element function in the quadrature points.
hessiansis the vector filled with the second derivatives of the finite element function in the quadrature points.
feis the FEValuesBase object which is used to compute the function values. Its UpdateFlags must have been set appropriately.
indexis 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.
componentis the first index in values, gradients and hessians entered in this function.
n_compis the number of components to be filled.
startis the first index of this block in indices, or zero if no base elements are used.
sizeis the number of dofs per cell of the current element or base element.

Reimplemented from MeshWorker::VectorDataBase< dim, spacedim, 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
overridevirtualinherited

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, spacedim, VectorType::value_type >.

◆ memory_consumption()

template<typename VectorType , int dim, int spacedim = dim>
std::size_t MeshWorker::VectorData< VectorType, dim, spacedim >::memory_consumption ( ) const
inherited

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.

◆ 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 136 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 156 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 290 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 307 of file subscriptor.h.

◆ list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 204 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.

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 299 of file subscriptor.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: