Surface convective zone for low mass evolving stars or the entire star for high mass stars. More...

#include <EvolvingStellarEnvelope.h>

Inheritance diagram for Star::EvolvingStellarEnvelope:

Collaboration diagram for Star::EvolvingStellarEnvelope:

Public Member Functions
	EvolvingStellarEnvelope (double stellar_mass, const StellarEvolution::EvolvingStellarQuantity outer_radius=NULL, const StellarEvolution::EvolvingStellarQuantity moment_of_inertia=NULL)

double	moment_of_inertia (double age, int deriv_order=0) const
	See DissipatingZone::moment_of_inertia(double, int) More...

double	moment_of_inertia (int deriv_order=0) const
	See DissipatingZone::moment_of_inertia(int). More...

double	outer_radius (double age, int deriv_order=0) const
	See DissipatingZone::outer_radius(double, int). More...

double	outer_radius (int deriv_order=0) const
	See DissipatingZone::outer_radius(int). More...

double	outer_mass (double, int deriv_order=0) const
	See DissipatingZone::outer_mass(double, int). More...

double	outer_mass (int deriv_order=0) const
	See DissipatingZone::outer_mass. More...

Public Member Functions inherited from Star::EvolvingStellarZone
	EvolvingStellarZone (std::initializer_list< const StellarEvolution::EvolvingStellarQuantity * > evolving_quantities)

virtual void	configure (bool initialize, double age, double orbital_frequency, double eccentricity, double orbital_angmom, double spin, double inclination, double periapsis, bool spin_is_frequency)
	Defines the current orbit, triggering re-calculation of all quantities. More...

double	current_age_quantity (size_t quantity, unsigned deriv_order=0) const
	The current age value of the given quantity (or its derivative). More...

double	any_age_quantity (size_t quantity, double age, unsigned deriv_order=0) const
	The value of the given quantity (or its derivative) at an arbitrary age. More...

double	current_age ()
	Return the last age with which ::configure() was called. More...

void	reached_critical_age (double age)
	Change the body as necessary at the given age. More...

double	next_stop_age () const
	The next age when the evolution needs to be stopped for a change in one of the bodies. More...

double	min_interp_age () const
	The minimum age at wich zone quantities can be querried. More...

virtual void	select_interpolation_region (double age) const
	Prepare the zone quantities for interpolation around the given age. More...

	~EvolvingStellarZone ()
	Delete any dynamically allocated memory. More...

Public Member Functions inherited from Evolve::BrokenPowerlawPhaseLagZone
	BrokenPowerlawPhaseLagZone ()
	Create a non-dissipative zone. Must call setup() if the zone is dissipative. More...

void	setup (const std::vector< double > &tidal_frequency_breaks, const std::vector< double > &spin_frequency_breaks, const std::vector< double > &tidal_frequency_powers, const std::vector< double > &spin_frequency_powers, double reference_phase_lag, double inertial_mode_enhancement=1.0, double inertial_mode_sharpness=10.0)
	Seup the zone with the given breaks/powers and inertial mode enhancement. Continuous accress all breaks. Must only be called before use. More...

virtual double	modified_phase_lag (int orbital_frequency_multiplier, int spin_frequency_multiplier, double forcing_frequency, Dissipation::QuantityEntry entry, double &above_lock_value) const
	Should return the tidal phase lag times the love number for the given tidal term (or one of its derivatives). More...

virtual double	love_coefficient (int, int, Dissipation::QuantityEntry) const
	Should return the corresponding component of the love coefficient (Lai 2012 Equation 24). More...

virtual CombinedStoppingCondition *	stopping_conditions (BinarySystem &system, bool primary, unsigned zone_index)
	Conditions detecting the next possible discontinuities in the evolution due to this zone. More...

virtual void	change_e_order (unsigned new_e_order, BinarySystem &system, bool primary, unsigned zone_index)
	Changes the order of the eccentricity expansion performed. More...

virtual bool	dissipative () const
	Return true iff disspation has been defined for the zone. More...

virtual bool	can_lock () const
	Should return true iff the zone's dissipation is discontinuous at zero frequency. More...

	~BrokenPowerlawPhaseLagZone ()
	Cleanup. More...

Public Member Functions inherited from Evolve::DissipatingZone
void	set_evolution_rates (double angular_momentum, double inclination, double periapsis)
	Set evolution rates for this zone's properties for storing in the eveloution. More...

double	forcing_frequency (int orbital_frequency_multiplier, int spin_frequency_multiplier, double orbital_frequency) const
	The tidal forcing frequency for the given term and orbital frequency. More...

void	set_reference_zone_angmom (double reference_angmom)
	Defines the angular momentum of the reference zone for single body evolution. More...

double	periapsis_evolution (const Eigen::Vector3d &orbit_torque, const Eigen::Vector3d &zone_torque, Dissipation::QuantityEntry entry=Dissipation::NO_DERIV, const Eigen::Vector3d &orbit_torque_deriv=Eigen::Vector3d(), const Eigen::Vector3d &zone_torque_deriv=Eigen::Vector3d())
	The rate at which the periapsis of the orbit/reference zone in this zone's equatorial plane is changing. More...

double	inclination_evolution (const Eigen::Vector3d &orbit_torque, const Eigen::Vector3d &zone_torque, Dissipation::QuantityEntry entry=Dissipation::NO_DERIV, const Eigen::Vector3d &orbit_torque_deriv=Eigen::Vector3d(), const Eigen::Vector3d &zone_torque_deriv=Eigen::Vector3d())
	The rate at which the inclination between this zone and the orbit is changing. More...

virtual bool	locked (int orbital_frequency_multiplier, int spin_frequency_multiplier) const
	Should return true iff the given term is presently locked. More...

virtual bool	locked () const
	Should return true iff any tidal term is locked. More...

const SpinOrbitLockInfo &	lock_held () const
	The currntly held lock. More...

void	release_lock ()
	Update the zone as necessary when the held lock disappears from the expansion. More...

void	release_lock (short direction)
	Update the zone as necessary when the held lock is broken. More...

void	set_lock (int orbital_frequency_multiplier, int spin_frequency_multiplier)
	Locks the zone spin to the orbit in the given ratio. More...

double	spin_frequency () const
	The spin frequency of the given zone. More...

double	angular_momentum () const
	The angular momentum of the given zone in \(M_\odot R_\odot^2\). More...

double	tidal_power (bool above, Dissipation::QuantityEntry entry=Dissipation::NO_DERIV) const
	The dimensionless tidal power or one of its derivatives. More...

double	tidal_power (double above_fraction, Dissipation::QuantityEntry entry=Dissipation::NO_DERIV) const
	Same as tidal_power(bool, Dissipation::QuantityEntry), but using the predefined mix of below/above contributions. More...

double	tidal_torque_x (bool above, Dissipation::QuantityEntry entry=Dissipation::NO_DERIV) const
	The dimensionless tidal torque along x. More...

double	tidal_torque_x (double above_fraction, Dissipation::QuantityEntry entry=Dissipation::NO_DERIV) const
	Same as tidal_torque_x(bool, Dissipation::QuantityEntry) but below and above contributions mixed. More...

double	tidal_torque_y (bool above, Dissipation::QuantityEntry entry=Dissipation::NO_DERIV) const
	The dimensionless torque along y. More...

double	tidal_torque_y (double above_fraction, Dissipation::QuantityEntry entry=Dissipation::NO_DERIV) const
	Same as tidal_torque_y(bool, Dissipation::QuantityEntry) but below and above contributions mixed. More...

double	tidal_torque_z (bool above, Dissipation::QuantityEntry entry=Dissipation::NO_DERIV) const
	The dimensionless tidal torque along z. More...

double	tidal_torque_z (double above_fraction, Dissipation::QuantityEntry entry=Dissipation::NO_DERIV) const
	Same as tidal_torque_z(bool, Dissipation::QuantityEntry) but below and above contributions mixed. More...

virtual unsigned	eccentricity_order () const

virtual void	add_to_evolution ()
	Appends the state defined by last configure(), to the evolution. More...

virtual void	rewind_evolution (unsigned nsteps)
	Discards the last steps from the evolution. More...

virtual void	reset_evolution ()
	Discards all evolution. More...

const std::list< double > &	get_evolution_real (ZoneEvolutionQuantities quantity) const
	The tabulated evolution of a real valued quantity so far. More...

const std::list< int > &	get_evolution_integer (ZoneEvolutionQuantities quantity) const
	The tabulated evolution of an integer quantity so far. More...

unsigned	locked_zone_index () const
	The index of this zone in the list of locked zones (valid only if locked). More...

unsigned &	locked_zone_index ()
	Reference to the locked_zone_index() of this zone. More...

virtual void	spin_jumped ()
	Notifies the zone that its spin just jumped discontinously. More...

const SpinOrbitLockInfo &	lock_monitored (bool other=false) const
	Useful for debugging. More...

Public Member Functions inherited from Evolve::ZoneOrientation
	ZoneOrientation (double inclination=Core::NaN, double periapsis=Core::NaN)

void	configure (double inclination, double periapsis)
	Changes the zone orientation. More...

void	set_evolution_rates (double inclination, double periapsis)

double	inclination (bool evolution_rate=false) const
	The angle between the angular momenta of the zone and the orbit. More...

double	periapsis (bool evolution_rate=false) const
	The argument of periapsis of this zone minus the reference zone's. More...

Private Types
enum	CurrentAgeQuantities { RADIUS, INERTIA }
	Identifiers for the various age dependent values which are only computed once per fixed age. More...

Private Attributes
double	__stellar_mass
	The age for the last configure() call. More...

Additional Inherited Members
Protected Member Functions inherited from Evolve::DissipatingZone
void	initializing (bool flag)
	Notify the zone that it is in the process of initializing or not. More...

void	configure_spin (double spin, bool spin_is_frequency)
	Configures only the spin of the zone. More...

Detailed Description

Surface convective zone for low mass evolving stars or the entire star for high mass stars.

Definition at line 18 of file EvolvingStellarEnvelope.h.

Member Enumeration Documentation

◆ CurrentAgeQuantities

enum Star::EvolvingStellarEnvelope::CurrentAgeQuantities

private

Identifiers for the various age dependent values which are only computed once per fixed age.

All quantities also refer to their derivatives.

Enumerator
RADIUS	The radius.
INERTIA	The moment of inertia.

Definition at line 27 of file EvolvingStellarEnvelope.h.

Constructor & Destructor Documentation

◆ EvolvingStellarEnvelope()

Star::EvolvingStellarEnvelope::EvolvingStellarEnvelope	(	double	stellar_mass,
		const StellarEvolution::EvolvingStellarQuantity *	outer_radius = `NULL`,
		const StellarEvolution::EvolvingStellarQuantity *	moment_of_inertia = `NULL`
	)

inline

Parameters

stellar_mass	The mass of the star this zone is part of.
outer_radius	The radius of the star.
moment_of_inertia	The moment of inertia of the zone.

Definition at line 33 of file EvolvingStellarEnvelope.h.

Member Function Documentation

◆ moment_of_inertia() [1/2]

double Star::EvolvingStellarEnvelope::moment_of_inertia	(	double	age,
		int	deriv_order = `0`
	)		const

inlinevirtual

See DissipatingZone::moment_of_inertia(double, int)

Implements Evolve::DissipatingZone.

Definition at line 50 of file EvolvingStellarEnvelope.h.

◆ moment_of_inertia() [2/2]

double Star::EvolvingStellarEnvelope::moment_of_inertia ( int deriv_order = 0 ) const

inlinevirtual

See DissipatingZone::moment_of_inertia(int).

Implements Evolve::DissipatingZone.

Definition at line 54 of file EvolvingStellarEnvelope.h.

◆ outer_mass() [1/2]

double Star::EvolvingStellarEnvelope::outer_mass	(	double	,
		int	deriv_order = `0`
	)		const

inlinevirtual

See DissipatingZone::outer_mass(double, int).

Implements Evolve::DissipatingZone.

Definition at line 66 of file EvolvingStellarEnvelope.h.

◆ outer_mass() [2/2]

double Star::EvolvingStellarEnvelope::outer_mass ( int deriv_order = 0 ) const

inlinevirtual

See DissipatingZone::outer_mass.

Implements Evolve::DissipatingZone.

Definition at line 70 of file EvolvingStellarEnvelope.h.

◆ outer_radius() [1/2]

double Star::EvolvingStellarEnvelope::outer_radius	(	double	age,
		int	deriv_order = `0`
	)		const

inlinevirtual

See DissipatingZone::outer_radius(double, int).

Implements Evolve::DissipatingZone.

Definition at line 58 of file EvolvingStellarEnvelope.h.

◆ outer_radius() [2/2]

double Star::EvolvingStellarEnvelope::outer_radius ( int deriv_order = 0 ) const

inlinevirtual

See DissipatingZone::outer_radius(int).

Implements Evolve::DissipatingZone.

Definition at line 62 of file EvolvingStellarEnvelope.h.

Member Data Documentation

◆ __stellar_mass

double Star::EvolvingStellarEnvelope::__stellar_mass

private

The age for the last configure() call.

Definition at line 21 of file EvolvingStellarEnvelope.h.

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

/home/kpenev/projects/git/poet/poet_src/Star/EvolvingStellarEnvelope.h

Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ CurrentAgeQuantities

Constructor & Destructor Documentation

◆ EvolvingStellarEnvelope()

Member Function Documentation

◆ moment_of_inertia() [1/2]

◆ moment_of_inertia() [2/2]

◆ outer_mass() [1/2]

◆ outer_mass() [2/2]

◆ outer_radius() [1/2]

◆ outer_radius() [2/2]

Member Data Documentation

◆ __stellar_mass