Reference documentation for deal.II version Git 1c2f3d7ba8 2021-05-16 10:03:46 +0200
\(\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\}}\)
Differentiation::AD::internal::ExtractData< ADNumberType, T > Struct Template Reference

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

Detailed Description

template<typename ADNumberType, typename T = void>
struct Differentiation::AD::internal::ExtractData< ADNumberType, T >

A struct to help extract certain information associated with auto-differentiable numbers.

The specializations of this class have to implement the following member data and type definitions:

// Extract the real scalar value.
static scalar_type
value (const ADNumberType &x);
// Extract the number of directional derivatives.
static unsigned int
n_directional_derivatives (const ADNumberType &x);
// Extract the directional derivative in the specified @p direction.
static derivative_type
directional_derivative (const ADNumberType &x,
const unsigned int direction);

where ADNumberType is the auto-differentiable number type.

Template Parameters
ADNumberTypeA type corresponding to a supported auto-differentiable number.
TAn arbitrary type resulting from the application of the SFINAE idiom to selectively specialize this class.

Definition at line 176 of file ad_number_traits.h.

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