Planetary Orbital Evolution due to Tides
Orbital evolution of two objects experiencing tides
YRECHeader Class Reference

A class which parses the header of a YREC evolution track. More...

#include <YRECIO.h>

+ Collaboration diagram for YRECHeader:

Public Member Functions

 YRECHeader (std::ifstream &track, const std::string &filename)
 Parse the header information from the given track stream. More...
 
double get_mass () const
 The stellar mass (in \(M_\odot\)) of the track. More...
 
int get_age_col () const
 The column index within the track that contains the track ages. More...
 
int get_radius_col () const
 The column index within the track that contains the stellar radii. More...
 
int get_log_luminosity_col () const
 The column index within the track that contains the lg(luminosity). More...
 
int get_envelope_mass_col () const
 The column index for the envelope mass. More...
 
int get_core_boundary_col () const
 The column index for the convective-radiative boundary radius. More...
 
int get_rad_inertia_col () const
 The column index for the moment of inertia of the radiative core. More...
 
int get_conv_inertia_col () const
 The column index for the moment of inertia of the convective envelope. More...
 

Private Attributes

double track_mass
 The masss of the tracks provided on construction in \(M_\odot\). More...
 
int age_col
 The index of the age column in the track. More...
 
int radius_col
 The index of the radius column in the track. More...
 
int envelope_mass_col
 The index of the mass in the convective envelope column in the track. More...
 
int rad_conv_boundary_col
 The index of the core-envelope boundary column in the track. More...
 
int rad_inertia_col
 The index of the radiative core inertia column in the track. More...
 
int conv_inertia_col
 The index of the convective envelope inertia column in the track. More...
 
int log_luminosity_col
 The index of the lg(luminosity) column in the track. More...
 

Detailed Description

A class which parses the header of a YREC evolution track.

Definition at line 30 of file YRECIO.h.

Constructor & Destructor Documentation

◆ YRECHeader()

YRECHeader::YRECHeader ( std::ifstream &  track,
const std::string &  filename 
)

Parse the header information from the given track stream.

Definition at line 56 of file YRECIO.cpp.

Member Function Documentation

◆ get_age_col()

int YRECHeader::get_age_col ( ) const
inline

The column index within the track that contains the track ages.

Definition at line 61 of file YRECIO.h.

◆ get_conv_inertia_col()

int YRECHeader::get_conv_inertia_col ( ) const
inline

The column index for the moment of inertia of the convective envelope.

Definition at line 79 of file YRECIO.h.

◆ get_core_boundary_col()

int YRECHeader::get_core_boundary_col ( ) const
inline

The column index for the convective-radiative boundary radius.

Definition at line 73 of file YRECIO.h.

◆ get_envelope_mass_col()

int YRECHeader::get_envelope_mass_col ( ) const
inline

The column index for the envelope mass.

Definition at line 70 of file YRECIO.h.

◆ get_log_luminosity_col()

int YRECHeader::get_log_luminosity_col ( ) const
inline

The column index within the track that contains the lg(luminosity).

Definition at line 67 of file YRECIO.h.

◆ get_mass()

double YRECHeader::get_mass ( ) const
inline

The stellar mass (in \(M_\odot\)) of the track.

Definition at line 58 of file YRECIO.h.

◆ get_rad_inertia_col()

int YRECHeader::get_rad_inertia_col ( ) const
inline

The column index for the moment of inertia of the radiative core.

Definition at line 76 of file YRECIO.h.

◆ get_radius_col()

int YRECHeader::get_radius_col ( ) const
inline

The column index within the track that contains the stellar radii.

Definition at line 64 of file YRECIO.h.

Member Data Documentation

◆ age_col

int YRECHeader::age_col
private

The index of the age column in the track.

Definition at line 35 of file YRECIO.h.

◆ conv_inertia_col

int YRECHeader::conv_inertia_col
private

The index of the convective envelope inertia column in the track.

Definition at line 35 of file YRECIO.h.

◆ envelope_mass_col

int YRECHeader::envelope_mass_col
private

The index of the mass in the convective envelope column in the track.

Definition at line 35 of file YRECIO.h.

◆ log_luminosity_col

int YRECHeader::log_luminosity_col
private

The index of the lg(luminosity) column in the track.

Definition at line 35 of file YRECIO.h.

◆ rad_conv_boundary_col

int YRECHeader::rad_conv_boundary_col
private

The index of the core-envelope boundary column in the track.

Definition at line 35 of file YRECIO.h.

◆ rad_inertia_col

int YRECHeader::rad_inertia_col
private

The index of the radiative core inertia column in the track.

Definition at line 35 of file YRECIO.h.

◆ radius_col

int YRECHeader::radius_col
private

The index of the radius column in the track.

Definition at line 35 of file YRECIO.h.

◆ track_mass

double YRECHeader::track_mass
private

The masss of the tracks provided on construction in \(M_\odot\).

Definition at line 33 of file YRECIO.h.


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