Evaluate the tidal potential using the expansion. More...

#include <TidalPotentialExpansion.h>

Collaboration diagram for Evolve::TidalPotentialExpansion:

Public Member Functions
	TidalPotentialExpansion (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)

double	evaluate_spherical_coords (double radial_distance, double azimuthal_angle, double polar_angle, double time, int expansion_order)

template<class POSITION_TYPE >
double	operator() (const POSITION_TYPE &position, double time, int expansion_order)
	Return the tidal potential at a specific position and time in SI. More...

double	get_expansion_precision () const
	Return the expansion precision target for the expansion terms. More...

Private Member Functions
double	tidal_term (int mprime, double radial_distance, double azimuthal_angle, double polar_angle, double orbital_phase) const
	Return a single tidal term: \( \Sum_{m=-2}^{2} \mathcal{U}_{m,m'} \rho'%2 Y_{2,m}(\theta', \phi')\exp(-im'\Omega t) \). More...

Private Attributes
TidalPotentialTerms	__expansion_coef
	The coefficients of the expansion of the tidal potential. ( \( \mathcal{U}_{m,m'} \)) More...

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...

double	__inclination

double	__arg_of_periapsis

Detailed Description

Evaluate the tidal potential using the expansion.

Definition at line 21 of file TidalPotentialExpansion.h.

Constructor & Destructor Documentation

◆ TidalPotentialExpansion()

Evolve::TidalPotentialExpansion::TidalPotentialExpansion	(	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

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 same name argument to TidalPotential.
arg_of_periapsis	See same name argument to TidalPotential.

Definition at line 69 of file TidalPotentialExpansion.h.

Member Function Documentation

◆ evaluate_spherical_coords()

double Evolve::TidalPotentialExpansion::evaluate_spherical_coords	(	double	radial_distance,
		double	azimuthal_angle,
		double	polar_angle,
		double	time,
		int	expansion_order
	)

Return the tidal potential at a specific position in polar coordinates and time in seconds.

Parameters

radial_distance	The radial distance from the origin of the point to where to evaluate the tidal potential.
azimuthal_angle	The azimuthal angle of the point to where to evaluate the tidal potential, should be in the range of \( [0, 2\pi) \).
polar_angle	The polar angle of the point to where to evaluate the tidal potential, should be in the range of \( [0, \pi] \).
time	The time in second since periastron passage. It is perfectly valid to pass values bigger than the orbital period.
expansion_order	The maximum Fourier term to include in the expansion

Definition at line 51 of file TidalPotentialExpansion.cpp.

◆ get_expansion_precision()

double Evolve::TidalPotentialExpansion::get_expansion_precision ( ) const

inline

Return the expansion precision target for the expansion terms.

Definition at line 140 of file TidalPotentialExpansion.h.

◆ operator()()

template<class POSITION_TYPE >

double Evolve::TidalPotentialExpansion::operator()	(	const POSITION_TYPE &	position,
		double	time,
		int	expansion_order
	)

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.
expansion_order	The maximum Fourier term to include in the expansion

Definition at line 147 of file TidalPotentialExpansion.h.

◆ tidal_term()

double Evolve::TidalPotentialExpansion::tidal_term	(	int	mprime,
		double	radial_distance,
		double	azimuthal_angle,
		double	polar_angle,
		double	orbital_phase
	)		const

private

Return a single tidal term: \( \Sum_{m=-2}^{2} \mathcal{U}_{m,m'} \rho'%2 Y_{2,m}(\theta', \phi')\exp(-im'\Omega t) \).

Parameters

mprime	The value of m' in the expression evaluated by this function.
radial_distance	See same name argument to evaluate_spherical_coords()
azimuthal_angle	See same name argument to evaluate_spherical_coords()
polar_angle	See same name argument to evaluate_spherical_coords()
orbital_phase	The orbital phase of the secondary body ( \( 2 \pi n - argument_of_periapsis\) is periapsis).

Definition at line 12 of file TidalPotentialExpansion.cpp.

Member Data Documentation

◆ __arg_of_periapsis

double Evolve::TidalPotentialExpansion::__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 29 of file TidalPotentialExpansion.h.

◆ __eccentricity

double Evolve::TidalPotentialExpansion::__eccentricity

private

The eccentricity of the orbit.

Definition at line 29 of file TidalPotentialExpansion.h.

◆ __expansion_coef

TidalPotentialTerms Evolve::TidalPotentialExpansion::__expansion_coef

private

The coefficients of the expansion of the tidal potential. ( \( \mathcal{U}_{m,m'} \))

Definition at line 25 of file TidalPotentialExpansion.h.

◆ __inclination

double Evolve::TidalPotentialExpansion::__inclination

private

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

Definition at line 29 of file TidalPotentialExpansion.h.

◆ __primary_mass

double Evolve::TidalPotentialExpansion::__primary_mass

private

The mass of the tidally perturbed object in solar masses.

Definition at line 29 of file TidalPotentialExpansion.h.

◆ __secondary_mass

double Evolve::TidalPotentialExpansion::__secondary_mass

private

The mass of the perturber object in solar masses.

Definition at line 29 of file TidalPotentialExpansion.h.

◆ __semimajor

double Evolve::TidalPotentialExpansion::__semimajor

private

The semimajor axis of the orbit in solar radii.

Definition at line 29 of file TidalPotentialExpansion.h.

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

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TidalPotentialExpansion()

Member Function Documentation

◆ evaluate_spherical_coords()

◆ get_expansion_precision()

◆ operator()()

◆ tidal_term()

Member Data Documentation

◆ __arg_of_periapsis

◆ __eccentricity

◆ __expansion_coef

◆ __inclination

◆ __primary_mass

◆ __secondary_mass

◆ __semimajor