FEAT::Analytic::Function Class Reference

Analytic Function interface. More...

#include <function.hpp>

Inheritance diagram for FEAT::Analytic::Function:

Classes
class	Evaluator
	Analytic Function Evaluator base-class template. More...

Public Attributes
typedef	ImageType
	Specifies the image type of the function. More...

Static Public Attributes
static constexpr bool	can_grad = true or false
	Specifies whether the function's evaluator can compute function gradients. More...
static constexpr bool	can_hess = true or false
	Specifies whether the function's evaluator can compute function hessians. More...
static constexpr bool	can_value = true or false
	Specifies whether the function's evaluator can compute function values. More...
static constexpr int	domain_dim = ...
	Specifies the domain dimension of the function. More...

Detailed Description

Analytic Function interface.

This class acts as a base-class and interface description for analytic functions, which can be used for various assembly purposes such as right-hand-side and boundary condition assembly as well as in post-processing.

Author

Peter Zajac

Definition at line 111 of file function.hpp.

Member Data Documentation

can_grad

constexpr bool FEAT::Analytic::Function::can_grad = true or false

staticconstexpr

Specifies whether the function's evaluator can compute function gradients.

Definition at line 138 of file function.hpp.

can_hess

constexpr bool FEAT::Analytic::Function::can_hess = true or false

staticconstexpr

Specifies whether the function's evaluator can compute function hessians.

Definition at line 140 of file function.hpp.

can_value

constexpr bool FEAT::Analytic::Function::can_value = true or false

staticconstexpr

Specifies whether the function's evaluator can compute function values.

Definition at line 136 of file function.hpp.

domain_dim

constexpr int FEAT::Analytic::Function::domain_dim = ...

staticconstexpr

Specifies the domain dimension of the function.

Attention

This member must be specified by each derived class.

Definition at line 123 of file function.hpp.

ImageType

typedef FEAT::Analytic::Function::ImageType

Specifies the image type of the function.

This is a typedef for either Image::Scalar or an instance of Image::Vector, which specifies whether this is a scalar function or a vector field.

Attention

This member must be specified by each derived class.

Definition at line 133 of file function.hpp.

---

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

• kernel/analytic/function.hpp