Reference documentation for deal.II version Git d9b14c2d54 2019-09-14 18:13:29 -0600
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Types | Static Public Member Functions | Static Public Attributes | List of all members
Differentiation::AD::internal::Extractor< dim, FEValuesExtractors::Vector > Struct Template Reference

#include <deal.II/differentiation/ad/ad_helpers.h>

Public Types

template<typename NumberType >
using tensor_type = Tensor< rank, dim, NumberType >
 
template<typename NumberType >
using value_type = tensor_type< NumberType >
 
template<typename NumberType >
using gradient_type = Tensor< rank+1, dim, NumberType >
 

Static Public Member Functions

static unsigned int first_component (const FEValuesExtractors::Vector &extractor)
 
static bool symmetric_component (const unsigned int unrolled_index)
 
template<int rank_in>
static TableIndices< ranktable_index_view (const TableIndices< rank_in > &table_indices, const unsigned int column_offset)
 
template<typename IndexType = unsigned int, int rank_in>
static IndexType local_component (const TableIndices< rank_in > &table_indices, const unsigned int column_offset)
 

Static Public Attributes

static const unsigned int n_components = dim
 
static const unsigned int rank = 1
 

Detailed Description

template<int dim>
struct Differentiation::AD::internal::Extractor< dim, FEValuesExtractors::Vector >

A helper struct that assists with the extraction of data associated with fields that are defined by FEExtractors. This particular specialization is for vector fields.

Definition at line 1759 of file ad_helpers.h.

Member Typedef Documentation

◆ tensor_type

template<int dim>
template<typename NumberType >
using Differentiation::AD::internal::Extractor< dim, FEValuesExtractors::Vector >::tensor_type = Tensor<rank, dim, NumberType>

The tensor type associated with this field.

Definition at line 1775 of file ad_helpers.h.

◆ value_type

template<int dim>
template<typename NumberType >
using Differentiation::AD::internal::Extractor< dim, FEValuesExtractors::Vector >::value_type = tensor_type<NumberType>

The value type associated with this field.

Definition at line 1788 of file ad_helpers.h.

◆ gradient_type

template<int dim>
template<typename NumberType >
using Differentiation::AD::internal::Extractor< dim, FEValuesExtractors::Vector >::gradient_type = Tensor<rank + 1, dim, NumberType>

The gradient type associated with this field.

Definition at line 1794 of file ad_helpers.h.

Member Function Documentation

◆ first_component()

template<int dim>
static unsigned int Differentiation::AD::internal::Extractor< dim, FEValuesExtractors::Vector >::first_component ( const FEValuesExtractors::Vector extractor)
inlinestatic

Return the first global component of this field.

Definition at line 1800 of file ad_helpers.h.

◆ symmetric_component()

template<int dim>
static bool Differentiation::AD::internal::Extractor< dim, FEValuesExtractors::Vector >::symmetric_component ( const unsigned int  unrolled_index)
inlinestatic

Return a flag that indicates if the input unrolled_index corresponds to a symmetric component of the field.

For a vector field, the none of the vector components have a symmetric counterpart.

Definition at line 1814 of file ad_helpers.h.

◆ table_index_view()

template<int dim>
template<int rank_in>
static TableIndices<rank> Differentiation::AD::internal::Extractor< dim, FEValuesExtractors::Vector >::table_index_view ( const TableIndices< rank_in > &  table_indices,
const unsigned int  column_offset 
)
inlinestatic

Return the table index corresponding to column_offset entry of the input table_indices.

Definition at line 1826 of file ad_helpers.h.

◆ local_component()

template<int dim>
template<typename IndexType = unsigned int, int rank_in>
static IndexType Differentiation::AD::internal::Extractor< dim, FEValuesExtractors::Vector >::local_component ( const TableIndices< rank_in > &  table_indices,
const unsigned int  column_offset 
)
inlinestatic

Return the local unrolled component corresponding to column_offset entry of the table_indices.

This function computes and returns a local component associated with the extractor's tensor_type from a set of table_indices that are generally associated with a tensor of equal or greater order. In effect, it creates a view of a selected number of indices of the input table, and interprets that subtable's indices as the local index to be returned. Since the table_indices may be of size greater than the extractor's rank, the column_offset specifies the first index of the input table to create the view from.

Definition at line 1850 of file ad_helpers.h.

Member Data Documentation

◆ n_components

template<int dim>
const unsigned int Differentiation::AD::internal::Extractor< dim, FEValuesExtractors::Vector >::n_components = dim
static

The number of components of the field.

Definition at line 1764 of file ad_helpers.h.

◆ rank

template<int dim>
const unsigned int Differentiation::AD::internal::Extractor< dim, FEValuesExtractors::Vector >::rank = 1
static

The tensor rank of the field.

Definition at line 1769 of file ad_helpers.h.


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