SEVN
Loading...
Searching...
No Matches
KollisionHurley Class Reference

#include <Collision.h>

Inheritance diagram for KollisionHurley:
Kollision Process

Public Types

typedef unsigned int collision_outcome
 
typedef std::map< std::string, size_t > _PrintMap
 

Public Member Functions

 KollisionHurley (_UNUSED IO *_io=nullptr, bool reg=true)
 
std::string name () override
 
KollisionHurleyinstance () override
 
int evolve (_UNUSED Binstar *binstar) override
 
KollisionInstance (_UNUSED IO *_io) override
 
bool is_process_ongoing () const override
 
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 Member Functions

static bool check_collision (Binstar *b)
 
static collision_outcome outcome_collision (Binstar *b)
 
static std::string log_message (_UNUSED Binstar *binstar)
 

Static Public Attributes

static KollisionHurley _kollisionhurley
 
static size_t ID
 
static Kollision _kollision
 
static constexpr int NO_COLLISION =0
 
static constexpr int COLLISION_CE =1
 
static constexpr int COLLISION_MIX =2
 
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 ()
 

Static Protected Member Functions

static std::map< std::string, Kollision * > & GetStaticMap ()
 Notice this stuff are here and used only for the process Kollision. More...
 
static std::vector< int > & GetUsed ()
 
static void Register_specific (Kollision *ptr)
 

Protected Attributes

Stardonor = nullptr
 
Staraccretor = nullptr
 
SevnLogging svlog
 
Orbital_changeorb_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

◆ collision_outcome

typedef unsigned int Kollision::collision_outcome
inherited

Constructor & Destructor Documentation

◆ KollisionHurley()

KollisionHurley::KollisionHurley ( _UNUSED IO _io = nullptr,
bool  reg = true 
)
inline

Member Function Documentation

◆ check_collision()

bool KollisionHurley::check_collision ( Binstar b)
static

◆ 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
DMamount of mass available to be accreted in Msun.
donorPointer to the Star that is donating the mass
accretorPointer to the star that is receiving the mass
binstarPointer to the binary system hosting the donor and the accretore
Returns
the amount of accreted mass

Reimplemented in WindaccretionHurley.

◆ evolve()

int KollisionHurley::evolve ( _UNUSED Binstar binstar)
overridevirtual

Reimplemented from Process.

◆ 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, Kollision * > & Kollision::GetStaticMap ( )
inlinestaticprotectedinherited

Notice this stuff are here and used only for the process Kollision.

◆ GetUsed()

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

◆ instance()

KollisionHurley * KollisionHurley::instance ( )
inlineoverridevirtual

Reimplemented from Kollision.

◆ Instance()

Kollision * Kollision::Instance ( _UNUSED IO _io)
overridevirtualinherited

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 Kollision::is_process_ongoing ( ) const
inlineoverridevirtualinherited

Check if the current process is ongoing

Returns
true if the process is ongoing, false otherwise

Reimplemented from Process.

◆ is_special_evolution_alarm_on()

bool Process::is_special_evolution_alarm_on ( ) const
inlineinherited

◆ log_message()

std::string Kollision::log_message ( _UNUSED Binstar binstar)
staticinherited

◆ modify_EccentricityDV_by_a_factor()

int Process::modify_EccentricityDV_by_a_factor ( double  factor)
inlineinherited

Correct the VB cell containing the Eccentricity variation

Parameters
factorcorrection 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
factorcorrection factor the new DA will be DA*factor.
Returns
EXIT_SUCCESS

◆ name()

std::string KollisionHurley::name ( )
inlineoverridevirtual

Reimplemented from Kollision.

◆ outcome_collision()

Kollision::collision_outcome KollisionHurley::outcome_collision ( Binstar b)
static

◆ Register()

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

◆ Register_specific()

static void Kollision::Register_specific ( Kollision ptr)
inlinestaticprotectedinherited

◆ 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

◆ _kollision

Kollision Kollision::_kollision
staticinherited

◆ _kollisionhurley

KollisionHurley KollisionHurley::_kollisionhurley
static

◆ _uniform_real

std::uniform_real_distribution<double> Process::_uniform_real
protectedinherited

◆ accretor

Star* Process::accretor = nullptr
protectedinherited

◆ all

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

◆ COLLISION_CE

constexpr int Kollision::COLLISION_CE =1
staticconstexprinherited

◆ COLLISION_MIX

constexpr int Kollision::COLLISION_MIX =2
staticconstexprinherited

◆ donor

Star* Process::donor = nullptr
protectedinherited

◆ event_code

double Process::event_code =-1
privateinherited

◆ ID

size_t Kollision::ID
staticinherited

◆ message

std::string Process::message
privateinherited

◆ NO_COLLISION

constexpr int Kollision::NO_COLLISION =0
staticconstexprinherited

◆ 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: