tatooine::analytical::numerical::rotated_saddle< Real > Struct Template Reference

#include <saddle.h>

Inheritance diagram for tatooine::analytical::numerical::rotated_saddle< Real >:

Collaboration diagram for tatooine::analytical::numerical::rotated_saddle< Real >:

Public Types
using	this_type = rotated_saddle< Real >
using	parent_type = vectorfield< this_type, Real, 2 >
Public Types inherited from tatooine::field< DerivedField, Real, NumDimensions, Tensor >
using	this_type = field< DerivedField, Real, NumDimensions, Tensor >
using	parent_type = polymorphic::field< Real, NumDimensions, Tensor >
using	pos_type = vec< real_type, NumDimensions >
using	real_type = Real
using	tensor_type = Tensor
Public Types inherited from tatooine::polymorphic::field< Real, NumDimensions, Tensor >
using	real_type = Real
using	tensor_type = Tensor
using	this_type = field< real_type, NumDimensions, Tensor >
using	pos_type = vec< real_type, NumDimensions >

Public Member Functions
constexpr	rotated_saddle (Real angle_in_radians=M_PI/4) noexcept
constexpr	rotated_saddle (rotated_saddle const &)=default
constexpr	rotated_saddle (rotated_saddle &&) noexcept=default
auto constexpr	operator= (rotated_saddle const &) -> rotated_saddle &=default
auto constexpr	operator= (rotated_saddle &&) noexcept -> rotated_saddle &=default
virtual	~rotated_saddle ()=default
auto constexpr	evaluate (pos_type const &x, Real const) const -> tensor_type
Public Member Functions inherited from tatooine::field< DerivedField, Real, NumDimensions, Tensor >
	field ()=default
	field (field const &)=default
	field (field &&) noexcept=default
auto	operator= (field const &) -> field &=default
auto	operator= (field &&) noexcept -> field &=default
virtual	~field ()=default
auto	as_derived () -> auto &
auto	as_derived () const -> auto const &
auto	evaluate (pos_type const &x, real_type const t) const -> tensor_type override
Public Member Functions inherited from tatooine::polymorphic::field< Real, NumDimensions, Tensor >
constexpr	field ()=default
constexpr	field (field const &)=default
constexpr	field (field &&) noexcept=default
constexpr auto	operator= (field const &) -> field &=default
constexpr auto	operator= (field &&) noexcept -> field &=default
virtual	~field ()=default
virtual constexpr auto	evaluate (pos_type const &, real_type const) const -> tensor_type=0
constexpr auto	evaluate (fixed_size_vec< NumDimensions > auto const &x) const -> tensor_type
constexpr auto	operator() (fixed_size_vec< NumDimensions > auto const &x, real_type const t) const -> tensor_type
constexpr auto	operator() (fixed_size_vec< NumDimensions > auto const &x) const -> tensor_type
constexpr auto	operator() (arithmetic auto const ... xs) const -> tensor_type

Private Attributes
Real	m_angle_in_radians

Additional Inherited Members
Static Public Member Functions inherited from tatooine::polymorphic::field< Real, NumDimensions, Tensor >
static auto constexpr	ood_tensor ()
static auto constexpr	ood_position ()
static constexpr auto	is_field ()
static constexpr auto	is_scalarfield ()
static constexpr auto	is_vectorfield ()
static constexpr auto	is_matrixfield ()
static constexpr auto	num_dimensions () -> std::size_t
static constexpr auto	num_tensor_components ()
static constexpr auto	tensor_rank ()
static constexpr auto	tensor_dimension (std::size_t i)

Member Typedef Documentation

parent_type

template<floating_point Real>

using tatooine::analytical::numerical::rotated_saddle< Real >::parent_type = vectorfield<this_type, Real, 2>

this_type

template<floating_point Real>

using tatooine::analytical::numerical::rotated_saddle< Real >::this_type = rotated_saddle<Real>

Constructor & Destructor Documentation

rotated_saddle() [1/3]

template<floating_point Real>

constexpr tatooine::analytical::numerical::rotated_saddle< Real >::rotated_saddle ( Real  angle_in_radians = M_PI / 4 )

inlineexplicitconstexprnoexcept

rotated_saddle() [2/3]

template<floating_point Real>

constexpr tatooine::analytical::numerical::rotated_saddle< Real >::rotated_saddle ( rotated_saddle< Real > const &  )

constexprdefault

rotated_saddle() [3/3]

template<floating_point Real>

constexpr tatooine::analytical::numerical::rotated_saddle< Real >::rotated_saddle ( rotated_saddle< Real > &&  )

constexprdefaultnoexcept

~rotated_saddle()

template<floating_point Real>

virtual tatooine::analytical::numerical::rotated_saddle< Real >::~rotated_saddle ( )

virtualdefault

Member Function Documentation

evaluate()

template<floating_point Real>

auto constexpr tatooine::analytical::numerical::rotated_saddle< Real >::evaluate ( pos_type const &  x, Real const    ) const -> tensor_type

inlineconstexprvirtual

Implements tatooine::polymorphic::field< Real, NumDimensions, Tensor >.

operator=() [1/2]

template<floating_point Real>

auto constexpr tatooine::analytical::numerical::rotated_saddle< Real >::operator= ( rotated_saddle< Real > &&  ) -> rotated_saddle &=default

constexprdefaultnoexcept

operator=() [2/2]

template<floating_point Real>

auto constexpr tatooine::analytical::numerical::rotated_saddle< Real >::operator= ( rotated_saddle< Real > const &  ) -> rotated_saddle &=default

constexprdefault

Member Data Documentation

m_angle_in_radians

template<floating_point Real>

Real tatooine::analytical::numerical::rotated_saddle< Real >::m_angle_in_radians

private

---

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

• /mnt/data/home/ci/builds/Bicifxyn/0/libs/tatooine2/fields/include/tatooine/analytical/numerical/saddle.h