Tatooine
Public Types | Public Member Functions | Public Attributes | List of all members
tatooine::analytical::numerical::doublegyre3d< Real > Struct Template Reference

#include <doublegyre3d.h>

Inheritance diagram for tatooine::analytical::numerical::doublegyre3d< Real >:
[legend]
Collaboration diagram for tatooine::analytical::numerical::doublegyre3d< Real >:
[legend]

Public Types

using this_type = doublegyre3d< Real >
 
using parent_type = vectorfield< this_type, Real, 3 >
 
using real_type = typename parent_type::real_type
 
using pos_type = typename parent_type::pos_type
 
using tensor_type = typename parent_type::tensor_type
 
- 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

virtual ~doublegyre3d ()=default
 
auto evaluate (pos_type const &p, real_type const t) const -> tensor_type final
 
auto in_domain (pos_type const &, real_type const) const -> bool final
 
- 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
 

Public Attributes

real_type m_eps = real_type(1) / real_type(4)
 
real_type m_omega = 2 * M_PI / 10
 
real_type m_A = real_type(1) / real_type(10)
 

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::doublegyre3d< Real >::parent_type = vectorfield<this_type, Real, 3>

◆ pos_type

template<floating_point Real>
using tatooine::analytical::numerical::doublegyre3d< Real >::pos_type = typename parent_type::pos_type

◆ real_type

template<floating_point Real>
using tatooine::analytical::numerical::doublegyre3d< Real >::real_type = typename parent_type::real_type

◆ tensor_type

template<floating_point Real>
using tatooine::analytical::numerical::doublegyre3d< Real >::tensor_type = typename parent_type::tensor_type

◆ this_type

template<floating_point Real>
using tatooine::analytical::numerical::doublegyre3d< Real >::this_type = doublegyre3d<Real>

Constructor & Destructor Documentation

◆ ~doublegyre3d()

template<floating_point Real>
virtual tatooine::analytical::numerical::doublegyre3d< Real >::~doublegyre3d ( )
virtualdefault

Member Function Documentation

◆ evaluate()

template<floating_point Real>
auto tatooine::analytical::numerical::doublegyre3d< Real >::evaluate ( pos_type const &  p,
real_type const  t 
) const -> tensor_type
inlinefinalvirtual

◆ in_domain()

template<floating_point Real>
auto tatooine::analytical::numerical::doublegyre3d< Real >::in_domain ( pos_type const &  ,
real_type const   
) const -> bool
inlinefinal

Member Data Documentation

◆ m_A

template<floating_point Real>
real_type tatooine::analytical::numerical::doublegyre3d< Real >::m_A = real_type(1) / real_type(10)

◆ m_eps

template<floating_point Real>
real_type tatooine::analytical::numerical::doublegyre3d< Real >::m_eps = real_type(1) / real_type(4)

◆ m_omega

template<floating_point Real>
real_type tatooine::analytical::numerical::doublegyre3d< Real >::m_omega = 2 * M_PI / 10

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