Basic description of two bodies in an eccentric orbit. More...

#include <EccentricOrbit.h>

Collaboration diagram for Evolve::EccentricOrbit:

Public Member Functions
	EccentricOrbit (double primary_mass=Core::NaN, double secondary_mass=Core::NaN, double semimajor=Core::NaN, double eccentricity=Core::NaN)
	Create an eccentric orbit. More...

double	primary_mass () const
	The semimajor axis of the system. More...

double &	primary_mass ()
	A mutable reference to the semimajor axis of the system. More...

double	secondary_mass () const
	The semimajor axis of the system. More...

double &	secondary_mass ()
	A mutable reference to the semimajor axis of the system. More...

double	semimajor () const
	The semimajor axis of the system. More...

double &	semimajor ()
	A mutable reference to the semimajor axis of the system. More...

double	eccentricity () const
	The semimajor axis of the system. More...

double &	eccentricity ()
	A mutable reference to the semimajor axis of the system. More...

double	eccentric_anomaly (double orbital_phase) const

Eigen::Vector3d	secondary_position (double orbital_phase) const
	Secondary position vector in a coordinate system centered on the primary, with \( \hat{z} = \hat{L} \) and \( \hat{y} = \hat{S} \times \hat{L} \). More...

double	orbital_angmom () const
	The magnitude of the orbital angular momentum of the system in \( M_\odot R_\odot^2 \mathrm{rad} / \mathrm{Gyr} \). More...

double	orbital_energy () const
	The magnitude of the orbital energy of the system in \( M_\odot R_\odot^2 / \mathrm{Gyr}^2 \). More...

double	orbital_period () const
	The orbital period of the system in days. More...

Private Member Functions
double	reduced_mass () const
	The reduced mass of the system in solar masses. More...

Private Attributes
double	__primary_mass
	The mass of the tidally perturbed object in solar masses. More...

double	__secondary_mass
	The mass of the perturber object in solar masses. More...

double	__semimajor
	The semimajor axis of the orbit in solar radii. More...

double	__eccentricity
	The eccentricity of the orbit. More...

Detailed Description

Basic description of two bodies in an eccentric orbit.

Definition at line 24 of file EccentricOrbit.h.

Constructor & Destructor Documentation

◆ EccentricOrbit()

Evolve::EccentricOrbit::EccentricOrbit	(	double	primary_mass = `Core::NaN`,
		double	secondary_mass = `Core::NaN`,
		double	semimajor = `Core::NaN`,
		double	eccentricity = `Core::NaN`
	)

inline

Create an eccentric orbit.

Parameters

primary_mass	See __primary_mass attribute.
secondary_mass	See __secondary_mass attribute.
semimajor	See __semimajor attribute.
eccentricity	See __eccentricity attribute.

Definition at line 44 of file EccentricOrbit.h.

Member Function Documentation

◆ eccentric_anomaly()

double Evolve::EccentricOrbit::eccentric_anomaly ( double orbital_phase ) const

The eccentric anomaly that corresponds to the given orbital phase angle.

Parameters

orbital_phase The phase angle of the orbit ( \( \Omega t \)). Zero is at periapsis

Definition at line 36 of file EccentricOrbit.cpp.

◆ eccentricity() [1/2]

double Evolve::EccentricOrbit::eccentricity ( ) const

inline

The semimajor axis of the system.

Definition at line 82 of file EccentricOrbit.h.

◆ eccentricity() [2/2]

double& Evolve::EccentricOrbit::eccentricity ( )

inline

A mutable reference to the semimajor axis of the system.

Definition at line 85 of file EccentricOrbit.h.

◆ orbital_angmom()

double Evolve::EccentricOrbit::orbital_angmom ( ) const

The magnitude of the orbital angular momentum of the system in \( M_\odot R_\odot^2 \mathrm{rad} / \mathrm{Gyr} \).

Definition at line 103 of file EccentricOrbit.cpp.

◆ orbital_energy()

double Evolve::EccentricOrbit::orbital_energy ( ) const

The magnitude of the orbital energy of the system in \( M_\odot R_\odot^2 / \mathrm{Gyr}^2 \).

Definition at line 116 of file EccentricOrbit.cpp.

◆ orbital_period()

double Evolve::EccentricOrbit::orbital_period ( ) const

The orbital period of the system in days.

Definition at line 129 of file EccentricOrbit.cpp.

◆ primary_mass() [1/2]

double Evolve::EccentricOrbit::primary_mass ( ) const

inline

The semimajor axis of the system.

Definition at line 64 of file EccentricOrbit.h.

◆ primary_mass() [2/2]

double& Evolve::EccentricOrbit::primary_mass ( )

inline

A mutable reference to the semimajor axis of the system.

Definition at line 67 of file EccentricOrbit.h.

◆ reduced_mass()

double Evolve::EccentricOrbit::reduced_mass ( ) const

private

The reduced mass of the system in solar masses.

Definition at line 27 of file EccentricOrbit.cpp.

◆ secondary_mass() [1/2]

double Evolve::EccentricOrbit::secondary_mass ( ) const

inline

The semimajor axis of the system.

Definition at line 70 of file EccentricOrbit.h.

◆ secondary_mass() [2/2]

double& Evolve::EccentricOrbit::secondary_mass ( )

inline

A mutable reference to the semimajor axis of the system.

Definition at line 73 of file EccentricOrbit.h.

◆ secondary_position()

Eigen::Vector3d Evolve::EccentricOrbit::secondary_position ( double orbital_phase ) const

Secondary position vector in a coordinate system centered on the primary, with \( \hat{z} = \hat{L} \) and \( \hat{y} = \hat{S} \times \hat{L} \).

Parameters

orbital_phase See same name argument to eccentric_anomaly().

Definition at line 87 of file EccentricOrbit.cpp.

◆ semimajor() [1/2]

double Evolve::EccentricOrbit::semimajor ( ) const

inline

The semimajor axis of the system.

Definition at line 76 of file EccentricOrbit.h.

◆ semimajor() [2/2]

double& Evolve::EccentricOrbit::semimajor ( )

inline

A mutable reference to the semimajor axis of the system.

Definition at line 79 of file EccentricOrbit.h.

Member Data Documentation

◆ __eccentricity

double Evolve::EccentricOrbit::__eccentricity

private

The eccentricity of the orbit.

Definition at line 28 of file EccentricOrbit.h.

◆ __primary_mass

double Evolve::EccentricOrbit::__primary_mass

private

The mass of the tidally perturbed object in solar masses.

Definition at line 28 of file EccentricOrbit.h.

◆ __secondary_mass

double Evolve::EccentricOrbit::__secondary_mass

private

The mass of the perturber object in solar masses.

Definition at line 28 of file EccentricOrbit.h.

◆ __semimajor

double Evolve::EccentricOrbit::__semimajor

private

The semimajor axis of the orbit in solar radii.

Definition at line 28 of file EccentricOrbit.h.

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

/home/kpenev/projects/git/poet/poet_src/unit_tests/testEvolve/EccentricOrbit.h
/home/kpenev/projects/git/poet/poet_src/unit_tests/testEvolve/EccentricOrbit.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EccentricOrbit()

Member Function Documentation

◆ eccentric_anomaly()

◆ eccentricity() [1/2]

◆ eccentricity() [2/2]

◆ orbital_angmom()

◆ orbital_energy()

◆ orbital_period()

◆ primary_mass() [1/2]

◆ primary_mass() [2/2]

◆ reduced_mass()

◆ secondary_mass() [1/2]

◆ secondary_mass() [2/2]

◆ secondary_position()

◆ semimajor() [1/2]

◆ semimajor() [2/2]

Member Data Documentation

◆ __eccentricity

◆ __primary_mass

◆ __secondary_mass

◆ __semimajor