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

Harmonic Oscilator. More...

#include <harmonic_oscilator.h>

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

Public Types

using this_type = harmonic_oscilator< 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 harmonic_oscilator (Real const gamma=0.15) noexcept
 
constexpr harmonic_oscilator (harmonic_oscilator const &)=default
 
constexpr harmonic_oscilator (harmonic_oscilator &&) noexcept=default
 
constexpr auto operator= (harmonic_oscilator const &) -> harmonic_oscilator &=default
 
constexpr auto operator= (harmonic_oscilator &&) noexcept -> harmonic_oscilator &=default
 
virtual ~harmonic_oscilator ()=default
 
constexpr auto evaluate (fixed_size_vec< 2 > auto const &p, 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
 

Public Attributes

Real m_gamma
 

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<typename Real>
struct tatooine::analytical::numerical::harmonic_oscilator< Real >

Harmonic Oscilator.

Member Typedef Documentation

◆ parent_type

template<typename Real >
using tatooine::analytical::numerical::harmonic_oscilator< Real >::parent_type = vectorfield<this_type, Real, 2>

◆ this_type

template<typename Real >
using tatooine::analytical::numerical::harmonic_oscilator< Real >::this_type = harmonic_oscilator<Real>

Constructor & Destructor Documentation

◆ harmonic_oscilator() [1/3]

template<typename Real >
constexpr tatooine::analytical::numerical::harmonic_oscilator< Real >::harmonic_oscilator ( Real const  gamma = 0.15)
inlineexplicitconstexprnoexcept

◆ harmonic_oscilator() [2/3]

template<typename Real >
constexpr tatooine::analytical::numerical::harmonic_oscilator< Real >::harmonic_oscilator ( harmonic_oscilator< Real > const &  )
constexprdefault

◆ harmonic_oscilator() [3/3]

template<typename Real >
constexpr tatooine::analytical::numerical::harmonic_oscilator< Real >::harmonic_oscilator ( harmonic_oscilator< Real > &&  )
constexprdefaultnoexcept

◆ ~harmonic_oscilator()

template<typename Real >
virtual tatooine::analytical::numerical::harmonic_oscilator< Real >::~harmonic_oscilator ( )
virtualdefault

Member Function Documentation

◆ evaluate()

template<typename Real >
constexpr auto tatooine::analytical::numerical::harmonic_oscilator< Real >::evaluate ( fixed_size_vec< 2 > auto const &  p,
Real const  t 
) const -> tensor_type
inlineconstexpr

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

Member Data Documentation

◆ m_gamma

template<typename Real >
Real tatooine::analytical::numerical::harmonic_oscilator< Real >::m_gamma

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