The test suite that compares the tidal potential expansion to the exact expression. More...

#include <testGravitationalPotential.h>

Inheritance diagram for Evolve::test_GravitationalPotential:

Collaboration diagram for Evolve::test_GravitationalPotential:

Public Member Functions
	test_GravitationalPotential ()
	Create the test suite. More...

void	test_expansion ()
	Test the expansion of the potential for multiple system configurations, locations and times. More...

Protected Member Functions
void	setup ()
	No fixtures at this time. More...

void	tear_down ()
	No fixtures at this time. More...

Private Member Functions
void	print_orbit (const EccentricOrbit &orbit) const
	Print to stdout the location of the secondary relative to the primary as a function of time for the given orbit. More...

void	print_tidal_potential (double primary_mass, double secondary_mass, double semimajor, double eccentricity, double inclination, double arg_of_periapsis, const Eigen::Vector3d &position, unsigned e_order) const
	Print to stdout the value of the tidal potential without an approximation and using the expansion as a function of time. More...

double	abs_expected_precision (const Eigen::Vector3d &position, const EccentricOrbit &orbit) const

void	test_single_point (TidalPotentialExpansion &approx_potential, const TidalPotential &exact_potential, const Eigen::Vector3d &position)
	Test the expansion for a given system at a given position, sampling time. More...

void	test_system (double primary_mass, double secondary_mass, double semimajor, double eccentricity, double inclination, double arg_of_periapsis, unsigned e_order=0)
	Test the expansion for a given system, sampling positions and times. More...

Detailed Description

The test suite that compares the tidal potential expansion to the exact expression.

Definition at line 28 of file testGravitationalPotential.h.

Constructor & Destructor Documentation

◆ test_GravitationalPotential()

Evolve::test_GravitationalPotential::test_GravitationalPotential ( )

Create the test suite.

Definition at line 238 of file testGravitationalPotential.cpp.

Member Function Documentation

◆ abs_expected_precision()

double Evolve::test_GravitationalPotential::abs_expected_precision	(	const Eigen::Vector3d &	position,
		const EccentricOrbit &	orbit
	)		const

private

The expected absolute precision in the potential expansion for the given orbit.

Parameters

position	The position where the potential expansion will be evaluated.
orbit	The orbit for which the potential expansion is being tested.

Definition at line 86 of file testGravitationalPotential.cpp.

◆ print_orbit()

void Evolve::test_GravitationalPotential::print_orbit ( const EccentricOrbit & orbit ) const

private

Print to stdout the location of the secondary relative to the primary as a function of time for the given orbit.

Definition at line 12 of file testGravitationalPotential.cpp.

◆ print_tidal_potential()

void Evolve::test_GravitationalPotential::print_tidal_potential	(	double	primary_mass,
		double	secondary_mass,
		double	semimajor,
		double	eccentricity,
		double	inclination,
		double	arg_of_periapsis,
		const Eigen::Vector3d &	position,
		unsigned	e_order
	)		const

private

Print to stdout the value of the tidal potential without an approximation and using the expansion as a function of time.

Parameters

primary_mass	See same name argument to TidalPotential constructor.
secondary_mass	See same name argument to TidalPotential constructor.
semimajor	See same name argument to TidalPotential constructor.
eccentricity	See same name argument to TidalPotential constructor.
inclination	See same name argument to TidalPotential constructor.
arg_of_periapsis	See same name argument to TidalPotential constructor.
position	The position where to test for agreement between the two potentials, in the coordinate system expected by the potentials..
e_order	The eccentricity expansion order to use.

Definition at line 31 of file testGravitationalPotential.cpp.

◆ setup()

void Evolve::test_GravitationalPotential::setup ( )

inlineprotected

No fixtures at this time.

Definition at line 113 of file testGravitationalPotential.h.

◆ tear_down()

void Evolve::test_GravitationalPotential::tear_down ( )

inlineprotected

No fixtures at this time.

Definition at line 116 of file testGravitationalPotential.h.

◆ test_expansion()

void Evolve::test_GravitationalPotential::test_expansion ( )

Test the expansion of the potential for multiple system configurations, locations and times.

Definition at line 201 of file testGravitationalPotential.cpp.

◆ test_single_point()

void Evolve::test_GravitationalPotential::test_single_point	(	TidalPotentialExpansion &	approx_potential,
		const TidalPotential &	exact_potential,
		const Eigen::Vector3d &	position
	)

private

Test the expansion for a given system at a given position, sampling time.

Parameters

approx_potential	The tidal potential expansion to test.
exact_potential	The exact potential expected for the system.
position	The position where to test for agreement between the two potentials, in the coordinate system expected by the potentials..

Definition at line 116 of file testGravitationalPotential.cpp.

◆ test_system()

void Evolve::test_GravitationalPotential::test_system	(	double	primary_mass,
		double	secondary_mass,
		double	semimajor,
		double	eccentricity,
		double	inclination,
		double	arg_of_periapsis,
		unsigned	e_order = `0`
	)

private

Test the expansion for a given system, sampling positions and times.

Parameters

primary_mass	See same name argument to TidalPotential constructor.
secondary_mass	See same name argument to TidalPotential constructor.
semimajor	See same name argument to TidalPotential constructor.
eccentricity	See same name argument to TidalPotential constructor.
inclination	See same name argument to TidalPotential constructor.
arg_of_periapsis	See same name argument to TidalPotential constructor.
e_order	The eccentricity expansion order to use.

Definition at line 164 of file testGravitationalPotential.cpp.

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

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

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ test_GravitationalPotential()

Member Function Documentation

◆ abs_expected_precision()

◆ print_orbit()

◆ print_tidal_potential()

◆ setup()

◆ tear_down()

◆ test_expansion()

◆ test_single_point()

◆ test_system()