olb::util::ADf< T, DIM > Class Template Reference

Definition of a description of a algoritmic differentiation data type using the forward method. More...

#include <aDiff.h>

Inheritance diagram for olb::util::ADf< T, DIM >:

Collaboration diagram for olb::util::ADf< T, DIM >:

Public Types
using	base_t = T

Public Member Functions
constexpr	ADf ()
constexpr	ADf (const ADf &a)
constexpr	ADf (const T &v)
constexpr	ADf (const T &v, const Vector< T, DIM > &d)
constexpr	ADf (ADf &&a)
constexpr T &	v ()
constexpr T &	d (unsigned i)
constexpr const T &	d (unsigned i) const
constexpr Vector< T, DIM > &	d ()
constexpr ADf &	operator= (const ADf &a)
constexpr ADf &	operator= (ADf &&a)
constexpr ADf &	operator= (const T &v)
constexpr ADf &	operator+= (const ADf &a)
constexpr ADf &	operator+= (const T &v)
constexpr ADf &	operator-= (const ADf &a)
constexpr ADf &	operator-= (const T &v)
constexpr ADf &	operator*= (const ADf &a)
constexpr ADf &	operator*= (const T &v)
constexpr ADf &	operator/= (const ADf &a)
constexpr ADf &	operator/= (const T &v)
constexpr void	setDiffVariable (unsigned iD)
constexpr bool	hasZeroDerivative () const
	tests if ADf has only zero derivatives
constexpr	operator base_t () const

Public Attributes
T	_v = T()
	value
Vector< T, DIM >	_d = ( T( 0 ) )
	derivatives

Static Public Attributes
static constexpr unsigned	dim = DIM

Detailed Description

template<class T, unsigned DIM>
class olb::util::ADf< T, DIM >

Definition of a description of a algoritmic differentiation data type using the forward method.

An ADf is a data type which enables the calculation of derivatives by means of algorithmic differentiation.

This class is not intended to be derived from. See olb::meta::is_arithmetic

Definition at line 64 of file aDiff.h.

Member Typedef Documentation

base_t

template<class T , unsigned DIM>

using olb::util::ADf< T, DIM >::base_t = T

Definition at line 68 of file aDiff.h.

Constructor & Destructor Documentation

ADf() [1/5]

template<class T , unsigned DIM>

constexpr olb::util::ADf< T, DIM >::ADf ( )

inlineconstexpr

Definition at line 128 of file aDiff.h.

                                :ADf<T,DIM>( T() )
{ }

ADf() [2/5]

template<class T , unsigned DIM>

constexpr olb::util::ADf< T, DIM >::ADf ( const ADf< T, DIM > & a )

inlineconstexpr

Definition at line 132 of file aDiff.h.

                                            :ADf<T,DIM>(a._v, a._d)
{ }

ADf() [3/5]

template<class T , unsigned DIM>

constexpr olb::util::ADf< T, DIM >::ADf ( const T & v )

inlineconstexpr

Definition at line 136 of file aDiff.h.

                                          :ADf<T,DIM>(v,Vector<T,DIM> {})
{ }

ADf() [4/5]

template<class T , unsigned DIM>

constexpr olb::util::ADf< T, DIM >::ADf ( const T & v, const Vector< T, DIM > & d )

inlineconstexpr

Definition at line 140 of file aDiff.h.

                                                                  : _v(v), _d(d)
{
  checkDataType();
}

ADf() [5/5]

template<class T , unsigned DIM>

constexpr olb::util::ADf< T, DIM >::ADf ( ADf< T, DIM > && a )

inlineconstexpr

Definition at line 146 of file aDiff.h.

                                       :ADf<T,DIM>(a._v, a._d)
{ }

Member Function Documentation

d() [1/3]

template<class T , unsigned DIM>

constexpr Vector< T, DIM > & olb::util::ADf< T, DIM >::d ( )

inlineconstexpr

Definition at line 264 of file aDiff.h.

{
  return _d;
}

d() [2/3]

template<class T , unsigned DIM>

constexpr T & olb::util::ADf< T, DIM >::d ( unsigned i )

inlineconstexpr

Definition at line 252 of file aDiff.h.

{
  return _d[i];
}

Here is the caller graph for this function:

d() [3/3]

template<class T , unsigned DIM>

constexpr const T & olb::util::ADf< T, DIM >::d ( unsigned i ) const

inlineconstexpr

Definition at line 258 of file aDiff.h.

{
  return _d[i];
}

hasZeroDerivative()

template<class T , unsigned DIM>

constexpr bool olb::util::ADf< T, DIM >::hasZeroDerivative ( ) const

inlineconstexpr

tests if ADf has only zero derivatives

Definition at line 731 of file aDiff.h.

{
  T sum = 0;
  for (unsigned i=0; i<DIM; i++) {
    sum += std::fabs(_d[i]);
  }
  return sum==0;
}

operator base_t()

template<class T , unsigned DIM>

constexpr olb::util::ADf< T, DIM >::operator base_t ( ) const

inlineconstexpr

operator*=() [1/2]

template<class T , unsigned DIM>

constexpr ADf< T, DIM > & olb::util::ADf< T, DIM >::operator*= ( const ADf< T, DIM > & a )

inlineconstexpr

Definition at line 212 of file aDiff.h.

{
  _d=_d*a._v+_v*a._d;
  _v*=a._v;
  return *this;
}

References olb::util::ADf< T, DIM >::_d, and olb::util::ADf< T, DIM >::_v.

operator*=() [2/2]

template<class T , unsigned DIM>

constexpr ADf< T, DIM > & olb::util::ADf< T, DIM >::operator*= ( const T & v )

inlineconstexpr

Definition at line 220 of file aDiff.h.

{
  _v*=v;
  _d*=v;
  return *this;
}

operator+=() [1/2]

template<class T , unsigned DIM>

constexpr ADf< T, DIM > & olb::util::ADf< T, DIM >::operator+= ( const ADf< T, DIM > & a )

inlineconstexpr

Definition at line 182 of file aDiff.h.

{
  _v+=a._v;
  _d+=a._d;
  return *this;
}

References olb::util::ADf< T, DIM >::_d, and olb::util::ADf< T, DIM >::_v.

operator+=() [2/2]

template<class T , unsigned DIM>

constexpr ADf< T, DIM > & olb::util::ADf< T, DIM >::operator+= ( const T & v )

inlineconstexpr

Definition at line 190 of file aDiff.h.

{
  _v+=v;
  return *this;
}

operator-=() [1/2]

template<class T , unsigned DIM>

constexpr ADf< T, DIM > & olb::util::ADf< T, DIM >::operator-= ( const ADf< T, DIM > & a )

inlineconstexpr

Definition at line 197 of file aDiff.h.

{
  _v-=a._v;
  _d-=a._d;
  return *this;
}

References olb::util::ADf< T, DIM >::_d, and olb::util::ADf< T, DIM >::_v.

operator-=() [2/2]

template<class T , unsigned DIM>

constexpr ADf< T, DIM > & olb::util::ADf< T, DIM >::operator-= ( const T & v )

inlineconstexpr

Definition at line 205 of file aDiff.h.

{
  _v-=v;
  return *this;
}

operator/=() [1/2]

template<class T , unsigned DIM>

constexpr ADf< T, DIM > & olb::util::ADf< T, DIM >::operator/= ( const ADf< T, DIM > & a )

inlineconstexpr

Definition at line 228 of file aDiff.h.

{
  T tmp(T(1)/a._v);
  _v*=tmp;
  _d=tmp*(_d-_v*a._d);
  return *this;
}

References olb::util::ADf< T, DIM >::_d, and olb::util::ADf< T, DIM >::_v.

operator/=() [2/2]

template<class T , unsigned DIM>

constexpr ADf< T, DIM > & olb::util::ADf< T, DIM >::operator/= ( const T & v )

inlineconstexpr

Definition at line 237 of file aDiff.h.

{
  T tmp(T(1)/v);
  _v*=tmp;
  _d*=tmp;
  return *this;
}

operator=() [1/3]

template<class T , unsigned DIM>

constexpr ADf< T, DIM > & olb::util::ADf< T, DIM >::operator= ( ADf< T, DIM > && a )

inlineconstexpr

Definition at line 166 of file aDiff.h.

{
  _v=a._v;
  _d=a._d;
  return *this;
}

References olb::util::ADf< T, DIM >::_v.

operator=() [2/3]

template<class T , unsigned DIM>

constexpr ADf< T, DIM > & olb::util::ADf< T, DIM >::operator= ( const ADf< T, DIM > & a )

inlineconstexpr

Definition at line 158 of file aDiff.h.

{
  _v=a._v;
  _d=a._d;
  return *this;
}

References olb::util::ADf< T, DIM >::_d, and olb::util::ADf< T, DIM >::_v.

operator=() [3/3]

template<class T , unsigned DIM>

constexpr ADf< T, DIM > & olb::util::ADf< T, DIM >::operator= ( const T & v )

inlineconstexpr

Definition at line 174 of file aDiff.h.

{
  _v=v;
  _d = ( T() );
  return *this;
}

setDiffVariable()

template<class T , unsigned DIM>

constexpr void olb::util::ADf< T, DIM >::setDiffVariable ( unsigned iD )

inlineconstexpr

Definition at line 270 of file aDiff.h.

{
  _d =( T(0) );
  _d[iD] = T(1);
}

Here is the caller graph for this function:

v()

template<class T , unsigned DIM>

constexpr T & olb::util::ADf< T, DIM >::v ( )

inlineconstexpr

Definition at line 246 of file aDiff.h.

{
  return _v;
}

Here is the caller graph for this function:

Member Data Documentation

_d

template<class T , unsigned DIM>

Vector<T,DIM> olb::util::ADf< T, DIM >::_d = ( T( 0 ) )

derivatives

Definition at line 74 of file aDiff.h.

_v

template<class T , unsigned DIM>

T olb::util::ADf< T, DIM >::_v = T()

value

Definition at line 72 of file aDiff.h.

dim

template<class T , unsigned DIM>

constexpr unsigned olb::util::ADf< T, DIM >::dim = DIM

staticconstexpr

Definition at line 69 of file aDiff.h.

---

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

• src/io/xmlReader.h
• src/utilities/aDiff.h