Reference documentation for deal.II version Git a3b517947a 2019-09-22 22:52:08 -0400
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Types | Static Public Member Functions | Static Public Attributes | List of all members
Differentiation::AD::internal::Extractor< dim, FEValuesExtractors::Scalar > 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 = NumberType
 
template<typename NumberType >
using gradient_type = Tensor< rank+1, dim, NumberType >
 

Static Public Member Functions

static unsigned int first_component (const FEValuesExtractors::Scalar &extractor)
 
static bool symmetric_component (const unsigned int unrolled_index)
 
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 = 1
 
static const unsigned int rank = 0
 

Detailed Description

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

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

Definition at line 1669 of file ad_helpers.h.

Member Typedef Documentation

◆ tensor_type

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

The tensor type associated with this field.

Definition at line 1685 of file ad_helpers.h.

◆ value_type

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

The value type associated with this field.

Definition at line 1702 of file ad_helpers.h.

◆ gradient_type

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

The gradient type associated with this field.

Definition at line 1708 of file ad_helpers.h.

Member Function Documentation

◆ first_component()

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

Return the first global component of this field.

Definition at line 1714 of file ad_helpers.h.

◆ symmetric_component()

template<int dim>
static bool Differentiation::AD::internal::Extractor< dim, FEValuesExtractors::Scalar >::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 scalar field, the single component is defined to not have a symmetric counterpart.

Definition at line 1727 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::Scalar >::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.

For a scalar field, the local component is always equal to zero.

Definition at line 1742 of file ad_helpers.h.

Member Data Documentation

◆ n_components

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

The number of components of the field.

Definition at line 1674 of file ad_helpers.h.

◆ rank

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

The tensor rank of the field.

Definition at line 1679 of file ad_helpers.h.


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