Planetary Orbital Evolution due to Tides
Orbital evolution of two objects experiencing tides
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
Evolve::test_DifferentialEquations Class Reference
Unit Tests

The test suite that compares the differential equations for eccentricity and semimajor axis to literature expansions. More...

#include <testDifferentialEquations.h>

+ Inheritance diagram for Evolve::test_DifferentialEquations:
+ Collaboration diagram for Evolve::test_DifferentialEquations:

Public Member Functions

 test_DifferentialEquations ()
 Create the test suite. More...
 
void test_aligned_equations ()
 Test the a & e differential equations for aligned orbit. More...
 
void test_error_estimate ()
 Test the error estimate of the differential equations. 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 output_rates (const alglib::real_1d_array &eccentricities, const alglib::real_1d_array &expected_semimajor_rate, const alglib::real_1d_array &predicted_semimajor_rate, const alglib::real_1d_array &expected_eccentricity_rate, const alglib::real_1d_array &predicted_eccentricity_rate) const
 Output the predicted/expected semiamjor and eccentricity evolution rates to stdout. More...
 
double zahn77_semimajor_rate_coef (int orbital_frequency_multiplier, int spin_frequency_multiplier, double eccentricity) const
 The Zahn (1977) coefficient for the semimajor evolution rate that corresponds to the given tidal term. More...
 
double zahn77_eccentricity_rate_coef (int orbital_frequency_multiplier, int spin_frequency_multiplier) const
 Same as zahn77_semimajor_rate_coef() but for the eccentricity evolution. More...
 
void check_agreement (const alglib::real_1d_array &x, const alglib::real_1d_array &y1, const alglib::real_1d_array &y2, unsigned agreement_order, unsigned max_order, const std::string &description)
 Check if two given dependencies on x agree up to a given order in x. More...
 

Detailed Description

The test suite that compares the differential equations for eccentricity and semimajor axis to literature expansions.

Definition at line 25 of file testDifferentialEquations.h.

Constructor & Destructor Documentation

◆ test_DifferentialEquations()

Evolve::test_DifferentialEquations::test_DifferentialEquations ( )

Create the test suite.

Definition at line 173 of file testDifferentialEquations.cpp.

Member Function Documentation

◆ check_agreement()

void Evolve::test_DifferentialEquations::check_agreement ( const alglib::real_1d_array &  x,
const alglib::real_1d_array &  y1,
const alglib::real_1d_array &  y2,
unsigned  agreement_order,
unsigned  max_order,
const std::string &  description 
)
private

Check if two given dependencies on x agree up to a given order in x.

Parameters
xThe independent variable.
y1The first dependence on x to compare.
y2The second dependence on x to compare.
agreement_orderThe order up to which the two dependneces must agree.
max_orderThe maximum order of terms included in either dependence.
descriptionA message describing what is being compared.

Definition at line 91 of file testDifferentialEquations.cpp.

◆ output_rates()

void Evolve::test_DifferentialEquations::output_rates ( const alglib::real_1d_array &  eccentricities,
const alglib::real_1d_array &  expected_semimajor_rate,
const alglib::real_1d_array &  predicted_semimajor_rate,
const alglib::real_1d_array &  expected_eccentricity_rate,
const alglib::real_1d_array &  predicted_eccentricity_rate 
) const
private

Output the predicted/expected semiamjor and eccentricity evolution rates to stdout.

Definition at line 12 of file testDifferentialEquations.cpp.

◆ setup()

void Evolve::test_DifferentialEquations::setup ( )
inlineprotected

No fixtures at this time.

Definition at line 89 of file testDifferentialEquations.h.

◆ tear_down()

void Evolve::test_DifferentialEquations::tear_down ( )
inlineprotected

No fixtures at this time.

Definition at line 92 of file testDifferentialEquations.h.

◆ test_aligned_equations()

void Evolve::test_DifferentialEquations::test_aligned_equations ( )

Test the a & e differential equations for aligned orbit.

Definition at line 179 of file testDifferentialEquations.cpp.

◆ test_error_estimate()

void Evolve::test_DifferentialEquations::test_error_estimate ( )

Test the error estimate of the differential equations.

Definition at line 353 of file testDifferentialEquations.cpp.

◆ zahn77_eccentricity_rate_coef()

double Evolve::test_DifferentialEquations::zahn77_eccentricity_rate_coef ( int  orbital_frequency_multiplier,
int  spin_frequency_multiplier 
) const
private

Same as zahn77_semimajor_rate_coef() but for the eccentricity evolution.

Parameters
orbital_frequency_multiplierThe multiple with which the orbital frequnecy enters in the tidal frequency expression for the selected term.
spin_frequency_multiplierThe multiple with which the spin frequnecy enters in the tidal frequency expression for the selected term.

Definition at line 70 of file testDifferentialEquations.cpp.

◆ zahn77_semimajor_rate_coef()

double Evolve::test_DifferentialEquations::zahn77_semimajor_rate_coef ( int  orbital_frequency_multiplier,
int  spin_frequency_multiplier,
double  eccentricity 
) const
private

The Zahn (1977) coefficient for the semimajor evolution rate that corresponds to the given tidal term.

Parameters
orbital_frequency_multiplierThe multiple with which the orbital frequnecy enters in the tidal frequency expression for the selected term.
spin_frequency_multiplierThe multiple with which the spin frequnecy enters in the tidal frequency expression for the selected term.
eccentricityThe eccentricity of the orbit.

Definition at line 46 of file testDifferentialEquations.cpp.

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