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

#include <rayleigh_benard_convection.h>

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

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

Public Types
using	this_type = rayleigh_benard_convection< Real >
using	parent_type = vectorfield< this_type, Real, 3 >
using	real_type = Real
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
	rayleigh_benard_convection ()
	rayleigh_benard_convection (real_type A, real_type k)
	rayleigh_benard_convection (rayleigh_benard_convection const &)=default
	rayleigh_benard_convection (rayleigh_benard_convection &&) noexcept=default
auto	operator= (rayleigh_benard_convection const &) -> rayleigh_benard_convection< real_type > &=default
auto	operator= (rayleigh_benard_convection &&) noexcept -> rayleigh_benard_convection< real_type > &=default
auto	evaluate (pos_type const &x, real_type const t) const -> tensor_type override
auto	in_domain (pos_type const &, real_type const) const -> bool override
auto	g (real_type const) const -> real_type
auto	k () -> real_type &
auto	k () const
auto	A () -> real_type &
auto	A () const
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_A
Real	m_k

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 Real >

using tatooine::analytical::numerical::rayleigh_benard_convection< Real >::parent_type = vectorfield<this_type, Real, 3>

real_type

template<typename Real >

using tatooine::analytical::numerical::rayleigh_benard_convection< Real >::real_type = Real

this_type

template<typename Real >

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

Constructor & Destructor Documentation

rayleigh_benard_convection() [1/4]

template<typename Real >

tatooine::analytical::numerical::rayleigh_benard_convection< Real >::rayleigh_benard_convection ( )

inline

rayleigh_benard_convection() [2/4]

template<typename Real >

tatooine::analytical::numerical::rayleigh_benard_convection< Real >::rayleigh_benard_convection ( real_type  A, real_type  k  )

inline

rayleigh_benard_convection() [3/4]

template<typename Real >

tatooine::analytical::numerical::rayleigh_benard_convection< Real >::rayleigh_benard_convection ( rayleigh_benard_convection< Real > const &  )

default

rayleigh_benard_convection() [4/4]

template<typename Real >

tatooine::analytical::numerical::rayleigh_benard_convection< Real >::rayleigh_benard_convection ( rayleigh_benard_convection< Real > &&  )

defaultnoexcept

Member Function Documentation

A() [1/2]

template<typename Real >

auto tatooine::analytical::numerical::rayleigh_benard_convection< Real >::A ( ) -> real_type&

inline

A() [2/2]

template<typename Real >

auto tatooine::analytical::numerical::rayleigh_benard_convection< Real >::A ( ) const

inline

evaluate()

template<typename Real >

auto tatooine::analytical::numerical::rayleigh_benard_convection< Real >::evaluate ( pos_type const &  x, real_type const  t  ) const -> tensor_type

inlineoverridevirtual

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

g()

template<typename Real >

auto tatooine::analytical::numerical::rayleigh_benard_convection< Real >::g ( real_type const  ) const -> real_type

inline

in_domain()

template<typename Real >

auto tatooine::analytical::numerical::rayleigh_benard_convection< Real >::in_domain ( pos_type const &  , real_type const    ) const -> bool

inlineoverride

k() [1/2]

template<typename Real >

auto tatooine::analytical::numerical::rayleigh_benard_convection< Real >::k ( ) -> real_type&

inline

k() [2/2]

template<typename Real >

auto tatooine::analytical::numerical::rayleigh_benard_convection< Real >::k ( ) const

inline

operator=() [1/2]

template<typename Real >

auto tatooine::analytical::numerical::rayleigh_benard_convection< Real >::operator= ( rayleigh_benard_convection< Real > &&  ) -> rayleigh_benard_convection< real_type > &=default

defaultnoexcept

operator=() [2/2]

template<typename Real >

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

default

Member Data Documentation

m_A

template<typename Real >

Real tatooine::analytical::numerical::rayleigh_benard_convection< Real >::m_A

private

m_k

template<typename Real >

Real tatooine::analytical::numerical::rayleigh_benard_convection< Real >::m_k

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/rayleigh_benard_convection.h