FieldCoupling::Fields::Constant< T, codim > Class Template Reference

A vector field that is constant in space. More...

#include <Constant.hpp>

Public Types
using	value_type = typename Utils::decay_to_scalar< Utils::Vector< T, codim > >::type
using	jacobian_type = detail::jacobian_type< T, codim >

Public Member Functions
	Constant (const value_type &value)
value_type &	value ()
value_type	operator() (const Utils::Vector3d &, double={}) const
bool	fits_in_box (const Utils::Vector3d &) const

Static Public Member Functions
static constexpr jacobian_type	jacobian (const Utils::Vector3d &)

Detailed Description

template<typename T, std::size_t codim>
class FieldCoupling::Fields::Constant< T, codim >

A vector field that is constant in space.

Definition at line 32 of file Constant.hpp.

Member Typedef Documentation

jacobian_type

template<typename T , std::size_t codim>

using FieldCoupling::Fields::Constant< T, codim >::jacobian_type = detail::jacobian_type<T, codim>

Definition at line 36 of file Constant.hpp.

value_type

template<typename T , std::size_t codim>

using FieldCoupling::Fields::Constant< T, codim >::value_type = typename Utils::decay_to_scalar<Utils::Vector<T, codim> >::type

Definition at line 34 of file Constant.hpp.

Constructor & Destructor Documentation

Constant()

template<typename T , std::size_t codim>

FieldCoupling::Fields::Constant< T, codim >::Constant ( const value_type &  value )

inline

Definition at line 42 of file Constant.hpp.

Member Function Documentation

fits_in_box()

template<typename T , std::size_t codim>

bool FieldCoupling::Fields::Constant< T, codim >::fits_in_box ( const Utils::Vector3d &  ) const

inline

Definition at line 53 of file Constant.hpp.

jacobian()

template<typename T , std::size_t codim>

static constexpr jacobian_type FieldCoupling::Fields::Constant< T, codim >::jacobian ( const Utils::Vector3d &  )

inlinestaticconstexpr

Definition at line 49 of file Constant.hpp.

operator()()

template<typename T , std::size_t codim>

value_type FieldCoupling::Fields::Constant< T, codim >::operator() ( const Utils::Vector3d &  , double  = {}  ) const

inline

Definition at line 46 of file Constant.hpp.

value()

template<typename T , std::size_t codim>

value_type & FieldCoupling::Fields::Constant< T, codim >::value ( )

inline

Definition at line 44 of file Constant.hpp.

---

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

• Constant.hpp