SEVN: Process Class Reference

Searching...

No Matches

#include <Processes.h>

Inheritance diagram for Process:

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

Public Member Functions
	Process ()

virtual	~Process ()

virtual Process *	Instance (_UNUSED IO *_io)

virtual std::string	name ()

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 ()

virtual bool	is_process_ongoing () const

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 std::vector< Process * >	all

static _PrintMap	PrintMap

Protected Member Functions
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 ()

Protected Attributes
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

Constructor & Destructor Documentation

◆ Process()

Process::Process ( )

inline

◆ ~Process()

Process::~Process ( )

virtual

Member Function Documentation

◆ estimate_accreted_mass()

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

inlinevirtual

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 )

inlinevirtual

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

◆ get()

double Process::get ( const size_t & id )

inline

◆ get_event()

double Process::get_event ( )

inline

◆ get_msg()

std::string & Process::get_msg ( )

inline

◆ get_var()

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

inline

◆ Instance()

virtual Process * Process::Instance ( _UNUSED IO * _io )

inlinevirtual

Reimplemented in Circularisation, Kollision, Hardening, and Windaccretion.

◆ is_mass_transfer_happening()

bool Process::is_mass_transfer_happening ( )

inline

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()

virtual bool Process::is_process_ongoing ( ) const

inlinevirtual

Check if the current process is ongoing

Returns: true if the process is ongoing, false otherwise

Reimplemented in Kollision, Hardening, Windaccretion, WindaccretionHurley, and WindaccretionDisabled.

◆ is_special_evolution_alarm_on()

bool Process::is_special_evolution_alarm_on ( ) const

inline

◆ modify_EccentricityDV_by_a_factor()

int Process::modify_EccentricityDV_by_a_factor ( double factor )

inline

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 )

inline

Correct the VB cell containing the Semimajor variation

Parameters

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

Returns: EXIT_SUCCESS

◆ name()

virtual std::string Process::name ( )

inlinevirtual

◆ Register()

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

inlineprotected

◆ reset_event()

void Process::reset_event ( )

inline

◆ restore()

void Process::restore ( )

inline

◆ set()

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

inlineprotected

◆ set_event()

void Process::set_event ( double code )

inline

Events handling.

◆ set_msg()

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

inlineprotected

◆ set_V_to_0()

void Process::set_V_to_0 ( )

inlineprotected

◆ set_var()

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

inlineprotected

◆ special_evolution_alarm_switch_off()

void Process::special_evolution_alarm_switch_off ( )

inline

◆ special_evolution_alarm_switch_on()

void Process::special_evolution_alarm_switch_on ( )

inline

Three methods to handle the private member special_evolution_alarm.

◆ special_evolve()

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

inlinevirtual

Reimplemented in StandardCircularisation.

Member Data Documentation

◆ _uniform_real

std::uniform_real_distribution<double> Process::_uniform_real

protected

◆ accretor

Star* Process::accretor = nullptr

protected

◆ all

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

static

◆ donor

Star* Process::donor = nullptr

protected

◆ event_code

double Process::event_code =-1

private

◆ message

std::string Process::message

private

◆ orb_change

Orbital_change* Process::orb_change = nullptr

protected

◆ PrintMap

Process::_PrintMap Process::PrintMap

static

◆ size

size_t Process::size = 0

staticprivate

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

private

Member used to check if a special evolution is required

◆ svlog

SevnLogging Process::svlog

protected

◆ VB

std::vector<double> Process::VB

private

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

◆ VS

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

private

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/Processes.h
/Users/giulianoiorio/Documents/sevn_public/src/binstar/Processes.cpp
/Users/giulianoiorio/Documents/sevn_public/include/static_main.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Member Typedef Documentation

◆ _PrintMap

Constructor & Destructor Documentation

◆ Process()

◆ ~Process()

Member Function Documentation

◆ estimate_accreted_mass()

◆ evolve()

◆ get()

◆ get_event()

◆ get_msg()

◆ get_var()

◆ Instance()

◆ is_mass_transfer_happening()

◆ is_process_ongoing()

◆ is_special_evolution_alarm_on()

◆ modify_EccentricityDV_by_a_factor()

◆ modify_SemimajorDV_by_a_factor()

◆ name()

◆ Register()

◆ 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

◆ accretor

◆ all

◆ donor

◆ event_code

◆ message

◆ orb_change

◆ PrintMap

◆ size

◆ special_evolution_alarm

◆ svlog

◆ VB

◆ VS