#include <src/particles/tide-particles.hpp>
template<typename TypeSystem>
hub::particles::TideParticles class

Structure of Array point particle group.

Template parameters
TypeSystem The type system in spaceHub(hub::Types).

Contents

Public types

using Particle = TideParticle<Vector>
Embedded Particle type.

Constructors, destructors, conversion operators

TideParticles() defaulted
TideParticles(TideParticles const&) defaulted
TideParticles(TideParticles&&) defaulted
template<typename STL>
TideParticles(Scalar t, STL const& particle_set)
Construct a new Point Particles object from std::ranges(Container)

Public functions

auto operator=(TideParticles const&) -> TideParticles& defaulted
auto operator=(TideParticles&&) -> TideParticles& defaulted
auto time() -> StateScalar& noexcept
auto time() const -> StateScalar const & noexcept
auto mass() -> ScalarArray& noexcept
auto mass() const -> ScalarArray const & noexcept
auto mass(size_t i) -> ScalarArray ::value_type& noexcept
auto mass(size_t i) const -> ScalarArray ::value_type const & noexcept
auto radius() -> ScalarArray& noexcept
auto radius() const -> ScalarArray const & noexcept
auto radius(size_t i) -> ScalarArray ::value_type& noexcept
auto radius(size_t i) const -> ScalarArray ::value_type const & noexcept
auto idn() -> IdxArray& noexcept
auto idn() const -> IdxArray const & noexcept
auto idn(size_t i) -> IdxArray ::value_type& noexcept
auto idn(size_t i) const -> IdxArray ::value_type const & noexcept
auto pos() -> StateVectorArray& noexcept
auto pos() const -> StateVectorArray const & noexcept
auto pos(size_t i) -> StateVectorArray ::value_type& noexcept
auto pos(size_t i) const -> StateVectorArray ::value_type const & noexcept
auto vel() -> StateVectorArray& noexcept
auto vel() const -> StateVectorArray const & noexcept
auto vel(size_t i) -> StateVectorArray ::value_type& noexcept
auto vel(size_t i) const -> StateVectorArray ::value_type const & noexcept
auto tide_apsidal_const() -> ScalarArray& noexcept
auto tide_apsidal_const() const -> ScalarArray const & noexcept
auto tide_apsidal_const(size_t i) -> ScalarArray ::value_type& noexcept
auto tide_apsidal_const(size_t i) const -> ScalarArray ::value_type const & noexcept
auto tide_lag_time() -> ScalarArray& noexcept
auto tide_lag_time() const -> ScalarArray const & noexcept
auto tide_lag_time(size_t i) -> ScalarArray ::value_type& noexcept
auto tide_lag_time(size_t i) const -> ScalarArray ::value_type const & noexcept

Function documentation

template<typename TypeSystem>
hub::particles::TideParticles<TypeSystem>::TideParticles() defaulted

Default constructor.

template<typename TypeSystem>
hub::particles::TideParticles<TypeSystem>::TideParticles(TideParticles const&) defaulted

Default copy constructor.

template<typename TypeSystem>
hub::particles::TideParticles<TypeSystem>::TideParticles(TideParticles&&) defaulted

Default move constructor

template<typename TypeSystem> template<typename STL>
hub::particles::TideParticles<TypeSystem>::TideParticles(Scalar t, STL const& particle_set)

Construct a new Point Particles object from std::ranges(Container)

Template parameters
STL std::ranges(Container)
Parameters
t in Initial time of the the particle group.
particle_set in Input particle set.

template<typename TypeSystem>
TideParticles& hub::particles::TideParticles<TypeSystem>::operator=(TideParticles const&) defaulted

Default copy assignment operator

template<typename TypeSystem>
TideParticles& hub::particles::TideParticles<TypeSystem>::operator=(TideParticles&&) defaulted

Default move assignment operator

template<typename TypeSystem>
StateScalar& hub::particles::TideParticles<TypeSystem>::time() noexcept

The setter interface of member time_ in name of time.

template<typename TypeSystem>
StateScalar const & hub::particles::TideParticles<TypeSystem>::time() const noexcept

The getter interface of member time_ in name of time.

template<typename TypeSystem>
ScalarArray& hub::particles::TideParticles<TypeSystem>::mass() noexcept

The setter interface of member mass_ in name of mass.

template<typename TypeSystem>
ScalarArray const & hub::particles::TideParticles<TypeSystem>::mass() const noexcept

The getter interface of member mass_ in name of mass.

template<typename TypeSystem>
ScalarArray ::value_type& hub::particles::TideParticles<TypeSystem>::mass(size_t i) noexcept

The setter interface of member mass_ in name of mass.

template<typename TypeSystem>
ScalarArray ::value_type const & hub::particles::TideParticles<TypeSystem>::mass(size_t i) const noexcept

The getter interface of member mass_ in name of mass.

template<typename TypeSystem>
ScalarArray& hub::particles::TideParticles<TypeSystem>::radius() noexcept

The setter interface of member radius_ in name of radius.

template<typename TypeSystem>
ScalarArray const & hub::particles::TideParticles<TypeSystem>::radius() const noexcept

The getter interface of member radius_ in name of radius.

template<typename TypeSystem>
ScalarArray ::value_type& hub::particles::TideParticles<TypeSystem>::radius(size_t i) noexcept

The setter interface of member radius_ in name of radius.

template<typename TypeSystem>
ScalarArray ::value_type const & hub::particles::TideParticles<TypeSystem>::radius(size_t i) const noexcept

The getter interface of member radius_ in name of radius.

template<typename TypeSystem>
IdxArray& hub::particles::TideParticles<TypeSystem>::idn() noexcept

The setter interface of member idn_ in name of idn.

template<typename TypeSystem>
IdxArray const & hub::particles::TideParticles<TypeSystem>::idn() const noexcept

The getter interface of member idn_ in name of idn.

template<typename TypeSystem>
IdxArray ::value_type& hub::particles::TideParticles<TypeSystem>::idn(size_t i) noexcept

The setter interface of member idn_ in name of idn.

template<typename TypeSystem>
IdxArray ::value_type const & hub::particles::TideParticles<TypeSystem>::idn(size_t i) const noexcept

The getter interface of member idn_ in name of idn.

template<typename TypeSystem>
StateVectorArray& hub::particles::TideParticles<TypeSystem>::pos() noexcept

The setter interface of member pos_ in name of pos.

template<typename TypeSystem>
StateVectorArray const & hub::particles::TideParticles<TypeSystem>::pos() const noexcept

The getter interface of member pos_ in name of pos.

template<typename TypeSystem>
StateVectorArray ::value_type& hub::particles::TideParticles<TypeSystem>::pos(size_t i) noexcept

The setter interface of member pos_ in name of pos.

template<typename TypeSystem>
StateVectorArray ::value_type const & hub::particles::TideParticles<TypeSystem>::pos(size_t i) const noexcept

The getter interface of member pos_ in name of pos.

template<typename TypeSystem>
StateVectorArray& hub::particles::TideParticles<TypeSystem>::vel() noexcept

The setter interface of member vel_ in name of vel.

template<typename TypeSystem>
StateVectorArray const & hub::particles::TideParticles<TypeSystem>::vel() const noexcept

The getter interface of member vel_ in name of vel.

template<typename TypeSystem>
StateVectorArray ::value_type& hub::particles::TideParticles<TypeSystem>::vel(size_t i) noexcept

The setter interface of member vel_ in name of vel.

template<typename TypeSystem>
StateVectorArray ::value_type const & hub::particles::TideParticles<TypeSystem>::vel(size_t i) const noexcept

The getter interface of member vel_ in name of vel.

template<typename TypeSystem>
ScalarArray& hub::particles::TideParticles<TypeSystem>::tide_apsidal_const() noexcept

The setter interface of member k_AM_ in name of tide_apsidal_const.

template<typename TypeSystem>
ScalarArray const & hub::particles::TideParticles<TypeSystem>::tide_apsidal_const() const noexcept

The getter interface of member k_AM_ in name of tide_apsidal_const.

template<typename TypeSystem>
ScalarArray ::value_type& hub::particles::TideParticles<TypeSystem>::tide_apsidal_const(size_t i) noexcept

The setter interface of member k_AM_ in name of tide_apsidal_const.

template<typename TypeSystem>
ScalarArray ::value_type const & hub::particles::TideParticles<TypeSystem>::tide_apsidal_const(size_t i) const noexcept

The getter interface of member k_AM_ in name of tide_apsidal_const.

template<typename TypeSystem>
ScalarArray& hub::particles::TideParticles<TypeSystem>::tide_lag_time() noexcept

The setter interface of member tau_lag_ in name of tide_lag_time.

template<typename TypeSystem>
ScalarArray const & hub::particles::TideParticles<TypeSystem>::tide_lag_time() const noexcept

The getter interface of member tau_lag_ in name of tide_lag_time.

template<typename TypeSystem>
ScalarArray ::value_type& hub::particles::TideParticles<TypeSystem>::tide_lag_time(size_t i) noexcept

The setter interface of member tau_lag_ in name of tide_lag_time.

template<typename TypeSystem>
ScalarArray ::value_type const & hub::particles::TideParticles<TypeSystem>::tide_lag_time(size_t i) const noexcept

The getter interface of member tau_lag_ in name of tide_lag_time.