Ikarus::AutoDiffFE< FEImpl, forceAutoDiff > Class Template Reference

AutoDiffFE class, an automatic differentiation wrapper for finite elements. More...

#include <ikarus/finiteelements/autodifffe.hh>

Inheritance diagram for Ikarus::AutoDiffFE< FEImpl, forceAutoDiff >:

Public Types
using	RealFE = FEImpl
	Type of the base finite element. More...
using	BasisHandler = typename RealFE::BasisHandler
	Type of the basis handler. More...
using	Traits = typename RealFE::Traits
	Type traits for local view. More...
using	LocalView = typename Traits::LocalView
	Type of the local view. More...
using	Element = typename Traits::Element
	Type of the element. More...
using	Requirement = typename RealFE::Requirement
	Type of the Finite Element Requirements. More...

Public Member Functions
template<typename MT , typename BC >
auto	subscribeTo (BC &bc)
	Subscribes the elements to listen to functions provided from the skills emitted by the given broadcaster. More...
const RealFE &	realFE () const
	Get the reference to the base finite element. More...
RealFE &	realFE ()
	Get the reference to the base finite element. More...
template<typename... Args>
	AutoDiffFE (Args &&... args)
	Constructor for the AutoDiffFE class. Forward the construction to the underlying element. More...

Detailed Description

template<typename FEImpl, bool forceAutoDiff = false>
class Ikarus::AutoDiffFE< FEImpl, forceAutoDiff >

Template Parameters

FEImpl	The type of the original finite element, which does not implement the derivatives
forceAutoDiff	A boolean indicating whether to force the use of automatic differentiation, even when the real element implements the derivatives.

Member Typedef Documentation

BasisHandler

template<typename FEImpl , bool forceAutoDiff = false>

using Ikarus::AutoDiffFE< FEImpl, forceAutoDiff >::BasisHandler = typename RealFE::BasisHandler

Element

template<typename FEImpl , bool forceAutoDiff = false>

using Ikarus::AutoDiffFE< FEImpl, forceAutoDiff >::Element = typename Traits::Element

LocalView

template<typename FEImpl , bool forceAutoDiff = false>

using Ikarus::AutoDiffFE< FEImpl, forceAutoDiff >::LocalView = typename Traits::LocalView

RealFE

template<typename FEImpl , bool forceAutoDiff = false>

using Ikarus::AutoDiffFE< FEImpl, forceAutoDiff >::RealFE = FEImpl

Requirement

template<typename FEImpl , bool forceAutoDiff = false>

using Ikarus::AutoDiffFE< FEImpl, forceAutoDiff >::Requirement = typename RealFE::Requirement

Traits

template<typename FEImpl , bool forceAutoDiff = false>

using Ikarus::AutoDiffFE< FEImpl, forceAutoDiff >::Traits = typename RealFE::Traits

Constructor & Destructor Documentation

AutoDiffFE()

template<typename FEImpl , bool forceAutoDiff = false>

template<typename... Args>

Ikarus::AutoDiffFE< FEImpl, forceAutoDiff >::AutoDiffFE ( Args &&...  args )

inlineexplicit

Template Parameters

Args	Variadic template for constructor arguments.

Parameters

args	Constructor arguments.

Member Function Documentation

realFE() [1/2]

template<typename FEImpl , bool forceAutoDiff = false>

RealFE & Ikarus::AutoDiffFE< FEImpl, forceAutoDiff >::realFE ( )

inline

Returns

The reference to the base finite element.

realFE() [2/2]

template<typename FEImpl , bool forceAutoDiff = false>

const RealFE & Ikarus::AutoDiffFE< FEImpl, forceAutoDiff >::realFE ( ) const

inline

Returns

The reference to the base finite element.

Here is the caller graph for this function:

subscribeTo()

template<typename FEImpl , bool forceAutoDiff = false>

template<typename MT , typename BC >

auto Ikarus::AutoDiffFE< FEImpl, forceAutoDiff >::subscribeTo ( BC &  bc )

inline

Template Parameters

MT	the message type (for example NonlinerSolverMessages or ControlMessages)
BC	the type of the broadcaster

Parameters

bc	the broadcaster (for example a nonlinearsolver or control routine)

Returns

this-pointer

---

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

• autodifffe.hh