Class astrea::astro::OrbitalElementPartials¶

ClassList > astrea > astro > OrbitalElementPartials

Class representing partial derivatives of orbital elements. More...

#include <OrbitalElements.hpp>

Public Functions¶

Type	Name
	OrbitalElementPartials () Default constructor initializing to CartesianPartial elements.
	OrbitalElementPartials (CartesianPartial elements) Constructor initializing with CartesianPartial elements.
	OrbitalElementPartials (KeplerianPartial elements) Constructor initializing with KeplerianPartial elements.
	OrbitalElementPartials (EquinoctialPartial elements) Constructor initializing with EquinoctialPartial elements.
const PartialVariant &	extract () const Extracts the underlying orbital element partials as a variant.
PartialVariant &	extract () Extracts the underlying orbital element partials as a variant.
std::vector< Unitless >	force_to_vector () const Converts the OrbitalElementPartials to a vector of Unitless values.
constexpr std::size_t	index () const Returns the index of the current orbital element partials in the variant.
OrbitalElements	operator* (const Time & time) const Converts the current orbital element partials to a specific type.

Detailed Description¶

This class encapsulates the partial derivatives of orbital elements, allowing for operations such as multiplication by time to obtain Cartesian state vectors.

Public Functions Documentation¶

function OrbitalElementPartials [1/4]¶

Default constructor initializing to CartesianPartial elements.

inline astrea::astro::OrbitalElementPartials::OrbitalElementPartials ()

function OrbitalElementPartials [2/4]¶

Constructor initializing with CartesianPartial elements.

inline astrea::astro::OrbitalElementPartials::OrbitalElementPartials (
    CartesianPartial elements
)

Parameters:

elements The orbital element partials to initialize with.

function OrbitalElementPartials [3/4]¶

Constructor initializing with KeplerianPartial elements.

inline astrea::astro::OrbitalElementPartials::OrbitalElementPartials (
    KeplerianPartial elements
)

Parameters:

elements The orbital element partials to initialize with.

function OrbitalElementPartials [4/4]¶

Constructor initializing with EquinoctialPartial elements.

inline astrea::astro::OrbitalElementPartials::OrbitalElementPartials (
    EquinoctialPartial elements
)

Parameters:

elements The orbital element partials to initialize with.

function extract [1/2]¶

Extracts the underlying orbital element partials as a variant.

const PartialVariant & astrea::astro::OrbitalElementPartials::extract () const

Returns:

const PartialVariant& Reference to the underlying orbital element partials variant.

function extract [2/2]¶

Extracts the underlying orbital element partials as a variant.

PartialVariant & astrea::astro::OrbitalElementPartials::extract ()

Returns:

PartialVariant& Reference to the underlying orbital element partials variant.

function force_to_vector¶

Converts the OrbitalElementPartials to a vector of Unitless values.

std::vector< Unitless > astrea::astro::OrbitalElementPartials::force_to_vector () const

Returns:

std::vector<Unitless> Vector containing the orbital elements as unitless values.

function index¶

Returns the index of the current orbital element partials in the variant.

inline constexpr std::size_t astrea::astro::OrbitalElementPartials::index () const

Returns:

std::size_t The index of the current orbital element partials in the variant.

function operator*¶

Converts the current orbital element partials to a specific type.

OrbitalElements astrea::astro::OrbitalElementPartials::operator* (
    const Time & time
) const

Template parameters:

T The type to convert to.

Parameters:

mu The gravitational parameter to use for the conversion.

Returns:

A reference to the current orbital element partials after conversion.

The documentation for this class was generated from the following file astrea/astro/astro/state/orbital_elements/OrbitalElements.hpp