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

#include <Orbit.h>

Inheritance diagram for Orbital_change_SNKicks:
Orbital_change Hurley_SNKicks disabled_SNKicks

Public Member Functions

 Orbital_change_SNKicks ()
 
virtual ~Orbital_change_SNKicks ()
 
virtual Orbital_change_SNKicksinstance ()
 
std::string name () override
 
double get_cos_nu () const
 
double get_vcom () const
 
virtual void init (_UNUSED Binstar *b)
 
virtual double DA (_UNUSED Binstar *b, _UNUSED int procID)
 
virtual double DE (_UNUSED Binstar *b, _UNUSED int procID)
 
virtual double DM (_UNUSED Binstar *b, _UNUSED int procID, _UNUSED int starID)
 
virtual double DAngMomSpin (_UNUSED Binstar *b, _UNUSED int procID, _UNUSED int starID)
 
virtual bool is_process_ongoing ()
 Other function that return useful information. More...
 
virtual int speciale_evolve (_UNUSED Binstar *b)
 
virtual void set_options (_UNUSED IO *_io)
 

Static Public Member Functions

static Orbital_change_SNKicksInstance (const std::string &name)
 

Protected Member Functions

void Register (Orbital_change_SNKicks *ptr, const std::string &_name)
 
void set_cos_nu (double _cos_nu)
 
void set_vcom (double _vcom)
 

Protected Attributes

SevnLogging svlog
 

Static Private Member Functions

static std::map< std::string, Orbital_change_SNKicks * > & GetStaticMap ()
 
static std::vector< int > & GetUsed ()
 

Private Attributes

double cos_nu
 
double vcom
 

Constructor & Destructor Documentation

◆ Orbital_change_SNKicks()

Orbital_change_SNKicks::Orbital_change_SNKicks ( )
inline

◆ ~Orbital_change_SNKicks()

virtual Orbital_change_SNKicks::~Orbital_change_SNKicks ( )
inlinevirtual

Member Function Documentation

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

virtual double Orbital_change::DM ( _UNUSED Binstar b,
_UNUSED int  procID,
_UNUSED int  starID 
)
inlinevirtualinherited

Reimplemented in Orbital_change_RL.

◆ get_cos_nu()

double Orbital_change_SNKicks::get_cos_nu ( ) const
inline

◆ get_vcom()

double Orbital_change_SNKicks::get_vcom ( ) const
inline

◆ GetStaticMap()

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

◆ GetUsed()

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

◆ init()

virtual void Orbital_change::init ( _UNUSED Binstar b)
inlinevirtualinherited

Function that set all the variable needed in the estimate of DA, DE, DM

Parameters
b

Reimplemented in Orbital_change_RL, Hurley_rl, Hurley_SNKicks, and Tides_simple.

◆ instance()

virtual Orbital_change_SNKicks * Orbital_change_SNKicks::instance ( )
inlinevirtual

Reimplemented in disabled_SNKicks, and Hurley_SNKicks.

◆ Instance()

Orbital_change_SNKicks * Orbital_change_SNKicks::Instance ( const std::string &  name)
static

◆ is_process_ongoing()

virtual bool Orbital_change::is_process_ongoing ( )
inlinevirtualinherited

Other function that return useful information.

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

Returns

Reimplemented in disabled_tides, disabled_gw, Orbital_change_RL, disabled_rl, disabled_mix, and disabled_SNKicks.

◆ name()

std::string Orbital_change_SNKicks::name ( )
inlineoverridevirtual

Reimplemented from Orbital_change.

Reimplemented in disabled_SNKicks, and Hurley_SNKicks.

◆ Register()

void Orbital_change_SNKicks::Register ( Orbital_change_SNKicks ptr,
const std::string &  _name 
)
inlineprotected

◆ set_cos_nu()

void Orbital_change_SNKicks::set_cos_nu ( double  _cos_nu)
inlineprotected

◆ set_options()

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

◆ set_vcom()

void Orbital_change_SNKicks::set_vcom ( double  _vcom)
inlineprotected

◆ speciale_evolve()

virtual int Orbital_change::speciale_evolve ( _UNUSED Binstar b)
inlinevirtualinherited

Function to be called (if needed) in the special_evolve function of Processes. Each Process can have its particular special evolve. See the proper documentation.

Parameters
bPointer to the binary.
Returns

Reimplemented in Orbital_change_RL.

Member Data Documentation

◆ cos_nu

double Orbital_change_SNKicks::cos_nu
private

◆ svlog

SevnLogging Orbital_change::svlog
protectedinherited

◆ vcom

double Orbital_change_SNKicks::vcom
private

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