SEVN: Windaccretion Class Reference

Searching...

No Matches

#include <Windaccretion.h>

Inheritance diagram for Windaccretion:

Public Types
typedef std::map< std::string, size_t >	_PrintMap

Public Member Functions
	Windaccretion (_UNUSED IO *_io=nullptr, bool reg=true)

std::string	name () override

Windaccretion *	Instance (_UNUSED IO *_io) override

virtual Windaccretion *	instance ()

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

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

bool	is_process_ongoing () const override

virtual double	NS_DBmag_accretion (_UNUSED Binstar b, _UNUSED Star s, _UNUSED double DM) const

virtual double	NS_DOmegaRem_accretion (_UNUSED Binstar b, _UNUSED Star s, _UNUSED double DM) const

virtual int	evolve (_UNUSED Binstar *binstar)

virtual int	special_evolve (_UNUSED Binstar *binstar)

double	get (const size_t &id)

double	get_var (const size_t &starID, const size_t &propID)

std::string &	get_msg ()

void	restore ()

int	modify_SemimajorDV_by_a_factor (double factor)

int	modify_EccentricityDV_by_a_factor (double factor)

bool	is_mass_transfer_happening ()

void	set_event (double code)
	Events handling. More...

double	get_event ()

void	reset_event ()

void	special_evolution_alarm_switch_on ()
	Three methods to handle the private member special_evolution_alarm. More...

void	special_evolution_alarm_switch_off ()

bool	is_special_evolution_alarm_on () const

virtual double	estimate_accreted_mass (_UNUSED double DM, _UNUSED Star donor, _UNUSED Star accretor, _UNUSED Binstar *binstar) const

Static Public Attributes
static size_t	ID

static Windaccretion	_windaccretion

static constexpr int	NO_WINDACCRETION = 0

static std::vector< Process * >	all

static _PrintMap	PrintMap

Protected Member Functions
virtual int	accrete_mass (_UNUSED Binstar *binstar)

virtual void	handle_NS_massaccretion (_UNUSED Binstar b, _UNUSED Star s, _UNUSED double DM)

void	Register (Process _p, size_t id, const std::string &_name)

void	set (const size_t &id, const double &value)

void	set_var (const size_t &starID, const size_t &propID, const double &value)

void	set_msg (const std::string &str)

void	set_V_to_0 ()

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

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

static void	Register_specific (Windaccretion *ptr)

Protected Attributes
double	betaw

double	alphaw

double	muw

Star *	donor = nullptr

Star *	accretor = nullptr

SevnLogging	svlog

Orbital_change *	orb_change = nullptr

std::uniform_real_distribution< double >	_uniform_real

Private Attributes
std::vector< double >	VB

std::vector< std::vector< double > >	VS

std::string	message

double	event_code =-1

bool	special_evolution_alarm =false

Static Private Attributes
static size_t	size = 0

Member Typedef Documentation

◆ _PrintMap

typedef std::map<std::string,size_t> Process::_PrintMap

inherited

Constructor & Destructor Documentation

◆ Windaccretion()

Windaccretion::Windaccretion	(	_UNUSED IO *	_io = `nullptr`,
		bool	reg = `true`
	)

inline

Member Function Documentation

◆ accrete_mass()

virtual int MaccretionProcess::accrete_mass ( _UNUSED Binstar * binstar )

inlineprotectedvirtualinherited

Function in which the mass accretion is handled. This function should take care of changing all the single stellar evolution properties (not only the mass) The change of binary parameters such as Semimajor axis and Eccentricity are instead changed inside evolve using the methods DA and DE.

Parameters

binstar Pointer to the binary star

Returns: EXIT SUCCESS

◆ DA()

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

inlinevirtual

Reimplemented in WindaccretionHurley.

◆ DE()

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

inlinevirtual

Reimplemented in WindaccretionHurley.

◆ estimate_accreted_mass()

virtual double Process::estimate_accreted_mass	(	_UNUSED double	DM,
		_UNUSED Star *	donor,
		_UNUSED Star *	accretor,
		_UNUSED Binstar *	binstar
	)		const

inlinevirtualinherited

Public interface to allow the user to get information without actually evolving the systems. NOTICE: to be self-consistent the protected and private methods (such DA and DE should use these methods) when changing the properties of stars and binaries. This function should be an interface for the user to return the amount of mass accreted on the accretor given the binary, the donor and the available amount of mass DM. NOTICE: internally the accrete mass should use this method to be self-consistent

Parameters

DM	amount of mass available to be accreted in Msun.
donor	Pointer to the Star that is donating the mass
accretor	Pointer to the star that is receiving the mass
binstar	Pointer to the binary system hosting the donor and the accretore

Returns: the amount of accreted mass

Reimplemented in WindaccretionHurley.

◆ evolve()

virtual int Process::evolve ( _UNUSED Binstar * binstar )

inlinevirtualinherited

Reimplemented in CircularisationDisabled, StandardCircularisation, KollisionDisabled, KollisionHurley, HardeningDisabled, HardeningFastCluster, and WindaccretionDisabled.

◆ get()

double Process::get ( const size_t & id )

inlineinherited

◆ get_event()

double Process::get_event ( )

inlineinherited

◆ get_msg()

std::string & Process::get_msg ( )

inlineinherited

◆ get_var()

double Process::get_var	(	const size_t &	starID,
		const size_t &	propID
	)

inlineinherited

◆ GetStaticMap()

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

inlinestaticprotected

◆ GetUsed()

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

inlinestaticprotected

◆ handle_NS_massaccretion()

void MaccretionProcess::handle_NS_massaccretion	(	_UNUSED Binstar *	b,
		_UNUSED Star *	s,
		_UNUSED double	DM
	)

protectedvirtualinherited

It is a wrapper of all the necessray function calls to set the DV of NS properties after mass accretion

Parameters

s	Pointer to the ns star
dM	Mass accreted in Msun

◆ instance()

virtual Windaccretion * Windaccretion::instance ( )

inlinevirtual

Reimplemented in WindaccretionHurley, and WindaccretionDisabled.

◆ Instance()

Windaccretion * Windaccretion::Instance ( _UNUSED IO * _io )

overridevirtual

Reimplemented from Process.

◆ is_mass_transfer_happening()

bool Process::is_mass_transfer_happening ( )

inlineinherited

Check if this process is changing the mass

Returns: false if the DV regarding the Mass of both stars is currently set to 0, true otherwise

◆ is_process_ongoing()

bool Windaccretion::is_process_ongoing ( ) const

inlineoverridevirtual

Check if the current process is ongoing

Returns: true if the process is ongoing, false otherwise

Reimplemented from Process.

Reimplemented in WindaccretionHurley, and WindaccretionDisabled.

◆ is_special_evolution_alarm_on()

bool Process::is_special_evolution_alarm_on ( ) const

inlineinherited

◆ modify_EccentricityDV_by_a_factor()

int Process::modify_EccentricityDV_by_a_factor ( double factor )

inlineinherited

Correct the VB cell containing the Eccentricity variation

Parameters

factor correction factor the new DE will be DE*factor.

Returns: EXIT_SUCCESS

◆ modify_SemimajorDV_by_a_factor()

int Process::modify_SemimajorDV_by_a_factor ( double factor )

inlineinherited

Correct the VB cell containing the Semimajor variation

Parameters

factor correction factor the new DA will be DA*factor.

Returns: EXIT_SUCCESS

◆ name()

std::string Windaccretion::name ( )

inlineoverridevirtual

Reimplemented from Process.

Reimplemented in WindaccretionHurley, and WindaccretionDisabled.

◆ NS_DBmag_accretion()

double MaccretionProcess::NS_DBmag_accretion	(	_UNUSED Binstar *	b,
		_UNUSED Star *	s,
		_UNUSED double	DM
	)		const

virtualinherited

This function estimate the increment or decrement of NS Bmag due do the accretion of material

Parameters

s	Pointer to the star that is accreting
dM	Mass accreted in Msun

Returns: THe difference in Bmag after accretion

Checks

◆ NS_DOmegaRem_accretion()

double MaccretionProcess::NS_DOmegaRem_accretion	(	_UNUSED Binstar *	b,
		_UNUSED Star *	s,
		_UNUSED double	DM
	)		const

virtualinherited

This function estimate the increment or decrement of NS angular velocity OmegaRem due do the accretion of material

Parameters

s	Pointer to the star that is accreting
dM	Mass accreted in Msun

Returns: THe difference in OmegaRem after accretion

Checks

◆ Register()

void Process::Register	(	Process *	_p,
		size_t *	id,
		const std::string &	_name
	)

inlineprotectedinherited

◆ Register_specific()

static void Windaccretion::Register_specific ( Windaccretion * ptr )

inlinestaticprotected

◆ reset_event()

void Process::reset_event ( )

inlineinherited

◆ restore()

void Process::restore ( )

inlineinherited

◆ set()

void Process::set	(	const size_t &	id,
		const double &	value
	)

inlineprotectedinherited

◆ set_event()

void Process::set_event ( double code )

inlineinherited

Events handling.

◆ set_msg()

void Process::set_msg ( const std::string & str )

inlineprotectedinherited

◆ set_V_to_0()

void Process::set_V_to_0 ( )

inlineprotectedinherited

◆ set_var()

void Process::set_var	(	const size_t &	starID,
		const size_t &	propID,
		const double &	value
	)

inlineprotectedinherited

◆ special_evolution_alarm_switch_off()

void Process::special_evolution_alarm_switch_off ( )

inlineinherited

◆ special_evolution_alarm_switch_on()

void Process::special_evolution_alarm_switch_on ( )

inlineinherited

Three methods to handle the private member special_evolution_alarm.

◆ special_evolve()

virtual int Process::special_evolve ( _UNUSED Binstar * binstar )

inlinevirtualinherited

Reimplemented in StandardCircularisation.

Member Data Documentation

◆ _uniform_real

std::uniform_real_distribution<double> Process::_uniform_real

protectedinherited

◆ _windaccretion

Windaccretion Windaccretion::_windaccretion

static

Initialisation of the static (fake) instance NB: take care of the order of initialisation. The processes will be evolved exactly in the same order in which they are initialised here

◆ accretor

Star* Process::accretor = nullptr

protectedinherited

◆ all

std::vector< Process * > Process::all

staticinherited

◆ alphaw

double Windaccretion::alphaw

protected

Bondi-Hoyle accretion parameter (Eq. 6, Hurley+02)

◆ betaw

double Windaccretion::betaw

protected

Wind escape velocity parameter (Eq. 9, Hurley+02)

◆ donor

Star* Process::donor = nullptr

protectedinherited

◆ event_code

double Process::event_code =-1

privateinherited

◆ ID

size_t Windaccretion::ID

static

◆ message

std::string Process::message

privateinherited

◆ muw

double Windaccretion::muw

protected

Angular momentum transfer efficiency (Eq. 11, Hurley+02)

◆ NO_WINDACCRETION

constexpr int Windaccretion::NO_WINDACCRETION = 0

staticconstexpr

◆ orb_change

Orbital_change* Process::orb_change = nullptr

protectedinherited

◆ PrintMap

Process::_PrintMap Process::PrintMap

staticinherited

◆ size

size_t Process::size = 0

staticprivateinherited

Instruction for adding new property PROC 1- Add the size_t PROC::ID 2- Initialise the static (fake) instance PROC PROC::_proc. NB: take care of the order of initialisation. The processes will be evolved exactly in the same order in which they are initialised here Define: @size: total number of instances of Process and derived classes (both fake and real). @all: vector containing all the (pointers) to the processes. @PrintMap: map containing the pair (process_name, process_id) for output purpose. Note all and PrintMap are filled during the instantiation of the fake Processes (see below)

◆ special_evolution_alarm

bool Process::special_evolution_alarm =false

privateinherited

Member used to check if a special evolution is required

◆ svlog

SevnLogging Process::svlog

protectedinherited

◆ VB

std::vector<double> Process::VB

privateinherited

values of the properties of the binary system (e.g. processes change eccentricity, semimajor...)

◆ VS

std::vector<std::vector<double> > Process::VS

privateinherited

variations of the single star parameters due to binary stellar evolution processes (e.g. mass, radius...)

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

/Users/giulianoiorio/Documents/sevn_public/src/binstar/procs/Windaccretion.h
/Users/giulianoiorio/Documents/sevn_public/src/binstar/procs/Windaccretion.cpp
/Users/giulianoiorio/Documents/sevn_public/include/static_main.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Member Typedef Documentation

◆ _PrintMap

Constructor & Destructor Documentation

◆ Windaccretion()

Member Function Documentation

◆ accrete_mass()

◆ DA()

◆ DE()

◆ estimate_accreted_mass()

◆ evolve()

◆ get()

◆ get_event()

◆ get_msg()

◆ get_var()

◆ GetStaticMap()

◆ GetUsed()

◆ handle_NS_massaccretion()

◆ instance()

◆ Instance()

◆ is_mass_transfer_happening()

◆ is_process_ongoing()

◆ is_special_evolution_alarm_on()

◆ modify_EccentricityDV_by_a_factor()

◆ modify_SemimajorDV_by_a_factor()

◆ name()

◆ NS_DBmag_accretion()

◆ NS_DOmegaRem_accretion()

◆ Register()

◆ Register_specific()

◆ reset_event()

◆ restore()

◆ set()

◆ set_event()

◆ set_msg()

◆ set_V_to_0()

◆ set_var()

◆ special_evolution_alarm_switch_off()

◆ special_evolution_alarm_switch_on()

◆ special_evolve()

Member Data Documentation

◆ _uniform_real

◆ _windaccretion

◆ accretor

◆ all

◆ alphaw

◆ betaw

◆ donor

◆ event_code

◆ ID

◆ message

◆ muw

◆ NO_WINDACCRETION

◆ orb_change

◆ PrintMap

◆ size

◆ special_evolution_alarm

◆ svlog

◆ VB

◆ VS