Planetary Orbital Evolution due to Tides
Orbital evolution of two objects experiencing tides
StellarEvolution::ZeroQuantity Class Reference
+ Inheritance diagram for StellarEvolution::ZeroQuantity:
+ Collaboration diagram for StellarEvolution::ZeroQuantity:

Public Member Functions

void select_interpolation_region (double age)
 Do nothing. See EvolvingStellarQuantity::select_interpolation_region. More...
 
double operator() (double) const
 Return the value the quantity takes at the given age. More...
 
const FunctionDerivativesderiv (double) const
 Return the age derivative of the quantity at the given age. More...
 
double range_high () const
 The largest age for which the quantity can be interpolated. More...
 
double range_low () const
 The smallest age for which the quantity can be interpolated. More...
 
double next_discontinuity () const
 No discontinuities. See EvolvingStellarQuantity::next_discontinuity. More...
 
double enable_next_interpolation_region ()
 Do nothing. See EvolvingStellarQuantity::enable_next_interpolation_region. More...
 
InterpSolutionIterator crossings (double=0) const
 An iterator over the ages where the quantity takes the given y value. More...
 
- Public Member Functions inherited from StellarEvolution::EvolvingStellarQuantity
 EvolvingStellarQuantity ()
 Default constructor (only useful for derived classes which do not use the interpolation). More...
 
 EvolvingStellarQuantity (double mass, const std::valarray< double > &track_masses, The(\f$[Fe/H]\f$) for which evolution tracks are given. const std::valarray< double > &track_feh, The evolution tracks of the relevant quantity on the grid defined by \p track_masses and \p track_feh. The const std::vector< const OneArgumentDiffFunction *> &evolution_tracks, Whether the track uses log(age) as the independent argument instead of age. bool log_age=true, Whether the track is uses log(quantity) as the dependent argument instead of quantity. bool log_quantity=true, Whether this is a quantity that is identically zero below some age and turns on afterwards bool starts_zero=false)
 Create an evolving quantity that interpolates to the given mass. More...
 
brief Prepare the quantity for interpolation around the given age After calling this requesting values or derivatives outside the range of the continuous region containing this age (see ::discontinuities) fails an assert. virtual void select_interpolation_region(double age) const
 
The ages at which the quantity may be virtual discontinuous const std::vector< double > & discontinuities () const
 
An iterator over the ages (in Gyr) where the quantity takes the given y value. InterpSolutionIterator crossings(double=0) const
 
- Public Member Functions inherited from Core::OneArgumentFunction< double, double >
virtual ~OneArgumentFunction ()
 Provide a virtual destructor for a virtual class. More...
 

Additional Inherited Members

- Public Attributes inherited from StellarEvolution::EvolvingStellarQuantity
brief Prepare the quantity for interpolation around the given age After calling this method
 
- Protected Member Functions inherited from StellarEvolution::EvolvingStellarQuantity
virtual double age_to_interp_param (double age, double mass, double feh) const
 Return the interpoltaion parameter given age, mass and [Fe/H]. More...
 
virtual double interp_param_to_age (double interp_param, double mass, double feh) const
 Return the age in Gyrs given an interpolation parameter, mass, and [Fe/H]. More...
 

Detailed Description

Definition at line 16 of file ZeroQuantity.h.

Member Function Documentation

◆ crossings()

InterpSolutionIterator StellarEvolution::ZeroQuantity::crossings ( double  = 0) const
inlinevirtual

An iterator over the ages where the quantity takes the given y value.

Implements Core::OneArgumentFunction< double, double >.

Definition at line 42 of file ZeroQuantity.h.

◆ deriv()

const FunctionDerivatives* StellarEvolution::ZeroQuantity::deriv ( double  ) const
inlinevirtual

Return the age derivative of the quantity at the given age.

Reimplemented from StellarEvolution::EvolvingStellarQuantity.

Definition at line 25 of file ZeroQuantity.h.

◆ enable_next_interpolation_region()

double StellarEvolution::ZeroQuantity::enable_next_interpolation_region ( )

Do nothing. See EvolvingStellarQuantity::enable_next_interpolation_region.

◆ next_discontinuity()

double StellarEvolution::ZeroQuantity::next_discontinuity ( ) const
inline

No discontinuities. See EvolvingStellarQuantity::next_discontinuity.

Definition at line 35 of file ZeroQuantity.h.

◆ operator()()

double StellarEvolution::ZeroQuantity::operator() ( double  ) const
inlinevirtual

Return the value the quantity takes at the given age.

Reimplemented from StellarEvolution::EvolvingStellarQuantity.

Definition at line 22 of file ZeroQuantity.h.

◆ range_high()

double StellarEvolution::ZeroQuantity::range_high ( ) const
inlinevirtual

The largest age for which the quantity can be interpolated.

Reimplemented from StellarEvolution::EvolvingStellarQuantity.

Definition at line 29 of file ZeroQuantity.h.

◆ range_low()

double StellarEvolution::ZeroQuantity::range_low ( ) const
inlinevirtual

The smallest age for which the quantity can be interpolated.

Reimplemented from StellarEvolution::EvolvingStellarQuantity.

Definition at line 32 of file ZeroQuantity.h.

◆ select_interpolation_region()

void StellarEvolution::ZeroQuantity::select_interpolation_region ( double  age)
inline

Do nothing. See EvolvingStellarQuantity::select_interpolation_region.

Definition at line 19 of file ZeroQuantity.h.


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