vulcan::orbital::quantities Namespace Reference

Functions
template<typename Scalar>
Scalar	period (const Scalar &a, double mu=constants::earth::mu)
	Orbital period.
template<typename Scalar>
Scalar	velocity (const Scalar &r, const Scalar &a, double mu=constants::earth::mu)
	Orbital velocity (vis-viva equation).
template<typename Scalar>
Scalar	energy (const Scalar &a, double mu=constants::earth::mu)
	Specific orbital energy.
template<typename Scalar>
Scalar	escape_velocity (const Scalar &r, double mu=constants::earth::mu)
	Escape velocity at given radius.
template<typename Scalar>
Scalar	circular_velocity (const Scalar &r, double mu=constants::earth::mu)
	Circular orbit velocity at given radius.
template<typename Scalar>
Scalar	mean_motion (const Scalar &a, double mu=constants::earth::mu)
	Mean motion.
template<typename Scalar>
Scalar	semi_latus_rectum (const Scalar &a, const Scalar &e)
	Semi-latus rectum.
template<typename Scalar>
Scalar	radius_at_anomaly (const Scalar &a, const Scalar &e, const Scalar &nu)
	Radius at given true anomaly.

Function Documentation

circular_velocity()

template<typename Scalar>

Scalar vulcan::orbital::quantities::circular_velocity	(	const Scalar &	r,
		double	mu = constants::earth::mu )

Circular orbit velocity at given radius.

Template Parameters

Scalar

double or casadi::MX

Parameters

r	Radius [m]
mu	Gravitational parameter [m³/s²] (default: Earth)

Returns

Circular velocity [m/s]

energy()

template<typename Scalar>

Scalar vulcan::orbital::quantities::energy	(	const Scalar &	a,
		double	mu = constants::earth::mu )

Specific orbital energy.

Template Parameters

Scalar

double or casadi::MX

Parameters

a	Semi-major axis [m]
mu	Gravitational parameter [m³/s²] (default: Earth)

Returns

Specific energy [J/kg]

escape_velocity()

template<typename Scalar>

Scalar vulcan::orbital::quantities::escape_velocity	(	const Scalar &	r,
		double	mu = constants::earth::mu )

Escape velocity at given radius.

Template Parameters

Scalar

double or casadi::MX

Parameters

r	Radius [m]
mu	Gravitational parameter [m³/s²] (default: Earth)

Returns

Escape velocity [m/s]

mean_motion()

template<typename Scalar>

Scalar vulcan::orbital::quantities::mean_motion	(	const Scalar &	a,
		double	mu = constants::earth::mu )

Mean motion.

Template Parameters

Scalar

double or casadi::MX

Parameters

a	Semi-major axis [m]
mu	Gravitational parameter [m³/s²] (default: Earth)

Returns

Mean motion [rad/s]

period()

template<typename Scalar>

Scalar vulcan::orbital::quantities::period	(	const Scalar &	a,
		double	mu = constants::earth::mu )

Orbital period.

Template Parameters

Scalar

double or casadi::MX

Parameters

a	Semi-major axis [m]
mu	Gravitational parameter [m³/s²] (default: Earth)

Returns

Period [s]

radius_at_anomaly()

template<typename Scalar>

Scalar vulcan::orbital::quantities::radius_at_anomaly	(	const Scalar &	a,
		const Scalar &	e,
		const Scalar &	nu )

Radius at given true anomaly.

Template Parameters

Scalar

double or casadi::MX

Parameters

a	Semi-major axis [m]
e	Eccentricity [-]
nu	True anomaly [rad]

Returns

Radius [m]

semi_latus_rectum()

template<typename Scalar>

Scalar vulcan::orbital::quantities::semi_latus_rectum	(	const Scalar &	a,
		const Scalar &	e )

Semi-latus rectum.

Template Parameters

Scalar

double or casadi::MX

Parameters

a	Semi-major axis [m]
e	Eccentricity [-]

Returns

Semi-latus rectum [m]

velocity()

template<typename Scalar>

Scalar vulcan::orbital::quantities::velocity	(	const Scalar &	r,
		const Scalar &	a,
		double	mu = constants::earth::mu )

Orbital velocity (vis-viva equation).

Template Parameters

Scalar

double or casadi::MX

Parameters

r	Current radius [m]
a	Semi-major axis [m]
mu	Gravitational parameter [m³/s²] (default: Earth)

Returns

Velocity magnitude [m/s]