Orbit class container. More...

#include <Orbit.hh>

Public Member Functions
	Orbit ()
	Orbit (Orbit const &)=default
	Orbit (Orbit &&)=default
Orbit &	operator= (const Orbit &)=default
Orbit &	operator= (Orbit &&)=default
Cartesian const &	cartesian () const
void	set_cartesian (Real r_x, Real r_y, Real r_z, Real v_x, Real v_y, Real v_z)
void	set_cartesian (Vector3 const &t_r, Vector3 const &t_v)
void	set_cartesian (Vector6 const &t_cart)
void	set_cartesian (Cartesian const &t_cart)
Keplerian const &	keplerian () const
void	set_keplerian (Real const t_a, Real const t_e, Real const t_i, Real const t_Omega, Real const t_omega, Real const nu)
void	set_keplerian (Vector5 const &t_kepl, Real const nu)
void	set_keplerian (Keplerian const &t_kepl, Real const nu)
Equinoctial const &	equinoctial () const
void	set_equinoctial (Real const t_p, Real const t_f, Real const t_g, Real const t_h, Real const t_k, Real const L)
void	set_equinoctial (Vector5 const &t_equi, Real const L)
void	set_equinoctial (Equinoctial const &t_equi, Real const L)
Quaternionic const &	quaternionic () const
void	set_quaternionic (Real const t_q_1, Real const t_q_2, Real const t_q_3, Real const t_q_4)
void	set_quaternionic (Quaternion const &t_quat)
Type	type () const
void	set_type (Real const e)
Factor	factor () const
void	set_factor (Factor t_factor)
Real	mu () const
void	set_mu (Real const t_mu)
std::string	info () const
void	info (std::ostream &os)
void	reset ()
bool	sanity_check () const
Rotation	keplerian_to_reference () const
Rotation	equinoctial_to_reference () const
Vector3	cartesian_rtn_to_xyz (Vector3 const &r, Vector3 const &v, Vector3 const &vec) const
Vector3	equinoctial_rtn_to_xyz (Vector3 const &vec) const

Protected Attributes
Cartesian	m_cart
Keplerian	m_kepl
Equinoctial	m_equi
Quaternionic	m_quat
Type	m_type {Type::UNDEFINED}
Factor	m_factor {Factor::UNDEFINED}
Real	m_mu {QUIET_NAN}

Private Types
using	Cartesian = OrbitalElements::Cartesian
using	Keplerian = OrbitalElements::Keplerian
using	Equinoctial = OrbitalElements::Equinoctial
using	Quaternionic = OrbitalElements::Quaternionic
using	Anomaly = OrbitalElements::Anomaly

Detailed Description

The Orbit class container is used to store the orbital elements of an object in space. The class provides methods for setting and getting the orbital elements in various representations, such as cartesian, keplerian, equinoctial, and quaternionic. The class also provides methods for converting between these representations.

Member Typedef Documentation

◆ Anomaly

using Astro::Orbit::Anomaly = OrbitalElements::Anomaly

private

◆ Cartesian

using Astro::Orbit::Cartesian = OrbitalElements::Cartesian

private

◆ Equinoctial

using Astro::Orbit::Equinoctial = OrbitalElements::Equinoctial

private

◆ Keplerian

using Astro::Orbit::Keplerian = OrbitalElements::Keplerian

private

◆ Quaternionic

using Astro::Orbit::Quaternionic = OrbitalElements::Quaternionic

private

Constructor & Destructor Documentation

◆ Orbit() [1/3]

Astro::Orbit::Orbit ( )

inline

Class constructor for the astro object.

◆ Orbit() [2/3]

Astro::Orbit::Orbit ( Orbit const & )

default

Enable the default astro copy constructor.

◆ Orbit() [3/3]

Astro::Orbit::Orbit ( Orbit && )

default

Enable the default astro move constructor.

Member Function Documentation

◆ cartesian()

Cartesian const & Astro::Orbit::cartesian ( ) const

inline

Get the cartesian orbital elements.

Returns: The cartesian orbital elements.

◆ cartesian_rtn_to_xyz()

Vector3 Astro::Orbit::cartesian_rtn_to_xyz	(	Vector3 const &	r,
		Vector3 const &	v,
		Vector3 const &	vec ) const

inline

Compute the Frenet-Serret frame of the orbit (radial, tangential, normal) given the cartesian orbital elements.

Parameters

[in]	r	The position vector $ \mathbf{r} $.
[in]	v	The velocity vector $ \mathbf{v} \f $. \return The Frenet-Serret frame of the orbit. / Rotation cartesian_to_frenet_rtn(Vector3 const & r, Vector3 const & v) const { // Check if the input vectors are valid ASTRO_ASSERT(r.allFinite() && v.allFinite(), "Astro::Orbit::cartesian_to_frenet_rtn(...): invalid input vectors detected."); // Initialize the Frenet-Serret frame Rotation rtn; // Compute the radial vector rtn.col(0) = r; rtn.col(0).normalize(); // Compute the binormal vector rtn.col(2) = r.cross(v); rtn.col(2).normalize(); // Compute the tangential vector rtn.col(1) = rtn.col(2).cross(r); rtn.col(1).normalize(); // Return the Frenet-Serret frame return rtn; } /* Compute the Frenet-Serret frame of the orbit (radial, tangential, normal) through the equinoctial orbital elements. \param[in] L The true longitude $ L $. \return The Frenet-Serret frame of the orbit. / Rotation equinoctial_to_frenet_rtn(Real const L) const { Real h{this->m_equi.h}; Real k{this->m_equi.k}; Real c_L{std::cos(L)}; Real s_L{std::sin(L)}; Real h2{hh}; Real k2{kk}; Real hk{hk}; Real bf{1.0+h2+k2}; Real I{static_cast<Real>(this->m_factor)}; Rotation R; R << ((h2-k2+1)c_L+2.0Ihks_L)/bf, ((k2-h2-1.0)s_L+2.0hkIc_L)/bf, 2.0k/bf, (2.0hkc_L-I(h2-k2-1.0)s_L)/bf, (I(1.0+k2-h2)c_L-2.0hks_L)/bf, -2.0h/bf, (2.0(hs_L-c_LkI))/bf, (2.0kIs_L+2.0hc_L)/bf, I(1-h2-k2)/bf; return R; } /** Transform a vector in the Frent-Serret frame of the orbit (radial, tangential, normal) to a vector in the cartesian frame given the cartesian orbital elements. \param[in] r The position vector $ \mathbf{r} $. \param[in] v The velocity vector $ \mathbf{v} \f $.
[in]	vec	The vector in Frenet-Serret frame.

Returns: The vector in the cartesian frame.

◆ equinoctial()

Equinoctial const & Astro::Orbit::equinoctial ( ) const

inline

Get the equinoctial orbital elements.

Returns: The equinoctial orbital elements.

◆ equinoctial_rtn_to_xyz()

Vector3 Astro::Orbit::equinoctial_rtn_to_xyz ( Vector3 const & vec ) const

inline

Transform a vector in the Frent-Serret frame of the orbit (radial, tangential, normal) to a vector in the cartesian frame through the equinoctial orbital elements.

Parameters

[in] vec The vector in Frenet-Serret frame.

Returns: The vector in the cartesian frame.

◆ equinoctial_to_reference()

Rotation Astro::Orbit::equinoctial_to_reference ( ) const

inline

Compute the rotation matrix of the orbital plane through the equinoctial orbital elements.

Returns: The rotation matrix of the orbital plane.

◆ factor()

Factor Astro::Orbit::factor ( ) const

inline

Get the posigrade (+1)/retrograde (-1) factor $ I $.

Returns: The posigrade (+1)/retrograde (-1) factor $ I $.

◆ info() [1/2]

std::string Astro::Orbit::info ( ) const

inline

Print the orbit information on a string.

Returns: The orbit information string.

◆ info() [2/2]

void Astro::Orbit::info ( std::ostream & os )

inline

Print the orbit information on a stream.

Parameters

[in,out] os Output stream.

◆ keplerian()

Keplerian const & Astro::Orbit::keplerian ( ) const

inline

Get the keplerian orbital elements.

Returns: The keplerian orbital elements.

◆ keplerian_to_reference()

Rotation Astro::Orbit::keplerian_to_reference ( ) const

inline

Compute the rotation matrix of the orbital plane through the keplerian orbital elements.

Returns: The rotation matrix of the orbital plane.

◆ mu()

Real Astro::Orbit::mu ( ) const

inline

Get the gravitational constant of the central body.

Returns: The gravitational constant of the central body.

◆ operator=() [1/2]

Orbit & Astro::Orbit::operator= ( const Orbit & )

default

Enable the default astro assignment operator.

◆ operator=() [2/2]

Orbit & Astro::Orbit::operator= ( Orbit && )

default

Enable the default astro move assignment operator.

◆ quaternionic()

Quaternionic const & Astro::Orbit::quaternionic ( ) const

inline

Get the quaternionic orbital elements.

Returns: The quaternionic orbital elements.

◆ reset()

void Astro::Orbit::reset ( )

inline

Reset the orbit parameters to undefined values.

◆ sanity_check()

bool Astro::Orbit::sanity_check ( ) const

inline

Check if the orbit can accept the cartesian orbital elements, i.e., if factor, type, an the gravitational constant are set.

Returns: True if the orbit can accept the cartesian orbital elements, false otherwise.

Note: This mathods throws an error if the orbit is not valid.

◆ set_cartesian() [1/4]

void Astro::Orbit::set_cartesian ( Cartesian const & t_cart )

inline

Set the cartesian orbital elements.

Parameters

[in] t_cart The cartesian orbital elements.

◆ set_cartesian() [2/4]

void Astro::Orbit::set_cartesian	(	Real	r_x,
		Real	r_y,
		Real	r_z,
		Real	v_x,
		Real	v_y,
		Real	v_z )

inline

Set the cartesian orbital elements.

Parameters

[in]	r_x	Position vector $ x $-axis component.
[in]	r_y	Position vector $ y $-axis component.
[in]	r_z	Position vector $ z $-axis component.
[in]	v_x	Velocity vector $ x $-axis component.
[in]	v_y	Velocity vector $ y $-axis component.
[in]	v_z	Velocity vector $ z $-axis component.

◆ set_cartesian() [3/4]

void Astro::Orbit::set_cartesian	(	Vector3 const &	t_r,
		Vector3 const &	t_v )

inline

Set the cartesian orbital elements.

Parameters

[in]	t_r	The position vector $ \mathbf{r} $.
[in]	t_v	The velocity vector $ \mathbf{v} $.

◆ set_cartesian() [4/4]

void Astro::Orbit::set_cartesian ( Vector6 const & t_cart )

inline

Set the cartesian orbital elements.

Parameters

[in] t_cart The vector of cartesian orbital elements $ [r_x, r_y, r_z, v_x, v_y, v_z]^\top $.

Note: The vector $ t_{\text{cartesian}} $ must have 6 elements.

◆ set_equinoctial() [1/3]

void Astro::Orbit::set_equinoctial	(	Equinoctial const &	t_equi,
		Real const	L )

inline

Set the equinoctial orbital elements.

Parameters

[in]	t_equi	The equinoctial orbital elements.
[in]	L	The true longitude $ L $.

◆ set_equinoctial() [2/3]

void Astro::Orbit::set_equinoctial	(	Real const	t_p,
		Real const	t_f,
		Real const	t_g,
		Real const	t_h,
		Real const	t_k,
		Real const	L )

inline

Set the (modified) equinoctial orbit parameters.

Parameters

[in]	t_p	The semi-latus rectum $ p $.
[in]	t_f	The $ x $-axis component of the eccentricity vector in the orbital frame.
[in]	t_g	The $ y $-axis component of the eccentricity vector in the orbital frame.
[in]	t_h	The $ x $-axis component of the node vector in the orbital frame.
[in]	t_k	The $ y $-axis component of the node vector in the orbital frame.
[in]	L	The true longitude $ L $.

◆ set_equinoctial() [3/3]

void Astro::Orbit::set_equinoctial	(	Vector5 const &	t_equi,
		Real const	L )

inline

Set the (modified) equinoctial orbit parameters.

Parameters

[in]	t_equi	The vector of equinoctial orbit parameters $ [p, f, g, h, k]^\top $.
[in]	L	The true longitude $ L $.

Note: The vector $ t_{\text{equinoctial}} $ must have 5 elements.

◆ set_factor()

void Astro::Orbit::set_factor ( Factor t_factor )

inline

Set the posigrade (+1)/retrograde (-1) factor $ I $.

Parameters

[in] t_factor The posigrade (+1)/retrograde (-1) factor $ I $.

◆ set_keplerian() [1/3]

void Astro::Orbit::set_keplerian	(	Keplerian const &	t_kepl,
		Real const	nu )

inline

Set the keplerian orbital elements.

Parameters

[in]	t_kepl	The keplerian orbital elements.
[in]	nu	The true anomaly $ \nu $.

◆ set_keplerian() [2/3]

void Astro::Orbit::set_keplerian	(	Real const	t_a,
		Real const	t_e,
		Real const	t_i,
		Real const	t_Omega,
		Real const	t_omega,
		Real const	nu )

inline

Set the keplerian orbital elements.

Parameters

[in]	t_a	The semi-major axis $ a $.
[in]	t_e	The eccentricity $ e $.
[in]	t_i	The inclination $ i $.
[in]	t_Omega	The longitude of the ascending node $ \Omega $.
[in]	t_omega	The argument of periapsis $ \omega $.
[in]	nu	The true anomaly $ \nu $.

◆ set_keplerian() [3/3]

void Astro::Orbit::set_keplerian	(	Vector5 const &	t_kepl,
		Real const	nu )

inline

Set the keplerian orbital elements.

Parameters

[in]	t_kepl	The vector of keplerian orbital elements $ [a, e, i, \Omega, \omega]^\top $.
[in]	nu	The true anomaly $ \nu $.

Note: The vector $ t_{\text{keplerian}} $ must have 5 elements.

◆ set_mu()

void Astro::Orbit::set_mu ( Real const t_mu )

inline

Set the gravitational constant of the central body.

Parameters

[in] t_mu The gravitational constant of the central body.

◆ set_quaternionic() [1/2]

void Astro::Orbit::set_quaternionic ( Quaternion const & t_quat )

inline

Set the quaternionic orbital elements.

Parameters

[in] t_quat The quaternion vector.

◆ set_quaternionic() [2/2]

void Astro::Orbit::set_quaternionic	(	Real const	t_q_1,
		Real const	t_q_2,
		Real const	t_q_3,
		Real const	t_q_4 )

inline

Set the quaternionic orbital elements.

Parameters

[in]	t_q_1	The first quaternionic orbit parameter.
[in]	t_q_2	The second quaternionic orbit parameter.
[in]	t_q_3	The third quaternionic orbit parameter.
[in]	t_q_4	The fourth quaternionic orbit parameter.

◆ set_type()

void Astro::Orbit::set_type ( Real const e )

inline

Set the type of the orbit.

Parameters

[in] e The eccentricity of the orbit.

◆ type()

Type Astro::Orbit::type ( ) const

inline

Get the type of the orbit.

Returns: The type of the orbit.

Member Data Documentation

◆ m_cart

Cartesian Astro::Orbit::m_cart

protected

Cartesian orbit parameters.

◆ m_equi

Equinoctial Astro::Orbit::m_equi

protected

Equinoctial orbit parameters.

◆ m_factor

Factor Astro::Orbit::m_factor {Factor::UNDEFINED}

protected

Orbit posigrade (+1)/retrograde (-1) factor.

◆ m_kepl

Keplerian Astro::Orbit::m_kepl

protected

Keplerian orbit parameters.

◆ m_mu

Real Astro::Orbit::m_mu {QUIET_NAN}

protected

Gravitational constant of the central body.

◆ m_quat

Quaternionic Astro::Orbit::m_quat

protected

Quaternionic orbit parameters.

◆ m_type

Type Astro::Orbit::m_type {Type::UNDEFINED}

protected

Orbit type.

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

include/Astro/Orbit.hh

[in]	r	The position vector \( \mathbf{r} \).
[in]	v	The velocity vector \( \mathbf{v} \f $. \return The Frenet-Serret frame of the orbit. / Rotation cartesian_to_frenet_rtn(Vector3 const & r, Vector3 const & v) const { // Check if the input vectors are valid ASTRO_ASSERT(r.allFinite() && v.allFinite(), "Astro::Orbit::cartesian_to_frenet_rtn(...): invalid input vectors detected."); // Initialize the Frenet-Serret frame Rotation rtn; // Compute the radial vector rtn.col(0) = r; rtn.col(0).normalize(); // Compute the binormal vector rtn.col(2) = r.cross(v); rtn.col(2).normalize(); // Compute the tangential vector rtn.col(1) = rtn.col(2).cross(r); rtn.col(1).normalize(); // Return the Frenet-Serret frame return rtn; } /* Compute the Frenet-Serret frame of the orbit (radial, tangential, normal) through the equinoctial orbital elements. \param[in] L The true longitude \) L \(. \return The Frenet-Serret frame of the orbit. / Rotation equinoctial_to_frenet_rtn(Real const L) const { Real h{this->m_equi.h}; Real k{this->m_equi.k}; Real c_L{std::cos(L)}; Real s_L{std::sin(L)}; Real h2{hh}; Real k2{kk}; Real hk{hk}; Real bf{1.0+h2+k2}; Real I{static_cast<Real>(this->m_factor)}; Rotation R; R << ((h2-k2+1)c_L+2.0Ihks_L)/bf, ((k2-h2-1.0)s_L+2.0hkIc_L)/bf, 2.0k/bf, (2.0hkc_L-I(h2-k2-1.0)s_L)/bf, (I(1.0+k2-h2)c_L-2.0hks_L)/bf, -2.0h/bf, (2.0(hs_L-c_LkI))/bf, (2.0kIs_L+2.0hc_L)/bf, I(1-h2-k2)/bf; return R; } /** Transform a vector in the Frent-Serret frame of the orbit (radial, tangential, normal) to a vector in the cartesian frame given the cartesian orbital elements. \param[in] r The position vector \) \mathbf{r} \(. \param[in] v The velocity vector \) \mathbf{v} \f $.
[in]	vec	The vector in Frenet-Serret frame.

[in]	r_x	Position vector \( x \)-axis component.
[in]	r_y	Position vector \( y \)-axis component.
[in]	r_z	Position vector \( z \)-axis component.
[in]	v_x	Velocity vector \( x \)-axis component.
[in]	v_y	Velocity vector \( y \)-axis component.
[in]	v_z	Velocity vector \( z \)-axis component.

[in]	t_p	The semi-latus rectum \( p \).
[in]	t_f	The \( x \)-axis component of the eccentricity vector in the orbital frame.
[in]	t_g	The \( y \)-axis component of the eccentricity vector in the orbital frame.
[in]	t_h	The \( x \)-axis component of the node vector in the orbital frame.
[in]	t_k	The \( y \)-axis component of the node vector in the orbital frame.
[in]	L	The true longitude \( L \).

[in]	t_a	The semi-major axis \( a \).
[in]	t_e	The eccentricity \( e \).
[in]	t_i	The inclination \( i \).
[in]	t_Omega	The longitude of the ascending node \( \Omega \).
[in]	t_omega	The argument of periapsis \( \omega \).
[in]	nu	The true anomaly \( \nu \).

Public Member Functions

Protected Attributes

Private Types

Detailed Description

Member Typedef Documentation

◆ Anomaly

◆ Cartesian

◆ Equinoctial

◆ Keplerian

◆ Quaternionic

Constructor & Destructor Documentation

◆ Orbit() [1/3]

◆ Orbit() [2/3]

◆ Orbit() [3/3]

Member Function Documentation

◆ cartesian()

◆ cartesian_rtn_to_xyz()

◆ equinoctial()

◆ equinoctial_rtn_to_xyz()

◆ equinoctial_to_reference()

◆ factor()

◆ info() [1/2]

◆ info() [2/2]

◆ keplerian()

◆ keplerian_to_reference()

◆ mu()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ quaternionic()

◆ reset()

◆ sanity_check()

◆ set_cartesian() [1/4]

◆ set_cartesian() [2/4]

◆ set_cartesian() [3/4]

◆ set_cartesian() [4/4]

◆ set_equinoctial() [1/3]

◆ set_equinoctial() [2/3]

◆ set_equinoctial() [3/3]

◆ set_factor()

◆ set_keplerian() [1/3]

◆ set_keplerian() [2/3]

◆ set_keplerian() [3/3]

◆ set_mu()

◆ set_quaternionic() [1/2]

◆ set_quaternionic() [2/2]

◆ set_type()

◆ type()

Member Data Documentation

◆ m_cart

◆ m_equi

◆ m_factor

◆ m_kepl

◆ m_mu

◆ m_quat

◆ m_type