Planetary Orbital Evolution due to Tides
Orbital evolution of two objects experiencing tides
DissipationQuantities.h File Reference

Declaration of enumerations of dissipation quantities and derivatives. More...

#include "../Core/SharedLibraryExportMacros.h"
#include <ostream>
#include <cassert>
+ Include dependency graph for DissipationQuantities.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

 Evolve
 Orientations of zones of bodies in a binary system.
 
 Evolve::Dissipation
 Isolates constants related to the tidal dissipation.
 

Functions

LIB_LOCAL bool Evolve::zone_specific (Dissipation::QuantityEntry entry)
 
std::ostream & Evolve::operator<< (std::ostream &os, const Dissipation::Quantity &quantity)
 More civilized output for Dissipation::Quantity variables. More...
 
std::ostream & Evolve::operator<< (std::ostream &os, Dissipation::QuantityEntry entry)
 More civilized output for Dissipation::QuantityEntry variables. More...
 

Variables

 POWER
 
 TORQUEX
 
 TORQUEY
 
 TORQUEZ
 
 SEMIMAJOR_DECAY
 Minus the rate of change of the semimajor axis in AU/Gyr. More...
 
 ORBIT_SPINUP
 The rate of change of the orbital frequency in rad/day/Gyr. More...
 
 INCLINATION_DECAY
 
 ECCENTRICITY_DECAY
 The rate at which the eccentricity decays per Gyr. More...
 
 NO_DERIV
 The quantity itself, undifferentiated. More...
 
 AGE
 The derivative w.r.t. age, excluding the dependence through the body's radius and the moments of inertia, but including all else. More...
 
 SPIN_FREQUENCY
 The derivative w.r.t. the spin frequency of a dissipating zone. More...
 
 ORBITAL_FREQUENCY
 The derivative w.r.t. the orbital frequency. More...
 
 END_PHASE_LAG_DERIV
 The above derivatives exist for modified phase lags, below do not. More...
 
 INCLINATION = END_PHASE_LAG_DERIV
 
 ECCENTRICITY
 The derivative w.r.t. the eccentricity. More...
 
 END_DIMENSIONLESS_DERIV
 
 PERIAPSIS = END_DIMENSIONLESS_DERIV
 
 RADIUS
 The derivative w.r.t. the radius of the body in \(R_\odot\). More...
 
 MOMENT_OF_INERTIA
 
 SPIN_ANGMOM
 The derivative w.r.t. the spin angular momentum in \(M_\odot R_\odot^2 rad/day\). More...
 
 SEMIMAJOR
 The derivative w.r.t. the semimajor axis in AU. More...
 
 NUM_DERIVATIVES
 The total number of derivatives supported. More...
 
 EXPANSION_ERROR = NUM_DERIVATIVES
 

Detailed Description

Declaration of enumerations of dissipation quantities and derivatives.

Definition in file DissipationQuantities.h.

Variable Documentation

◆ AGE

AGE

The derivative w.r.t. age, excluding the dependence through the body's radius and the moments of inertia, but including all else.

The full age derivative can be reconstructed later by adding the radius derivative times the rate of change of the radius and similarly for the moments of inertia of the zones involved.

Definition at line 63 of file DissipationQuantities.h.

◆ ECCENTRICITY

ECCENTRICITY

The derivative w.r.t. the eccentricity.

Definition at line 88 of file DissipationQuantities.h.

◆ ECCENTRICITY_DECAY

ECCENTRICITY_DECAY

The rate at which the eccentricity decays per Gyr.

Definition at line 27 of file DissipationQuantities.h.

◆ END_DIMENSIONLESS_DERIV

END_DIMENSIONLESS_DERIV

All derivatives above are available for dimensionless powers and torques and those below are not.

Definition at line 88 of file DissipationQuantities.h.

◆ END_PHASE_LAG_DERIV

END_PHASE_LAG_DERIV

The above derivatives exist for modified phase lags, below do not.

Definition at line 63 of file DissipationQuantities.h.

◆ EXPANSION_ERROR

EXPANSION_ERROR = NUM_DERIVATIVES

The error due to truncating the eccentricity series to finite order.

Definition at line 124 of file DissipationQuantities.h.

◆ INCLINATION

INCLINATION = END_PHASE_LAG_DERIV

The derivative w.r.t. the angle between the spin angular momentum of the body and the orbital angular momentum.

Definition at line 88 of file DissipationQuantities.h.

◆ INCLINATION_DECAY

INCLINATION_DECAY

The rate of decrease of the the angle between the spin angular momentum of the body and the orbital angular momentum. In units of \(\frac{M_\odot R_\odot^2 rad}{day\,Gyr}\).

Definition at line 27 of file DissipationQuantities.h.

◆ MOMENT_OF_INERTIA

MOMENT_OF_INERTIA

The derivative w.r.t. the moment of inertia of the zone in \(M_\odot R_\odot^2\).

Holding the angular momentum constant.

Definition at line 99 of file DissipationQuantities.h.

◆ NO_DERIV

NO_DERIV

The quantity itself, undifferentiated.

Identifier for not differentiating the phase lag.

Definition at line 63 of file DissipationQuantities.h.

◆ NUM_DERIVATIVES

NUM_DERIVATIVES

The total number of derivatives supported.

Definition at line 99 of file DissipationQuantities.h.

◆ ORBIT_SPINUP

ORBIT_SPINUP

The rate of change of the orbital frequency in rad/day/Gyr.

Definition at line 27 of file DissipationQuantities.h.

◆ ORBITAL_FREQUENCY

ORBITAL_FREQUENCY

The derivative w.r.t. the orbital frequency.

Definition at line 63 of file DissipationQuantities.h.

◆ PERIAPSIS

The derivative w.r.t. the argument of periapsis of the orbit in the equatorial plane a given zone.

Definition at line 99 of file DissipationQuantities.h.

◆ POWER

POWER

The rate at which energy is deposited into the body. Units: \(\frac{M_\odot R_\odot^2 rad^2}{day^2\,Gyr}\)

Definition at line 27 of file DissipationQuantities.h.

◆ SEMIMAJOR

SEMIMAJOR

The derivative w.r.t. the semimajor axis in AU.

Definition at line 99 of file DissipationQuantities.h.

◆ SEMIMAJOR_DECAY

SEMIMAJOR_DECAY

Minus the rate of change of the semimajor axis in AU/Gyr.

Definition at line 27 of file DissipationQuantities.h.

◆ SPIN_ANGMOM

SPIN_ANGMOM

The derivative w.r.t. the spin angular momentum in \(M_\odot R_\odot^2 rad/day\).

Holding the moment of inertia constant but not the spin frequency.

Definition at line 99 of file DissipationQuantities.h.

◆ SPIN_FREQUENCY

SPIN_FREQUENCY

The derivative w.r.t. the spin frequency of a dissipating zone.

Holding the moment of inertia constant.

Definition at line 63 of file DissipationQuantities.h.

◆ TORQUEX

TORQUEX

The torque exerted on the body in the x direction. Units: \(\frac{M_\odot R_\odot^2 rad}{day\,Gyr}\).

Definition at line 27 of file DissipationQuantities.h.

◆ TORQUEY

TORQUEY

The torque exerted on the body in the y direction. Units: \(\frac{M_\odot R_\odot^2 rad}{day\,Gyr}\).

Definition at line 27 of file DissipationQuantities.h.

◆ TORQUEZ

TORQUEZ

The torque exerted on the body in the z direction. Units: \(\frac{M_\odot R_\odot^2 rad}{day\,Gyr}\).

Definition at line 27 of file DissipationQuantities.h.