Tatooine
Public Types | Public Member Functions | List of all members
tatooine::field< DerivedField, Real, NumDimensions, Tensor > Struct Template Reference

#include <field.h>

Inheritance diagram for tatooine::field< DerivedField, Real, NumDimensions, Tensor >:
[legend]
Collaboration diagram for tatooine::field< DerivedField, Real, NumDimensions, Tensor >:
[legend]

Public Types

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

 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
 

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<typename DerivedField , typename Real , std::size_t NumDimensions, typename Tensor >
using tatooine::field< DerivedField, Real, NumDimensions, Tensor >::parent_type = polymorphic::field<Real, NumDimensions, Tensor>

◆ pos_type

template<typename DerivedField , typename Real , std::size_t NumDimensions, typename Tensor >
using tatooine::polymorphic::field< Real, NumDimensions, Tensor >::pos_type = vec<real_type, NumDimensions>

◆ real_type

template<typename DerivedField , typename Real , std::size_t NumDimensions, typename Tensor >
using tatooine::polymorphic::field< Real, NumDimensions, Tensor >::real_type = Real

◆ tensor_type

template<typename DerivedField , typename Real , std::size_t NumDimensions, typename Tensor >
using tatooine::polymorphic::field< Real, NumDimensions, Tensor >::tensor_type = Tensor

◆ this_type

template<typename DerivedField , typename Real , std::size_t NumDimensions, typename Tensor >
using tatooine::field< DerivedField, Real, NumDimensions, Tensor >::this_type = field<DerivedField, Real, NumDimensions, Tensor>

Constructor & Destructor Documentation

◆ field() [1/3]

template<typename DerivedField , typename Real , std::size_t NumDimensions, typename Tensor >
tatooine::field< DerivedField, Real, NumDimensions, Tensor >::field ( )
default

◆ field() [2/3]

template<typename DerivedField , typename Real , std::size_t NumDimensions, typename Tensor >
tatooine::field< DerivedField, Real, NumDimensions, Tensor >::field ( field< DerivedField, Real, NumDimensions, Tensor > const &  )
default

◆ field() [3/3]

template<typename DerivedField , typename Real , std::size_t NumDimensions, typename Tensor >
tatooine::field< DerivedField, Real, NumDimensions, Tensor >::field ( field< DerivedField, Real, NumDimensions, Tensor > &&  )
defaultnoexcept

◆ ~field()

template<typename DerivedField , typename Real , std::size_t NumDimensions, typename Tensor >
virtual tatooine::field< DerivedField, Real, NumDimensions, Tensor >::~field ( )
virtualdefault

Reimplemented from tatooine::polymorphic::field< Real, NumDimensions, Tensor >.

Member Function Documentation

◆ as_derived() [1/2]

template<typename DerivedField , typename Real , std::size_t NumDimensions, typename Tensor >
auto tatooine::field< DerivedField, Real, NumDimensions, Tensor >::as_derived ( ) -> auto&
inline

◆ as_derived() [2/2]

template<typename DerivedField , typename Real , std::size_t NumDimensions, typename Tensor >
auto tatooine::field< DerivedField, Real, NumDimensions, Tensor >::as_derived ( ) const -> auto const&
inline

◆ evaluate()

template<typename DerivedField , typename Real , std::size_t NumDimensions, typename Tensor >
auto tatooine::field< DerivedField, Real, NumDimensions, Tensor >::evaluate ( pos_type const &  x,
real_type const  t 
) const -> tensor_type
inlineoverridevirtual

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

Reimplemented in tatooine::analytical::numerical::doublegyre3d< real_type >, tatooine::Q_field< V >, tatooine::spacetime_splitted_vectorfield< V >, tatooine::spacetime_splitted_vectorfield< polymorphic::vectorfield< double, 3 > const * >, tatooine::spacetime_vectorfield< V >, and tatooine::spacetime_vectorfield< polymorphic::vectorfield< real_type, 2 > const *, real_type, 3 >.

◆ operator=() [1/2]

template<typename DerivedField , typename Real , std::size_t NumDimensions, typename Tensor >
auto tatooine::field< DerivedField, Real, NumDimensions, Tensor >::operator= ( field< DerivedField, Real, NumDimensions, Tensor > &&  ) -> field &=default
defaultnoexcept

◆ operator=() [2/2]

template<typename DerivedField , typename Real , std::size_t NumDimensions, typename Tensor >
auto tatooine::field< DerivedField, Real, NumDimensions, Tensor >::operator= ( field< DerivedField, Real, NumDimensions, Tensor > const &  ) -> field &=default
default
The documentation for this struct was generated from the following file:
Generated by doxygen 1.9.5