OrbitalExpressions.h File Reference

A collection of functions which calculate various quantities for two body orbits. More...

#include "../Core/SharedLibraryExportMacros.h"
#include <cmath>
#include "AstronomicalConstants.h"

Include dependency graph for OrbitalExpressions.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
double	Core::orbital_angular_velocity ( double m1, double m2, double semimajor, bool deriv=false)
	Returns the orbital angular velocity of the given orbit in rad/day. More...
double	Core::orbital_energy ( double m1, double m2, double semimajor, unsigned deriv_order=0)
	The energy of the orbit (assuming 0 gravitational potential at infinity) in \(\frac{M_\odot R_\odot^2 rad^2}{day^2}\). More...
double	Core::orbital_angular_momentum ( double m1, double m2, double semimajor, double eccentricity)
	The angular momentum of the orbit in \(\frac{M_\odot R_\odot^2 rad}{day}\). More...
LIB_PUBLIC double	Core::semimajor_from_period ( double m1, double m2, double period)
	Return the semiamjor axis in solar radii required to have the given masses orbit with the given period. More...

Detailed Description

A collection of functions which calculate various quantities for two body orbits.

Definition in file OrbitalExpressions.h.

Function Documentation

orbital_angular_momentum()

LIB_PUBLIC double Core::orbital_angular_momentum	(	double	m1,
		double	m2,
		double	semimajor,
		double	eccentricity
	)

The angular momentum of the orbit in \(\frac{M_\odot R_\odot^2 rad}{day}\).

Parameters

m1	The mass of the first body in \(M_\odot\).
m2	The mass of the second body in \(M_\odot\).
semimajor	The semimajor axis in AU
eccentricity	The eccentricity.

Definition at line 54 of file OrbitalExpressions.cpp.

orbital_angular_velocity()

LIB_PUBLIC double Core::orbital_angular_velocity	(	double	m1,
		double	m2,
		double	semimajor,
		bool	deriv
	)

Returns the orbital angular velocity of the given orbit in rad/day.

Parameters

m1	The mass of the first body in \(M_\odot\).
m2	The mass of the second body in \(M_\odot\).
semimajor	The semimajor axis in \(R_\odot\)
deriv	Whether to return the derivative with respect to the semimajor axis instead of the value.

Definition at line 17 of file OrbitalExpressions.cpp.

orbital_energy()

LIB_PUBLIC double Core::orbital_energy	(	double	m1,
		double	m2,
		double	semimajor,
		unsigned	deriv_order
	)

The energy of the orbit (assuming 0 gravitational potential at infinity) in \(\frac{M_\odot R_\odot^2 rad^2}{day^2}\).

Parameters

m1	The mass of the first body in \(M_\odot\).
m2	The mass of the second body in \(M_\odot\).
semimajor	The semimajor axis in AU
deriv_order	The order of the derivative w.r.t. a required.

Definition at line 38 of file OrbitalExpressions.cpp.

semimajor_from_period()

LIB_PUBLIC double Core::semimajor_from_period	(	double	m1,
		double	m2,
		double	period
	)

Return the semiamjor axis in solar radii required to have the given masses orbit with the given period.

Parameters

m1	The mass of the first body in \(M_\odot\).
m2	The mass of the second body in \(M_\odot\).
period	The orbital period in days

Definition at line 72 of file OrbitalExpressions.cpp.