Evolve::TidalPotential Class Reference

Calculate the tidal potential over one component of an eccentric binary. More...

#include <TidalPotential.h>

Collaboration diagram for Evolve::TidalPotential:

Public Member Functions
	TidalPotential (double primary_mass=Core::NaN, double secondary_mass=Core::NaN, double semimajor=Core::NaN, double eccentricity=Core::NaN, double inclination=Core::NaN, double arg_of_periapsis=Core::NaN)
	Define the boundary for which to calculate the tidal potential. More...
double	inclination () const
	See __inclination attribute. More...
double &	inclination ()
	A mutable reference to the inclination of the system. More...
double	arg_of_periapsis () const
	The argument of periapsis of the system. More...
double &	arg_of_periapsis ()
	A mutable reference to the argument of periapsis of the system. More...
const EccentricOrbit &	orbit () const
	An unmutable reference to the binary orbit. More...
EccentricOrbit &	orbit ()
	Mutable reference to the binary orbit. More...
template<class POSITION_TYPE >
double	operator() (const POSITION_TYPE &position, double time) const
	Return the tidal potential at a specific position and time in SI. More...

Private Attributes
EccentricOrbit	__orbit
	The binary orbit. More...
double	__inclination
double	__arg_of_periapsis

Detailed Description

Calculate the tidal potential over one component of an eccentric binary.

Definition at line 17 of file TidalPotential.h.

Constructor & Destructor Documentation

TidalPotential()

Evolve::TidalPotential::TidalPotential ( double  primary_mass = Core::NaN, double  secondary_mass = Core::NaN, double  semimajor = Core::NaN, double  eccentricity = Core::NaN, double  inclination = Core::NaN, double  arg_of_periapsis = Core::NaN  )

inline

Define the boundary for which to calculate the tidal potential.

Parameters

primary_mass	See same name argument to EccentricOrbit.
secondary_mass	See same name argument to EccentricOrbit.
semimajor	See same name argument to EccentricOrbit.
eccentricity	See same name argument to EccentricOrbit.
inclination	See __inclination attribute.
arg_of_periapsis	See __arg_of_periapsis attribute.

Definition at line 35 of file TidalPotential.h.

Member Function Documentation

arg_of_periapsis() [1/2]

double Evolve::TidalPotential::arg_of_periapsis ( ) const

inline

The argument of periapsis of the system.

Definition at line 66 of file TidalPotential.h.

arg_of_periapsis() [2/2]

double& Evolve::TidalPotential::arg_of_periapsis ( )

inline

A mutable reference to the argument of periapsis of the system.

Definition at line 69 of file TidalPotential.h.

inclination() [1/2]

double Evolve::TidalPotential::inclination ( ) const

inline

See __inclination attribute.

Definition at line 60 of file TidalPotential.h.

inclination() [2/2]

double& Evolve::TidalPotential::inclination ( )

inline

A mutable reference to the inclination of the system.

Definition at line 63 of file TidalPotential.h.

operator()()

template<class POSITION_TYPE >

double Evolve::TidalPotential::operator()	(	const POSITION_TYPE &	position,
		double	time
	)		const

Return the tidal potential at a specific position and time in SI.

Parameters

position

The position to evaluate the potential at in a coordinate system centered on the primary body with \( \hat{z} = \hat{S} \), \( \hat{y} = \hat{S} \times \hat{L} \).

Must provide indexing with indices 0, 1, 2 for the three components.

Parameters

time	The time in days when to evalutae the tidal potential. The system is in periapsis at time = 0.

Definition at line 96 of file TidalPotential.h.

orbit() [1/2]

const EccentricOrbit& Evolve::TidalPotential::orbit ( ) const

inline

An unmutable reference to the binary orbit.

Definition at line 72 of file TidalPotential.h.

orbit() [2/2]

EccentricOrbit& Evolve::TidalPotential::orbit ( )

inline

Mutable reference to the binary orbit.

Definition at line 75 of file TidalPotential.h.

Member Data Documentation

__arg_of_periapsis

double Evolve::TidalPotential::__arg_of_periapsis

private

90 degrees less than the angle from \( \hat{y} = \hat{S} \times \hat{L} \) to the direction of periapsis in radians.

Definition at line 25 of file TidalPotential.h.

__inclination

double Evolve::TidalPotential::__inclination

private

The angle between the orbital angular momentum and the spin angular momentum of the primary.;

Definition at line 25 of file TidalPotential.h.

__orbit

EccentricOrbit Evolve::TidalPotential::__orbit

private

The binary orbit.

Definition at line 20 of file TidalPotential.h.

---

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

• /home/kpenev/projects/git/poet/poet_src/unit_tests/testEvolve/TidalPotential.h