Reference documentation for deal.II version Git d902c8c1aa 2019-12-15 00:36:45 -0500
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | List of all members
MeshWorker::VectorData< VectorType, dim, spacedim > Class Template Reference

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

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

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
 
- Public Member Functions inherited from MeshWorker::VectorDataBase< dim, spacedim, VectorType::value_type >
 VectorDataBase ()=default
 
 VectorDataBase (const VectorSelector &)
 
void initialize (const AnyData &)
 
virtual ~VectorDataBase () override=default
 
- Public Member Functions inherited from MeshWorker::VectorSelector
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 ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&) noexcept
 
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)
 

Additional Inherited Members

- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
- Protected Attributes inherited from MeshWorker::VectorSelector
NamedSelection value_selection
 
NamedSelection gradient_selection
 
NamedSelection hessian_selection
 

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.

Author
Guido Kanschat, 2009

Definition at line 309 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
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
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, 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

The memory used by this object.


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