FEAT::Analytic::Divergence< Function_ > Class Template Reference

Analytic Function Divergence wrapper. More...

#include <wrappers.hpp>

Inheritance diagram for FEAT::Analytic::Divergence< Function_ >:

Classes
class	Evaluator

Public Types
typedef Image::Scalar	ImageType
	this is a vector-valued function More...

Public Member Functions
	Divergence (const Function_ &function)
	Constructor. More...

Static Public Attributes
static constexpr bool	can_grad = false
static constexpr bool	can_hess = false
static constexpr bool	can_value = Function_::can_grad
static constexpr int	domain_dim = Function_::domain_dim
	our domain dimension is the same as the input function's More...

Private Attributes
const Function_ &	_function

Detailed Description

template<typename Function_>
class FEAT::Analytic::Divergence< Function_ >

Analytic Function Divergence wrapper.

This class template represents the divergence of another vector field.

Template Parameters

Function_

The function whose divergence is to be wrapped.

Author

Peter Zajac

Definition at line 102 of file wrappers.hpp.

Member Typedef Documentation

ImageType

template<typename Function_ >

typedef Image::Scalar FEAT::Analytic::Divergence< Function_ >::ImageType

this is a vector-valued function

Definition at line 113 of file wrappers.hpp.

Constructor & Destructor Documentation

Divergence()

template<typename Function_ >

FEAT::Analytic::Divergence< Function_ >::Divergence ( const Function_ &  function )

inlineexplicit

Constructor.

Parameters

[in]

function

A resident reference to the function whose divergence is to be wrapped.

Definition at line 169 of file wrappers.hpp.

Member Data Documentation

_function

template<typename Function_ >

const Function_& FEAT::Analytic::Divergence< Function_ >::_function

private

Definition at line 160 of file wrappers.hpp.

can_grad

template<typename Function_ >

constexpr bool FEAT::Analytic::Divergence< Function_ >::can_grad = false

staticconstexpr

Definition at line 116 of file wrappers.hpp.

can_hess

template<typename Function_ >

constexpr bool FEAT::Analytic::Divergence< Function_ >::can_hess = false

staticconstexpr

Definition at line 117 of file wrappers.hpp.

can_value

template<typename Function_ >

constexpr bool FEAT::Analytic::Divergence< Function_ >::can_value = Function_::can_grad

staticconstexpr

Definition at line 115 of file wrappers.hpp.

domain_dim

template<typename Function_ >

constexpr int FEAT::Analytic::Divergence< Function_ >::domain_dim = Function_::domain_dim

staticconstexpr

our domain dimension is the same as the input function's

Definition at line 110 of file wrappers.hpp.

---

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

• kernel/analytic/wrappers.hpp