SEVN: Orbital_change_Tides Class Reference

Searching...

No Matches

#include <Orbit.h>

Inheritance diagram for Orbital_change_Tides:

Public Member Functions
	Orbital_change_Tides ()

virtual	~Orbital_change_Tides ()

virtual Orbital_change_Tides *	instance ()

std::string	name () override

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_Tides *	Instance (const std::string &name)

Protected Member Functions
void	Register (Orbital_change_Tides *ptr, const std::string &_name)

virtual double	get_tconv (_UNUSED Star star_wtides, _UNUSED Binstar b)
	Override this in derived class. More...

double	compute_kt_zahn_conv (double Mass, double Menv_cnv, double t_cnv, double tide_freq)

virtual double	compute_kt_zahn_conv (Star star_wtides, Binstar binstar)

double	compute_kt_zahn_rad (Star star_wtides, Star star_pert, Binstar *binstar)

double	compute_tconv_rasio96 (Star star_wtides, Binstar b)

double	compute_tconv_pwheel18 (Star star_wtides, Binstar b)

double	dadt_hut (Star star_wtides, Star star_pert, Binstar *binstar, double kt, double spin)

double	dedt_hut (Star star_wtides, Star star_pert, Binstar *binstar, double kt, double spin)

double	dspindt_hut (Star star_wtides, Star star_pert, Binstar *binstar, double kt, double spin)

virtual double	Mcnv (Star *star_wtides) const

virtual double	Dcnv (Star *star_wtides) const

Static Protected Member Functions
static double	f1 (double e2)

static double	f2 (double e2)

static double	f3 (double e2)

static double	f4 (double e2)

static double	f5 (double e2)

static double	pseudosync_spin (double e2, double omegaorb)

Protected Attributes
SevnLogging	svlog

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

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

Constructor & Destructor Documentation

◆ Orbital_change_Tides()

Orbital_change_Tides::Orbital_change_Tides ( )

inline

◆ ~Orbital_change_Tides()

virtual Orbital_change_Tides::~Orbital_change_Tides ( )

inlinevirtual

Member Function Documentation

◆ compute_kt_zahn_conv() [1/2]

double Orbital_change_Tides::compute_kt_zahn_conv	(	double	Mass,
		double	Menv_cnv,
		double	t_cnv,
		double	tide_freq
	)

protected

Compute kt in convective envelopes

Parameters

Mass	Total mass of the star [Msun]
Menv_cnv	mass of the convective envelope [Msun]
t_cnv	Convective turnover time [yr]
tide_freq	Spin frequency [yr^-1]

Returns: Return the kt in yr^-1

◆ compute_kt_zahn_conv() [2/2]

virtual double Orbital_change_Tides::compute_kt_zahn_conv	(	Star *	star_wtides,
		Binstar *	binstar
	)

protectedvirtual

Computes kt in convective envelopes in star_wtides Output is in yr^-1

◆ compute_kt_zahn_rad()

double Orbital_change_Tides::compute_kt_zahn_rad	(	Star *	star_wtides,
		Star *	star_pert,
		Binstar *	binstar
	)

protected

Computes kt in radiative envelopes in star_wtides induced by star_pert Output is in yr^-1

◆ compute_tconv_pwheel18()

double Orbital_change_Tides::compute_tconv_pwheel18	(	Star *	star_wtides,
		Binstar *	b
	)

protected

Should be mass of convective envelope

< In years

◆ compute_tconv_rasio96()

double Orbital_change_Tides::compute_tconv_rasio96	(	Star *	star_wtides,
		Binstar *	b
	)

protected

Should be depth of convective envelope

Should be mass of convective envelope

Modification from Hurley+ 2002 Eq 31

< l_t from LSun is converted to MSun RSun^2 yr^-3

◆ DA()

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

inlinevirtualinherited

Reimplemented in Peters_gw, Hurley_rl, Hurley_SNKicks, and Tides_simple.

◆ dadt_hut()

double Orbital_change_Tides::dadt_hut	(	Star *	star_wtides,
		Star *	star_pert,
		Binstar *	binstar,
		double	kt,
		double	spin
	)

protected

Returns da/dt from the tides induced from star_pert on star_wtides Eq 9 Hut 81

◆ DAngMomSpin()

virtual double Orbital_change::DAngMomSpin	(	_UNUSED Binstar *	b,
		_UNUSED int	procID,
		_UNUSED int	starID
	)

inlinevirtualinherited

Reimplemented in Tides_simple, and Hurley_rl.

◆ Dcnv()

double Orbital_change_Tides::Dcnv ( Star * star_wtides ) const

protectedvirtual

Depth of the convective envelope in Rsun, the depth is calculated from the surface torward the inner parts

Parameters

star_wtides Pointer to the star

Reimplemented in Tides_simple_notab.

◆ DE()

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

inlinevirtualinherited

Reimplemented in Peters_gw, Hurley_rl, Hurley_SNKicks, and Tides_simple.

◆ dedt_hut()

double Orbital_change_Tides::dedt_hut	(	Star *	star_wtides,
		Star *	star_pert,
		Binstar *	binstar,
		double	kt,
		double	spin
	)

protected

Returns de/dt from the tides induced from star_wtides on star_pert Eq 10 Hut 81

◆ DM()

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

inlinevirtualinherited

Reimplemented in Orbital_change_RL.

◆ dspindt_hut()

double Orbital_change_Tides::dspindt_hut	(	Star *	star_wtides,
		Star *	star_pert,
		Binstar *	binstar,
		double	kt,
		double	spin
	)

protected

Returns dspin/dt from the tides induced from star_wtides on star_pert Eq 11 Hut 81

◆ f1()

static double Orbital_change_Tides::f1 ( double e2 )

inlinestaticprotected

◆ f2()

static double Orbital_change_Tides::f2 ( double e2 )

inlinestaticprotected

◆ f3()

static double Orbital_change_Tides::f3 ( double e2 )

inlinestaticprotected

◆ f4()

static double Orbital_change_Tides::f4 ( double e2 )

inlinestaticprotected

◆ f5()

static double Orbital_change_Tides::f5 ( double e2 )

inlinestaticprotected

◆ get_tconv()

virtual double Orbital_change_Tides::get_tconv	(	_UNUSED Star *	star_wtides,
		_UNUSED Binstar *	b
	)

inlineprotectedvirtual

Override this in derived class.

◆ GetStaticMap()

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

inlinestaticprivate

◆ GetUsed()

static std::vector< int > & Orbital_change_Tides::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

Reimplemented in Orbital_change_RL, Hurley_rl, Hurley_SNKicks, and Tides_simple.

◆ instance()

virtual Orbital_change_Tides * Orbital_change_Tides::instance ( )

inlinevirtual

Reimplemented in disabled_tides, Tides_simple, and Tides_simple_notab.

◆ Instance()

Orbital_change_Tides * Orbital_change_Tides::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.

◆ Mcnv()

double Orbital_change_Tides::Mcnv ( Star * star_wtides ) const

protectedvirtual

Mass of the convective envelope in Msun

Parameters

star_wtides Pointer to the star

Reimplemented in Tides_simple_notab.

◆ name()

std::string Orbital_change_Tides::name ( )

inlineoverridevirtual

Reimplemented from Orbital_change.

Reimplemented in disabled_tides, Tides_simple, and Tides_simple_notab.

◆ pseudosync_spin()

static double Orbital_change_Tides::pseudosync_spin	(	double	e2,
		double	omegaorb
	)

inlinestaticprotected

◆ Register()

void Orbital_change_Tides::Register	(	Orbital_change_Tides *	ptr,
		const std::string &	_name
	)

inlineprotected

◆ set_options()

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

inlinevirtualinherited

◆ 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

b	Pointer to the binary.

Returns

Reimplemented in Orbital_change_RL.

Member Data Documentation

◆ svlog

SevnLogging Orbital_change::svlog

protectedinherited

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

/Users/giulianoiorio/Documents/sevn_public/src/binstar/Orbit.h
/Users/giulianoiorio/Documents/sevn_public/src/binstar/Orbit.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Private Member Functions

Constructor & Destructor Documentation

◆ Orbital_change_Tides()

◆ ~Orbital_change_Tides()

Member Function Documentation

◆ compute_kt_zahn_conv() [1/2]

◆ compute_kt_zahn_conv() [2/2]

◆ compute_kt_zahn_rad()

◆ compute_tconv_pwheel18()

◆ compute_tconv_rasio96()

◆ DA()

◆ dadt_hut()

◆ DAngMomSpin()

◆ Dcnv()

◆ DE()

◆ dedt_hut()

◆ DM()

◆ dspindt_hut()

◆ f1()

◆ f2()

◆ f3()

◆ f4()

◆ f5()

◆ get_tconv()

◆ GetStaticMap()

◆ GetUsed()

◆ init()

◆ instance()

◆ Instance()

◆ is_process_ongoing()

◆ Mcnv()

◆ name()

◆ pseudosync_spin()

◆ Register()

◆ set_options()

◆ speciale_evolve()

Member Data Documentation

◆ svlog