SEVN: Orbital_change_RL Class Reference

Searching...

No Matches

#include <Orbit.h>

Inheritance diagram for Orbital_change_RL:

Public Member Functions
	Orbital_change_RL ()

virtual	~Orbital_change_RL ()

virtual Orbital_change_RL *	instance ()

void	set_options (IO *_io) override

std::string	name () override

void	init (_UNUSED Binstar *b) override

int	speciale_evolve (_UNUSED Binstar *b) override
	Mass transfer. More...

double	get_DM (int ID)

double	DM (_UNUSED Binstar *b, _UNUSED int procID, _UNUSED int starID) override

bool	is_swallowed (int starID)

bool	is_process_ongoing () override
	Other function that return useful information. More...

bool	is_colliding ()

virtual double	get_mt_value () const

virtual double	get_mt_tshold () const

virtual double	DA (_UNUSED Binstar *b, _UNUSED int procID)

virtual double	DE (_UNUSED Binstar *b, _UNUSED int procID)

virtual double	DAngMomSpin (_UNUSED Binstar *b, _UNUSED int procID, _UNUSED int starID)

virtual void	set_options (_UNUSED IO *_io)

Static Public Member Functions
static Orbital_change_RL *	Instance (const std::string &name)

Public Attributes
bool	novae =false

bool	super_eddington =false

Protected Member Functions
void	Register (Orbital_change_RL *ptr, const std::string &_name)

virtual void	RLO (_UNUSED Star donor, _UNUSED Star accretor, _UNUSED Binstar *b)

virtual double	correct_accreted_mass (double DM_accreted, _UNUSED double DM_donor, _UNUSED Star donor, _UNUSED Star accretor, _UNUSED Binstar *b)

virtual double	fRL_radius (_UNUSED Star star, _UNUSED Binstar b)

int	set_DM (double DM, int starID)

int	reset_DM ()

int	set_swallowed (int starID)

int	reset_swallowed (int starID)

int	reset_swallowed ()

void	set_mix ()

void	unset_mix ()

bool	get_mix ()

void	set_comenv ()

void	unset_comenv ()

bool	get_comenv ()

void	set_is_RLO_happening ()

void	unset_is_RLO_happening ()

void	set_is_colliding ()

void	unset_is_colliding ()

virtual int	dynamic_swallowing (_UNUSED Binstar *b)
	Mass transfer. More...

virtual double	estimate_q (Star donor, Star accretor)
	q stuff More...

virtual int	outcome_double_RLO (_UNUSED Binstar *b)
	Utilities. More...

virtual int	outcome_collision (_UNUSED Binstar *b)

virtual int	outcome_collision (_UNUSED Star donor, _UNUSED Star accretor, _UNUSED Binstar *b)

virtual double	Hfrac (Star *s)

virtual double	dMdt_eddington (Star donor, Star accretor, Binstar *b)

bool	is_giant_like (int star_type_bse)

virtual double	dynamic_dmdt (_UNUSED Star s, _UNUSED Binstar b)
	Mass transfer. More...

virtual double	nuclear_dmdt (_UNUSED Star s, _UNUSED Binstar b)

virtual double	thermal_dmdt (_UNUSED Star s, _UNUSED Binstar b)

virtual double	thermal_nuclear_accreted_mass (_UNUSED double DM_donor, _UNUSED Star donor, _UNUSED Star accretor, _UNUSED Binstar *b)

virtual double	kelvin_helmotz_tscale (Star *s)
	time scales More...

virtual double	dynamic_tscale (Star *s)

virtual int	check_compact_accretor (int donor_type_bse, int accretor_type_bse)
	Checks. More...

Protected Attributes
MTstability *	mt_stability

SevnLogging	svlog

Static Private Member Functions
static std::map< std::string, Orbital_change_RL * > &	GetStaticMap ()

static std::vector< int > &	GetUsed ()

Private Attributes
double	_DM [2] ={0,0}

bool	_is_swallowed [2] ={false, false}

bool	mix = false

bool	comenv = false

bool	_is_RLO_happening =false

bool	_is_colliding =false

Constructor & Destructor Documentation

◆ Orbital_change_RL()

Orbital_change_RL::Orbital_change_RL ( )

inline

◆ ~Orbital_change_RL()

virtual Orbital_change_RL::~Orbital_change_RL ( )

inlinevirtual

Member Function Documentation

◆ check_compact_accretor()

virtual int Orbital_change_RL::check_compact_accretor	(	int	donor_type_bse,
		int	accretor_type_bse
	)

inlineprotectedvirtual

Checks.

Check that for compact remnants (WD,NS,BH) the accretor is as compact or more compact with respect to the donor.

Parameters

donor_type_bse	BSE type of the donor
accretor_type_bse	BSE type of the accretor

Returns: EXIT_SUCCESS or throw an error

Exceptions

sevnstd::rl_error

◆ correct_accreted_mass()

virtual double Orbital_change_RL::correct_accreted_mass	(	double	DM_accreted,
		_UNUSED double	DM_donor,
		_UNUSED Star *	donor,
		_UNUSED Star *	accretor,
		_UNUSED Binstar *	b
	)

inlineprotectedvirtual

General function to be called to correct the accreted mass for whatever reason. In this general version it just returns the same amount of DM_accreted in input. The idea is that specialised version of this process could need to add special correction without change the rest of the process.

Parameters

DM_accreted	mass accreted by the accretor (before this correction) in Msun
DM_donor	mass donated by the donor in Msun
donor	Pointer to the star that is overflowing the RocheLobe
accretor	Pointer to the star that is accreting mass
b	Pointer to the binary

Reimplemented in Hurley_rl_propeller.

◆ DA()

virtual double Orbital_change::DA	(	_UNUSED Binstar *	b,
		_UNUSED int	procID
	)

inlinevirtualinherited

Reimplemented in Peters_gw, Hurley_rl, Hurley_SNKicks, and Tides_simple.

◆ DAngMomSpin()

virtual double Orbital_change::DAngMomSpin	(	_UNUSED Binstar *	b,
		_UNUSED int	procID,
		_UNUSED int	starID
	)

inlinevirtualinherited

Reimplemented in Tides_simple, and Hurley_rl.

◆ DE()

virtual double Orbital_change::DE	(	_UNUSED Binstar *	b,
		_UNUSED int	procID
	)

inlinevirtualinherited

Reimplemented in Peters_gw, Hurley_rl, Hurley_SNKicks, and Tides_simple.

◆ DM()

double Orbital_change_RL::DM	(	_UNUSED Binstar *	b,
		_UNUSED int	procID,
		_UNUSED int	starID
	)

inlineoverridevirtual

Reimplemented from Orbital_change.

◆ dMdt_eddington()

double Orbital_change_RL::dMdt_eddington	(	Star *	donor,
		Star *	accretor,
		Binstar *	b
	)

protectedvirtual

Estimate the rate of mass transfer considering the Eddington limit

Parameters

donor	Star that is donating mass through the RLO
accretor	Star that is accreting mass

Returns

◆ dynamic_dmdt()

virtual double Orbital_change_RL::dynamic_dmdt	(	_UNUSED Star *	s,
		_UNUSED Binstar *	b
	)

inlineprotectedvirtual

Mass transfer.

Rate of dynamic mass transfer

Parameters

s	pointer to the Star that is losing mass
b	pointer to the binary

Returns: dm/dt or thrown an error

Exceptions

rl_error if the method is not implemented

Reimplemented in Hurley_rl.

◆ dynamic_swallowing()

virtual int Orbital_change_RL::dynamic_swallowing ( _UNUSED Binstar * b )

inlineprotectedvirtual

Mass transfer.

Function that handle the situation in which the mass transfer is dynamic unstable but the stars are not mixing or doing a ce.

Parameters

b	Pointer to the binary

Returns: EXIT_SUCCESS;

Reimplemented in Hurley_rl, and Hurley_rl_bse.

◆ dynamic_tscale()

double Orbital_change_RL::dynamic_tscale ( Star * s )

protectedvirtual

Dynamic time scale (Eq. 63, Hurley+2002) Directly taken from SEVN1

Parameters

s	Pointer to star

Returns: Dynamic time scale in yr

◆ estimate_q()

double Orbital_change_RL::estimate_q	(	Star *	donor,
		Star *	accretor
	)

protectedvirtual

q stuff

Simply estimate the mass fraction of the donor over the accretor

Parameters

donor	Star that is donating mass through the RLO
accretor	Star that is accreting mass

Returns: mass_fraction

◆ fRL_radius()

virtual double Orbital_change_RL::fRL_radius	(	_UNUSED Star *	star,
		_UNUSED Binstar *	b
	)

inlineprotectedvirtual

Roche Lobe radius normalised over the star radius

Parameters

star	pointer to the star for which we are estimateting fRL
b	pointer to the binary

Returns: R_rl/R_star

Reimplemented in Hurley_rl.

◆ get_comenv()

bool Orbital_change_RL::get_comenv ( )

inlineprotected

◆ get_DM()

double Orbital_change_RL::get_DM ( int ID )

inline

◆ get_mix()

bool Orbital_change_RL::get_mix ( )

inlineprotected

◆ get_mt_tshold()

virtual double Orbital_change_RL::get_mt_tshold ( ) const

inlinevirtual

Reimplemented in Hurley_rl.

◆ get_mt_value()

virtual double Orbital_change_RL::get_mt_value ( ) const

inlinevirtual

Reimplemented in Hurley_rl.

◆ GetStaticMap()

static std::map< std::string, Orbital_change_RL * > & Orbital_change_RL::GetStaticMap ( )

inlinestaticprivate

◆ GetUsed()

static std::vector< int > & Orbital_change_RL::GetUsed ( )

inlinestaticprivate

◆ Hfrac()

double Orbital_change_RL::Hfrac ( Star * s )

protectedvirtual

Estimate the H fraction based on the functional form .... (found in SEVN1)

Parameters

s	Pointer to the star

Returns

◆ init()

void Orbital_change_RL::init ( _UNUSED Binstar * b )

inlineoverridevirtual

Init function to be called at the beginning of the Process::evolve

Parameters

b	Pointer to the binary

Reimplemented from Orbital_change.

Reimplemented in Hurley_rl.

◆ instance()

virtual Orbital_change_RL * Orbital_change_RL::instance ( )

inlinevirtual

Reimplemented in disabled_rl, Hurley_rl, Hurley_rl_bse, Hurley_rl_propeller, and Hurley_mod_rl.

◆ Instance()

Orbital_change_RL * Orbital_change_RL::Instance ( const std::string & name )

static

◆ is_colliding()

bool Orbital_change_RL::is_colliding ( )

inline

◆ is_giant_like()

bool Orbital_change_RL::is_giant_like ( int star_type_bse )

inlineprotected

Check if the star can be considered giant or giant-like in the BSE type classification

Parameters

star_type_bse BSE star type

Returns: true if the type is between 2 and 9 (inclusive) but not 7, false otherwise

◆ is_process_ongoing()

bool Orbital_change_RL::is_process_ongoing ( )

inlineoverridevirtual

Other function that return useful information.

Check if the process is really ongoing, i.e. it is really changing properties.

Returns

Reimplemented from Orbital_change.

Reimplemented in disabled_rl.

◆ is_swallowed()

bool Orbital_change_RL::is_swallowed ( int starID )

inline

◆ kelvin_helmotz_tscale()

double Orbital_change_RL::kelvin_helmotz_tscale ( Star * s )

protectedvirtual

time scales

Time scales.

Kelvin-Helmholtz time scale from the modified classical expression (Eq. 61, Hurley+2002) Directly taken from SEVN1

Parameters

s	Pointer to star

Returns: Kelvin-Helmholtz time scale in yr

◆ name()

std::string Orbital_change_RL::name ( )

inlineoverridevirtual

Reimplemented from Orbital_change.

Reimplemented in disabled_rl, Hurley_rl, Hurley_rl_bse, Hurley_rl_propeller, and Hurley_mod_rl.

◆ nuclear_dmdt()

virtual double Orbital_change_RL::nuclear_dmdt	(	_UNUSED Star *	s,
		_UNUSED Binstar *	b
	)

inlineprotectedvirtual

Rate of nuclear mass transfer

Parameters

s	pointer to the Star that is losing mass
b	pointer to the binary

Returns: dm/dt or thrown an error

Exceptions

rl_error if the method is not implemented

Reimplemented in Hurley_rl.

◆ outcome_collision() [1/2]

virtual int Orbital_change_RL::outcome_collision ( _UNUSED Binstar * b )

inlineprotectedvirtual

Set binary mix or common evelope to true depending on the stellar bse phases in case of collision at the pericenter

Parameters

b	Pointer to the binary

Returns: EXIT_SUCCESS

Reimplemented in Hurley_rl.

◆ outcome_collision() [2/2]

virtual int Orbital_change_RL::outcome_collision	(	_UNUSED Star *	donor,
		_UNUSED Star *	accretor,
		_UNUSED Binstar *	b
	)

inlineprotectedvirtual

Set binary mix or common evelope to true depending on the stellar bse phases in case of collision at the pericenter

Parameters

b	Pointer to the binary

Returns: EXIT_SUCCESS

◆ outcome_double_RLO()

virtual int Orbital_change_RL::outcome_double_RLO ( _UNUSED Binstar * b )

inlineprotectedvirtual

Utilities.

Set binary mix or common evelope to true depending on the stellar bse phases in case of both stars are overfilling the RL

Parameters

b	Pointer to the binary

Returns: EXIT_SUCCESS

Reimplemented in Hurley_rl.

◆ Register()

void Orbital_change_RL::Register	(	Orbital_change_RL *	ptr,
		const std::string &	_name
	)

inlineprotected

◆ reset_DM()

int Orbital_change_RL::reset_DM ( )

inlineprotected

◆ reset_swallowed() [1/2]

int Orbital_change_RL::reset_swallowed ( )

inlineprotected

◆ reset_swallowed() [2/2]

int Orbital_change_RL::reset_swallowed ( int starID )

inlineprotected

◆ RLO()

virtual void Orbital_change_RL::RLO	(	_UNUSED Star *	donor,
		_UNUSED Star *	accretor,
		_UNUSED Binstar *	b
	)

inlineprotectedvirtual

Actual RocheLobe Overflow process

Parameters

donor	Pointer to the star that is overflowing the RocheLobe
accretor	Pointer to the star that is accreting mass
b	Pointer to the binary

◆ set_comenv()

void Orbital_change_RL::set_comenv ( )

inlineprotected

◆ set_DM()

int Orbital_change_RL::set_DM	(	double	DM,
		int	starID
	)

inlineprotected

◆ set_is_colliding()

void Orbital_change_RL::set_is_colliding ( )

inlineprotected

◆ set_is_RLO_happening()

void Orbital_change_RL::set_is_RLO_happening ( )

inlineprotected

◆ set_mix()

void Orbital_change_RL::set_mix ( )

inlineprotected

◆ set_options() [1/2]

virtual void Orbital_change::set_options ( _UNUSED IO * _io )

inlinevirtualinherited

◆ set_options() [2/2]

void Orbital_change_RL::set_options ( IO * _io )

inlineoverride

◆ set_swallowed()

int Orbital_change_RL::set_swallowed ( int starID )

inlineprotected

◆ speciale_evolve()

int Orbital_change_RL::speciale_evolve ( _UNUSED Binstar * b )

overridevirtual

Mass transfer.

Reimplemented from Orbital_change.

◆ thermal_dmdt()

virtual double Orbital_change_RL::thermal_dmdt	(	_UNUSED Star *	s,
		_UNUSED Binstar *	b
	)

inlineprotectedvirtual

Rate of nuclear mass transfer

Parameters

s	pointer to the Star that is losing mass
b	pointer to the binary

Returns: dm/dt or thrown an error

Exceptions

rl_error if the method is not implemented

Reimplemented in Hurley_rl.

◆ thermal_nuclear_accreted_mass()

virtual double Orbital_change_RL::thermal_nuclear_accreted_mass	(	_UNUSED double	DM_donor,
		_UNUSED Star *	donor,
		_UNUSED Star *	accretor,
		_UNUSED Binstar *	b
	)

inlineprotectedvirtual

Parameters

donor
accretor
b

Returns

Reimplemented in Hurley_rl, and Hurley_rl_bse.

◆ unset_comenv()

void Orbital_change_RL::unset_comenv ( )

inlineprotected

◆ unset_is_colliding()

void Orbital_change_RL::unset_is_colliding ( )

inlineprotected

◆ unset_is_RLO_happening()

void Orbital_change_RL::unset_is_RLO_happening ( )

inlineprotected

◆ unset_mix()

void Orbital_change_RL::unset_mix ( )

inlineprotected

Member Data Documentation

◆ _DM

double Orbital_change_RL::_DM[2] ={0,0}

private

◆ _is_colliding

bool Orbital_change_RL::_is_colliding =false

private

◆ _is_RLO_happening

bool Orbital_change_RL::_is_RLO_happening =false

private

◆ _is_swallowed

bool Orbital_change_RL::_is_swallowed[2] ={false, false}

private

Array of bool corresponding to the ID of stars in binary. If true, the star has been swallowed through the RLO

◆ comenv

bool Orbital_change_RL::comenv = false

private

◆ mix

bool Orbital_change_RL::mix = false

private

◆ mt_stability

MTstability* Orbital_change_RL::mt_stability

protected

◆ novae

bool Orbital_change_RL::novae =false

◆ super_eddington

bool Orbital_change_RL::super_eddington =false

◆ svlog

SevnLogging Orbital_change::svlog

protectedinherited

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

/Users/giulianoiorio/Documents/sevn_public/src/binstar/Orbit.h
/Users/giulianoiorio/Documents/sevn_public/src/binstar/Orbit.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ Orbital_change_RL()

◆ ~Orbital_change_RL()

Member Function Documentation

◆ check_compact_accretor()

◆ correct_accreted_mass()

◆ DA()

◆ DAngMomSpin()

◆ DE()

◆ DM()

◆ dMdt_eddington()

◆ dynamic_dmdt()

◆ dynamic_swallowing()

◆ dynamic_tscale()

◆ estimate_q()

◆ fRL_radius()

◆ get_comenv()

◆ get_DM()

◆ get_mix()

◆ get_mt_tshold()

◆ get_mt_value()

◆ GetStaticMap()

◆ GetUsed()

◆ Hfrac()

◆ init()

◆ instance()

◆ Instance()

◆ is_colliding()

◆ is_giant_like()

◆ is_process_ongoing()

◆ is_swallowed()

◆ kelvin_helmotz_tscale()

◆ name()

◆ nuclear_dmdt()

◆ outcome_collision() [1/2]

◆ outcome_collision() [2/2]

◆ outcome_double_RLO()

◆ Register()

◆ reset_DM()

◆ reset_swallowed() [1/2]

◆ reset_swallowed() [2/2]

◆ RLO()

◆ set_comenv()

◆ set_DM()

◆ set_is_colliding()

◆ set_is_RLO_happening()

◆ set_mix()

◆ set_options() [1/2]

◆ set_options() [2/2]

◆ set_swallowed()

◆ speciale_evolve()

◆ thermal_dmdt()

◆ thermal_nuclear_accreted_mass()

◆ unset_comenv()

◆ unset_is_colliding()

◆ unset_is_RLO_happening()

◆ unset_mix()

Member Data Documentation

◆ _DM

◆ _is_colliding

◆ _is_RLO_happening

◆ _is_swallowed

◆ comenv

◆ mix

◆ mt_stability

◆ novae

◆ super_eddington

◆ svlog