NiHu  2.0
NiHu::directional_derivative_field< Field > Class Template Reference

field class that computes the directional derivative of a field More...

#include <field.hpp>

Public Types

typedef directional_derivative_field type
 self-returning metafunction
 
typedef field_base< directional_derivative_field< Field > > crtp_base_t
 the crtp base type
 
typedef crtp_base_t::nset_t nset_t
 the field shape set type
 
typedef crtp_base_t::elem_t elem_t
 the element type
 
typedef crtp_base_t::xi_t xi_t
 the intrinsic location type
 
typedef crtp_base_t::x_t x_t
 the physical location type
 
typedef crtp_base_t::dofs_return_t dofs_return_t
 the return type for the dof vector
 
typedef crtp_base_t::eval_return_t eval_return_t
 the return type of the eval function
 

Public Member Functions

template<class Direction >
 directional_derivative_field (Field const &field, Eigen::MatrixBase< Direction > const &direction)
 contruct a directional derivative field instance More...
 
eval_return_t eval (xi_t const &xi) const
 evaluate the directional derivative field More...
 
const elem_tget_elem () const
 return the element
 
dofs_return_t get_dofs () const
 return the dofs vector
 

Detailed Description

template<class Field>
class NiHu::directional_derivative_field< Field >

field class that computes the directional derivative of a field

field computing a parent field's directional derivative

Template Parameters
Fieldthe parent field type
Fieldthe parent field

Definition at line 496 of file field.hpp.

Constructor & Destructor Documentation

◆ directional_derivative_field()

template<class Field >
template<class Direction >
NiHu::directional_derivative_field< Field >::directional_derivative_field ( Field const &  field,
Eigen::MatrixBase< Direction > const &  direction 
)
inline

contruct a directional derivative field instance

Template Parameters
Derivedthe direction class (must be an Eigen matrix)
Parameters
[in]fieldthe parent field (stored as constant reference)
[in]directionthe derivative direction (stored as reference too!)

Definition at line 551 of file field.hpp.

Member Function Documentation

◆ eval()

template<class Field >
eval_return_t NiHu::directional_derivative_field< Field >::eval ( xi_t const &  xi) const
inline

evaluate the directional derivative field

Parameters
[in]xithe intrinsic location
Returns
the directional derivative of the shape functions

Definition at line 561 of file field.hpp.


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