TwoBodyTide Class Reference

Two Body Tide effct. More...

#include <two_body_tide.hpp>

Public Member Functions
	TwoBodyTide ()
bool	checkParams ()
	check whether parameters values are correct More...
template<class TBinary >
bool	evolveOrbitHyperbolicGW (TBinary &_bin, Float &_Etid, Float &_Ltid)
	evolve hyperbolic orbit based on GW effect More...
template<class TBinary >
Float	evolveOrbitDynamicalTide (TBinary &_bin, const Float &rad1, const Float &rad2, const Float &poly_type1, const Float &poly_type2)
	evolve two-body orbit based on dynamical tide implementation from Alessandro Alberto Trani More...
Float	calcEtidPolynomicalFit (const Float &_mpert, const Float &_rad_over_peri, const Float &_peri, const Float &_eta, const Float &_poly_type)
	Tidal energy based on Polynomical fits from Portegies Zwart et al. 1993. More...

Public Attributes
Float	gravitational_constant
Float	speed_of_light

Detailed Description

Two Body Tide effct.

calculate orbital change due to dynamical tide or gravitational wave radiation for hyperbolic encounters

Constructor & Destructor Documentation

TwoBodyTide()

TwoBodyTide::TwoBodyTide ( )

inline

Member Function Documentation

calcEtidPolynomicalFit()

Float TwoBodyTide::calcEtidPolynomicalFit ( const Float &  _mpert, const Float &  _rad_over_peri, const Float &  _peri, const Float &  _eta, const Float &  _poly_type  )

inline

Tidal energy based on Polynomical fits from Portegies Zwart et al. 1993.

Parameters

[in]	_mpert	perturber mass
[in]	_rad_over_peri	stellar radius over peri-center distance
[in]	_peri	peri-center distance
[in]	_eta	parameter (Press & Teutoslky 1977)
[in]	_poly_type	Polynomical type (1.5 or 3.0)

Here is the caller graph for this function:

checkParams()

bool TwoBodyTide::checkParams ( )

inline

check whether parameters values are correct

Returns

true: all correct

Here is the caller graph for this function:

evolveOrbitDynamicalTide()

template<class TBinary >

Float TwoBodyTide::evolveOrbitDynamicalTide ( TBinary &  _bin, const Float &  rad1, const Float &  rad2, const Float &  poly_type1, const Float &  poly_type2  )

inline

evolve two-body orbit based on dynamical tide implementation from Alessandro Alberto Trani

Parameters

[in,out]	_bin	binary data, semi and ecc are updated
[in]	rad1	stellar radius of p1 (should be in the same unit of semi)
[in]	rad2	stellar radius of p2
[in]	poly_type1	polynomial type for p1
[in]	poly_type2	polynomial type for p2

Returns

Etid: energy loss

Here is the call graph for this function:

Here is the caller graph for this function:

evolveOrbitHyperbolicGW()

template<class TBinary >

bool TwoBodyTide::evolveOrbitHyperbolicGW ( TBinary &  _bin, Float &  _Etid, Float &  _Ltid  )

inline

evolve hyperbolic orbit based on GW effect

Parameters

[in]

_bin

binary data, semi and ecc are updated

Returns

Etid: merge flag

Here is the caller graph for this function:

Member Data Documentation

gravitational_constant

Float TwoBodyTide::gravitational_constant

speed_of_light

Float TwoBodyTide::speed_of_light

---

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

• two_body_tide.hpp