SEVN: Xspin Class Reference

Searching...

No Matches

#include <property.h>

Inheritance diagram for Xspin:

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

Public Member Functions
	Xspin (bool reg=true)

Xspin *	Instance () override

std::string	name () const override

void	evolve (_UNUSED Star *s) override

void	set_remnant (_UNUSED Star *s) override

void	evolve_remnant (_UNUSED Star *s) override

virtual void	copy_V_from (Property *p)

virtual void	update_derived (_UNUSED Star *s)

virtual std::string	units ()

virtual void	resynch (_UNUSED const double &dt, _UNUSED bool set0=true)

virtual void	resynch (_UNUSED Star *s)

virtual void	set_empty (_UNUSED Star *s)

virtual void	set_empty_in_bse (_UNUSED Star s, _UNUSED Binstar b)

virtual void	evolve_empty (_UNUSED Star *s)

virtual void	set_remnant_in_bse (_UNUSED Star s, _UNUSED Binstar b)

virtual size_t	TabID ()

virtual void	special_evolve (_UNUSED Star *s)

virtual void	evolve_fake (Star *s)

virtual void	init (_UNUSED const double &a)

virtual void	evolve_real ()

virtual void	update_from_binary (_UNUSED Star s, const double &DV, _UNUSED Binstar b=nullptr)

virtual void	update_variation ()

virtual void	correct_interpolation_errors (_UNUSED Star *s)

virtual void	correct_interpolation_errors_real (_UNUSED Star *s)

virtual void	restore ()

virtual void	reset ()

virtual void	changed_track (_UNUSED Star s, _UNUSED Star s_jtrack)

virtual double	get_fk (_UNUSED const Star *s=nullptr)

virtual double	get_0_fk (_UNUSED const Star *s=nullptr)

virtual double	get (_UNUSED const Star *s=nullptr)

virtual double	get_0 (_UNUSED const Star *s=nullptr)

double	get_fk_raw (_UNUSED const Star *s=NULL) const

double	get_0_fk_raw (_UNUSED const Star *s=NULL) const

double	get_raw (_UNUSED const Star *s=NULL) const

double	get_0_raw (_UNUSED const Star *s=NULL) const

virtual double	get_Vlast (_UNUSED const Star *s) const

double *	get_wm ()

double *	get_wz ()

virtual void	set_w (_UNUSED Star *s)

virtual bool	are_table_loaded () const

virtual void	set_refpointers (_UNUSED Star *s)

Static Public Member Functions
static size_t	size ()

Public Attributes
double *	val_ref [4]

double *	val_in [4]

Static Public Attributes
static size_t	ID

static Xspin	_xspin

static _PrintMap	PrintMap

static vector< Property * >	all

Protected Member Functions
void	set_fk (const double &a)

void	set_0_fk (const double &a)

virtual void	set (const double &a)

virtual void	set_0 (const double &a)

void	set_VBIN (const size_t &id, const double &a)

virtual void	safety_check ()

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

Protected Attributes
double	value

double	value0

double	Dvalue

double	V

double	V0

vector< double >	VBIN

double	interpolating_values [4]

double	wM [4]

double	wZ [2]

SevnLogging	svlog

Static Protected Attributes
static size_t	_size = 0

Private Member Functions
void	copy_V_from (_UNUSED Property *p) override

virtual bool	amiderived ()

void	synch () override

void	evolve_nakedco (_UNUSED Star *s)

void	update_derived (Star *s) override

Detailed Description

Black hole spin, it is classified as a derived property since it could be updated during the BSE

Member Typedef Documentation

◆ _PrintMap

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

inherited

Constructor & Destructor Documentation

◆ Xspin()

Xspin::Xspin ( bool reg = true )

inline

Member Function Documentation

◆ amiderived()

virtual bool Derived_Property::amiderived ( )

inlineprivatevirtualinherited

Check if this is a derived. A property is defined dervied if it is estimated by the combination of other properties and it is not the derivative of a property.

Returns: true if it is derived, false if it is not (overrided in the derived properties)

Reimplemented from Property.

◆ are_table_loaded()

virtual bool Property::are_table_loaded ( ) const

inlinevirtualinherited

Reimplemented in TableProperty.

◆ changed_track()

virtual void Property::changed_track	(	_UNUSED Star *	s,
		_UNUSED Star *	s_jtrack
	)

inlinevirtualinherited

Handle the modification of the property after a track change. It does nothing by default.

Parameters

s	The star for which we are changing the tracks.
s_jtrack	The star that we are using to get info of the new tracks.

Reimplemented in Localtime, Timestep, Radius, Mass, MHE, MCO, Phase, Luminosity, Inertia, RHE, RCO, Hsup, HEsup, Csup, Nsup, Osup, Qconv, Tconv, Depthconv, dMcumul_binary, AngMomSpin, and Temperature.

◆ copy_V_from() [1/2]

void Derived_Property::copy_V_from ( _UNUSED Property * p )

inlineoverrideprivateinherited

Disable copy

Parameters

◆ copy_V_from() [2/2]

virtual void Property::copy_V_from ( Property * p )

inlinevirtualinherited

Reimplemented in R_object, and Mass_obejct.

◆ correct_interpolation_errors()

virtual void Property::correct_interpolation_errors ( _UNUSED Star * s )

inlinevirtualinherited

Reimplemented in Mass, MHE, MCO, RHE, and RCO.

◆ correct_interpolation_errors_real()

virtual void Property::correct_interpolation_errors_real ( _UNUSED Star * s )

inlinevirtualinherited

Reimplemented in Mass, MHE, MCO, Inertia, RHE, and RCO.

◆ evolve()

void Xspin::evolve ( _UNUSED Star * s )

inlineoverridevirtual

Reimplemented from Property.

◆ evolve_empty()

virtual void Property::evolve_empty ( _UNUSED Star * s )

inlinevirtualinherited

Reimplemented in Time_object, Timestep, Phase, RemnantType, and JIT_Property.

◆ evolve_fake()

void Property::evolve_fake ( Star * s )

virtualinherited

Set v0=v

Move to new value in the interpolating track

Find new values at times t for the interpolatring tracks using linear interpolation

Find the interpolating z value, M1*v1 + M2*v2

Find the final interpolated value, v=Z1*v1 + Z2*v2

Reimplemented in Radius.

◆ evolve_nakedco()

void Derived_Property::evolve_nakedco ( _UNUSED Star * s )

inlineprivatevirtualinherited

Reimplemented from Property.

Reimplemented in JIT_Property, Lambda, Ebind, Zams, and Zmet.

◆ evolve_real()

virtual void Property::evolve_real ( )

inlinevirtualinherited

◆ evolve_remnant()

void Xspin::evolve_remnant ( _UNUSED Star * s )

overridevirtual

Reimplemented from Derived_Property.

◆ get()

virtual double Property::get ( _UNUSED const Star * s = nullptr )

inlinevirtualinherited

Reimplemented in Radius, Luminosity, Inertia, Lambda, Ebind, PhaseBSE, Zams, Zmet, Event, dMRLOdt, dMaccwinddt, NSsalpha, and Plife.

◆ get_0()

virtual double Property::get_0 ( _UNUSED const Star * s = nullptr )

inlinevirtualinherited

Reimplemented in Radius, Luminosity, Inertia, and JIT_Property.

◆ get_0_fk()

virtual double Property::get_0_fk ( _UNUSED const Star * s = nullptr )

inlinevirtualinherited

Reimplemented in Radius, Luminosity, Inertia, and JIT_Property.

◆ get_0_fk_raw()

double Property::get_0_fk_raw ( _UNUSED const Star * s = NULL ) const

inlineinherited

◆ get_0_raw()

double Property::get_0_raw ( _UNUSED const Star * s = NULL ) const

inlineinherited

◆ get_fk()

virtual double Property::get_fk ( _UNUSED const Star * s = nullptr )

inlinevirtualinherited

Here Star is optional, because it is needed only by property that have to estimate V on the fly. Notice that const Star*s means that inside the function we can only call method that we are sure will not change the Star s.

Reimplemented in Radius, Luminosity, Inertia, and JIT_Property.

◆ get_fk_raw()

double Property::get_fk_raw ( _UNUSED const Star * s = NULL ) const

inlineinherited

◆ get_raw()

double Property::get_raw ( _UNUSED const Star * s = NULL ) const

inlineinherited

◆ get_Vlast()

virtual double Property::get_Vlast ( _UNUSED const Star * s ) const

inlinevirtualinherited

Get the value of the property expected at the end of the evolution (before becoming a remnant). It is based on the last values of the tables.

Parameters

s	Pointer to the star

Returns: The value of the property at the end of the evolution estimated as the weighted mean of the interpolating track values

◆ get_wm()

double * Property::get_wm ( )

inlineinherited

◆ get_wz()

double * Property::get_wz ( )

inlineinherited

◆ init()

virtual void Property::init ( _UNUSED const double & a )

inlinevirtualinherited

◆ Instance()

Xspin * Xspin::Instance ( )

inlineoverridevirtual

Implements Property.

◆ name()

std::string Xspin::name ( ) const

inlineoverridevirtual

Reimplemented from Property.

◆ Register()

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

inlineprotectedinherited

◆ reset()

virtual void Property::reset ( )

inlinevirtualinherited

Reset to 0

◆ restore()

virtual void Property::restore ( )

inlinevirtualinherited

Reimplemented in NextOutput, and JIT_Property.

◆ resynch() [1/2]

virtual void Property::resynch	(	_UNUSED const double &	dt,
		_UNUSED bool	set0 = `true`
	)

inlinevirtualinherited

◆ resynch() [2/2]

virtual void Property::resynch ( _UNUSED Star * s )

inlinevirtualinherited

◆ safety_check()

virtual void Property::safety_check ( )

inlineprotectedvirtualinherited

Reimplemented in Radius, and Mass.

◆ set()

virtual void Property::set ( const double & a )

inlineprotectedvirtualinherited

Reimplemented in Radius, and JIT_Property.

◆ set_0()

virtual void Property::set_0 ( const double & a )

inlineprotectedvirtualinherited

Reimplemented in Radius.

◆ set_0_fk()

void Property::set_0_fk ( const double & a )

inlineprotectedinherited

◆ set_empty()

virtual void Property::set_empty ( _UNUSED Star * s )

inlinevirtualinherited

Reimplemented in Time_object, Timestep, Phase, RemnantType, and JIT_Property.

◆ set_empty_in_bse()

virtual void Property::set_empty_in_bse	(	_UNUSED Star *	s,
		_UNUSED Binstar *	b
	)

inlinevirtualinherited

Set empty method to be used during BSE evolution

Parameters

s	pointer to Star
b	pointer to Binary

Reimplemented in Timestep.

◆ set_fk()

void Property::set_fk ( const double & a )

inlineprotectedinherited

◆ set_refpointers()

virtual void Property::set_refpointers ( _UNUSED Star * s )

inlinevirtualinherited

Reimplemented in TableProperty, OptionalTableProperty, Inertia, RHE, RCO, SurfaceAbundanceTable, and ConvectiveTable.

◆ set_remnant()

void Xspin::set_remnant ( _UNUSED Star * s )

overridevirtual

Xspin (black hole spin) properties

Reimplemented from Derived_Property.

◆ set_remnant_in_bse()

virtual void Property::set_remnant_in_bse	(	_UNUSED Star *	s,
		_UNUSED Binstar *	b
	)

inlinevirtualinherited

Set remnant method to be used during BSE evolution

Parameters

s	pointer to Star
b	pointer to Binary

Reimplemented in Timestep.

◆ set_VBIN()

void Property::set_VBIN	(	const size_t &	id,
		const double &	a
	)

inlineprotectedinherited

◆ set_w()

virtual void Property::set_w ( _UNUSED Star * s )

inlinevirtualinherited

Reimplemented in TableProperty.

◆ size()

static size_t Property::size ( )

inlinestaticinherited

◆ special_evolve()

virtual void Property::special_evolve ( _UNUSED Star * s )

inlinevirtualinherited

Reimplemented in Localtime, Worldtime, and Phase.

◆ synch()

void Derived_Property::synch ( )

inlineoverrideprivatevirtualinherited

Reimplemented from Property.

Reimplemented in Spin, and JIT_Property.

◆ TabID()

virtual size_t Property::TabID ( )

inlinevirtualinherited

◆ units()

virtual std::string Property::units ( )

inlinevirtualinherited

Reimplemented in Bmag, OmegaRem, Time_object, R_object, Mass_obejct, AngMomSpin, dMdt, dMHEdt, dMCOdt, dRdt, Temperature, Rs, OmegaSpin, Spin, Lambda, Ebind, PhaseBSE, Zams, Zmet, dMRLOdt, dMaccwinddt, NSsalpha, and Plife.

◆ update_derived() [1/2]

virtual void Property::update_derived ( _UNUSED Star * s )

inlinevirtualinherited

This function can be called to update the value of V in derived proprties (without setting V0) It is empty for all the others. This is needed since after a binary evolution, the derived properties have to be updated without setting V0 (same as update_from_binary).

Reimplemented in JIT_Property.

◆ update_derived() [2/2]

void Derived_Property::update_derived ( Star * s )

overrideprivateinherited

◆ update_from_binary()

virtual void Property::update_from_binary	(	_UNUSED Star *	s,
		const double &	DV,
		_UNUSED Binstar *	b = `nullptr`
	)

inlinevirtualinherited

Reimplemented in dMcumul_RLO, and Radius.

◆ update_variation()

virtual void Property::update_variation ( )

inlinevirtualinherited

Member Data Documentation

◆ _size

size_t Property::_size = 0

staticprotectedinherited

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

◆ _xspin

Xspin Xspin::_xspin

static

◆ all

vector< Property * > Property::all

staticinherited

◆ Dvalue

double Property::Dvalue

protectedinherited

◆ ID

size_t Xspin::ID

static

◆ interpolating_values

double Property::interpolating_values[4]

protectedinherited

◆ PrintMap

Property::_PrintMap Property::PrintMap

staticinherited

◆ svlog

SevnLogging Property::svlog

protectedinherited

◆ V

double Property::V

protectedinherited

◆ V0

double Property::V0

protectedinherited

◆ val_in

double* Property::val_in[4]

inherited

◆ val_ref

double* Property::val_ref[4]

inherited

◆ value

double Property::value

protectedinherited

◆ value0

double Property::value0

protectedinherited

◆ VBIN

vector<double> Property::VBIN

protectedinherited

◆ wM

double Property::wM[4]

protectedinherited

◆ wZ

double Property::wZ[2]

protectedinherited

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

/Users/giulianoiorio/Documents/sevn_public/src/star/property.h
/Users/giulianoiorio/Documents/sevn_public/src/star/property.cpp
/Users/giulianoiorio/Documents/sevn_public/include/static_main.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ _PrintMap

Constructor & Destructor Documentation

◆ Xspin()

Member Function Documentation

◆ amiderived()

◆ are_table_loaded()

◆ changed_track()

◆ copy_V_from() [1/2]

◆ copy_V_from() [2/2]

◆ correct_interpolation_errors()

◆ correct_interpolation_errors_real()

◆ evolve()

◆ evolve_empty()

◆ evolve_fake()

◆ evolve_nakedco()

◆ evolve_real()

◆ evolve_remnant()

◆ get()

◆ get_0()

◆ get_0_fk()

◆ get_0_fk_raw()

◆ get_0_raw()

◆ get_fk()

◆ get_fk_raw()

◆ get_raw()

◆ get_Vlast()

◆ get_wm()

◆ get_wz()

◆ init()

◆ Instance()

◆ name()

◆ Register()

◆ reset()

◆ restore()

◆ resynch() [1/2]

◆ resynch() [2/2]

◆ safety_check()

◆ set()

◆ set_0()

◆ set_0_fk()

◆ set_empty()

◆ set_empty_in_bse()

◆ set_fk()

◆ set_refpointers()

◆ set_remnant()

◆ set_remnant_in_bse()

◆ set_VBIN()

◆ set_w()

◆ size()

◆ special_evolve()

◆ synch()

◆ TabID()

◆ units()

◆ update_derived() [1/2]

◆ update_derived() [2/2]

◆ update_from_binary()

◆ update_variation()

Member Data Documentation

◆ _size

◆ _xspin

◆ all

◆ Dvalue

◆ ID

◆ interpolating_values

◆ PrintMap

◆ svlog

◆ V

◆ V0

◆ val_in