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

Franke's Test Function. See Here More...

#include <frankes_test.h>

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

Public Types

using this_type = frankes_test< Real >
 
using parent_type = scalarfield< 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 frankes_test () noexcept=default
 
constexpr frankes_test (frankes_test const &)=default
 
constexpr frankes_test (frankes_test &&) noexcept=default
 
auto constexpr operator= (frankes_test const &) -> frankes_test &=default
 
auto constexpr operator= (frankes_test &&) noexcept -> frankes_test &=default
 
 ~frankes_test () override=default
 
auto constexpr evaluate (fixed_size_vec< 2 > auto const &q, Real const t) 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
 

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)
 

Detailed Description

template<floating_point Real>
struct tatooine::analytical::numerical::frankes_test< Real >

Franke's Test Function. See Here

Member Typedef Documentation

◆ parent_type

template<floating_point Real>
using tatooine::analytical::numerical::frankes_test< Real >::parent_type = scalarfield<this_type, Real, 2>

◆ this_type

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

Constructor & Destructor Documentation

◆ frankes_test() [1/3]

template<floating_point Real>
constexpr tatooine::analytical::numerical::frankes_test< Real >::frankes_test ( )
explicitconstexprdefaultnoexcept

◆ frankes_test() [2/3]

template<floating_point Real>
constexpr tatooine::analytical::numerical::frankes_test< Real >::frankes_test ( frankes_test< Real > const &  )
constexprdefault

◆ frankes_test() [3/3]

template<floating_point Real>
constexpr tatooine::analytical::numerical::frankes_test< Real >::frankes_test ( frankes_test< Real > &&  )
constexprdefaultnoexcept

◆ ~frankes_test()

template<floating_point Real>
tatooine::analytical::numerical::frankes_test< Real >::~frankes_test ( )
overridedefault

Member Function Documentation

◆ evaluate()

template<floating_point Real>
auto constexpr tatooine::analytical::numerical::frankes_test< Real >::evaluate ( fixed_size_vec< 2 > auto const &  q,
Real const  t 
) const -> tensor_type
inlineconstexpr

◆ operator=() [1/2]

template<floating_point Real>
auto constexpr tatooine::analytical::numerical::frankes_test< Real >::operator= ( frankes_test< Real > &&  ) -> frankes_test &=default
constexprdefaultnoexcept

◆ operator=() [2/2]

template<floating_point Real>
auto constexpr tatooine::analytical::numerical::frankes_test< Real >::operator= ( frankes_test< Real > const &  ) -> frankes_test &=default
constexprdefault

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