Prototypes
int	XLALSimBlackHoleRingdownModeEigenvaluesLeaver (COMPLEX16 A, COMPLEX16 omega, double a, int l, int m, int s)
	Low-level routine that computes the black hole quasinormal mode eigenefrequency, omega, and angular separation constant A for a given (l,m) mode and spin-weight s (s=-2 for gravitational perturbations). More...

COMPLEX16	XLALSimBlackHoleRingdownSpheroidalWaveFunctionLeaver (double mu, double a, int l, int m, int s, COMPLEX16 A, COMPLEX16 omega)
	Low-level routine that evaluates the spheroidal wave function at a specified value of mu = cos(theta) for a given (l,m) mode and spin-weight s (s=-2 for gravitational perturbations). More...

int	XLALSimBlackHoleRingdownMode (double frequency, double quality, double mass, double dimensionless_spin, int l, int m, int s)
	Computes the frequency and quality factor of a specified quasinormal mode (l,m) of spin weight s perturbations (s=-2 for gravitational perturbations) of a black hole of a specified mass and spin. More...

COMPLEX16	XLALSimBlackHoleRingdownSpheroidalWaveFunction (double theta, double dimensionless_spin, int l, int m, int s)
	Evaluates the value of spheroidal wave function at a given polar angle theta for a specified mode (l,m) and spin weight s (s=-2 for gravitational perturbations) and dimensionless spin parameter. More...

int	XLALSimBlackHoleRingdown (REAL8TimeSeries hplus, REAL8TimeSeries hcross, const LIGOTimeGPS *t0, double phi0, double deltaT, double mass, double dimensionless_spin, double fractional_mass_loss, double distance, double inclination, int l, int m)
	Computes the waveform for the ringdown of a black hole quasinormal mode (l,m). More...

INT4	XLALSimIMREOBFinalMassSpin (REAL8 finalMass, REAL8 finalSpin, const REAL8 mass1, const REAL8 mass2, const REAL8 spin1[3], const REAL8 spin2[3], Approximant approximant)
	Computes the final mass and spin of the black hole resulting from merger. More...

INT4	XLALSimIMREOBGenerateQNMFreqV2 (COMPLEX16Vector *modefreqs, const REAL8 mass1, const REAL8 mass2, const REAL8 spin1[3], const REAL8 spin2[3], UINT4 l, INT4 m, UINT4 nmodes, Approximant approximant)
	These functions generate the quasinormal mode frequencies for a black hole ringdown. More...

INT4	XLALSimIMREOBGenerateQNMFreqV2fromFinal (COMPLEX16Vector *modefreqs, const REAL8 finalMass, const REAL8 finalSpin, UINT4 l, INT4 m, UINT4 nmodes)

INT4	XLALSimIMREOBGenerateQNMFreqV5 (COMPLEX16Vector *modefreqs, const REAL8 mass1, const REAL8 mass2, const REAL8 spin1[3], const REAL8 spin2[3], UINT4 l, INT4 m, UINT4 nmodes, Approximant approximant)
	These functions generate the quasinormal mode frequencies for a black hole ringdown, as implemented in the SEOBNRv5HM model. More...

INT4	XLALSimIMREOBGenerateQNMFreqV5fromFinal (COMPLEX16Vector *modefreqs, const REAL8 finalMass, const REAL8 finalSpin, UINT4 l, INT4 m, UINT4 nmodes)

REAL8	XLALSimRadiusKerrISCO (REAL8 a)

REAL8	XLALSimEnergyKerrISCO (REAL8 rISCO)

REAL8	XLALSimAngMomKerrISCO (REAL8 rISCO)

Variables
static const REAL8	p0coeff = 0.04826

static const REAL8	p1coeff = 0.01559

static const REAL8	p2coeff = 0.00485

static const REAL8	t0coeff = -2.8904

static const REAL8	t2coeff = -3.5171

static const REAL8	t3coeff = 2.5763

static const REAL8	s4coeff = -0.1229

static const REAL8	s5coeff = 0.4537

static const REAL8	s9coeff = 2.763032781169752

static const REAL8	s8coeff = -2.6081232221537394

static const REAL8	s7coeff = 1.2657111864932808

static const REAL8	s6coeff = -0.7835007857591175

static const REAL8	s5v2coeff = -0.3264724801557159

static const REAL8	s4v2coeff = -0.27506210736300474

static const REAL8	t0v2coeff = -2.649826989941522

static const REAL8	t3v2coeff = 3.910637513328723

static const REAL8	t2v2coeff = -3.850983155206041

static const REAL8	k00 = -5.977230835551017

static const REAL8	k01 = 3.39221

static const REAL8	k02 = 4.48865

static const REAL8	k03 = -5.77101

static const REAL8	k04 = -13.0459

static const REAL8	k10 = 35.1278

static const REAL8	k11 = -72.9336

static const REAL8	k12 = -86.0036

static const REAL8	k13 = 93.7371

static const REAL8	k14 = 200.975

static const REAL8	k20 = - 146.822

static const REAL8	k21 = 387.184

static const REAL8	k22 = 447.009

static const REAL8	k23 = -467.383

static const REAL8	k24 = -884.339

static const REAL8	k30 = 223.911

static const REAL8	k31 = -648.502

static const REAL8	k32 = -697.177

static const REAL8	k33 = 753.738

static const REAL8	k34 = 1166.89

Function Documentation

◆ XLALSimIMREOBGenerateQNMFreqV5()

INT4 XLALSimIMREOBGenerateQNMFreqV5	(	COMPLEX16Vector *	modefreqs,
		const REAL8	mass1,
		const REAL8	mass2,
		const REAL8	spin1[3],
		const REAL8	spin2[3],
		UINT4	l,
		INT4	m,
		UINT4	nmodes,
		Approximant	approximant
	)

These functions generate the quasinormal mode frequencies for a black hole ringdown, as implemented in the SEOBNRv5HM model.

At present, this function works for the 22, 21, 33, 44, 55, 32 and 43 modes, and includes only the n=0 overtone. The final frequencies are computed using the qnm python package https://arxiv.org/abs/1908.10377, as also done in SEOBNRv5HM.

Parameters

modefreqs	< OUTPUT, complex freqs of overtones in unit of Hz
mass1	< The mass of the 1st component (in Solar masses)
mass2	< The mass of the 2nd component (in Solar masses)
spin1	< The spin of the 1st object; only needed for spin waveforms
spin2	< The spin of the 2nd object; only needed for spin waveforms
l	< The l value of the mode in question
m	< The m value of the mode in question
nmodes	< The number of overtones that should be included (max 8)
approximant	< The waveform approximant being used

Definition at line 2654 of file LALSimBlackHoleRingdown.c.

◆ XLALSimIMREOBGenerateQNMFreqV5fromFinal()

INT4 XLALSimIMREOBGenerateQNMFreqV5fromFinal	(	COMPLEX16Vector *	modefreqs,
		const REAL8	finalMass,
		const REAL8	finalSpin,
		UINT4	l,
		INT4	m,
		UINT4	nmodes
	)

Parameters

modefreqs	< OUTPUT, complex freqs of overtones in unit of Hz
finalMass	< The mass of the final black hole (in Solar masses)
finalSpin	< The spin of the final object; only needed for spin waveforms
l	< The l value of the mode in question
m	< The m value of the mode in question
nmodes	< The number of overtones that should be included (max 8)

Definition at line 2691 of file LALSimBlackHoleRingdown.c.

Variable Documentation

◆ p0coeff

const REAL8 p0coeff = 0.04826

static

Definition at line 70 of file LALSimBlackHoleRingdown.h.

◆ p1coeff

const REAL8 p1coeff = 0.01559

static

Definition at line 71 of file LALSimBlackHoleRingdown.h.

◆ p2coeff

const REAL8 p2coeff = 0.00485

static

Definition at line 72 of file LALSimBlackHoleRingdown.h.

◆ t0coeff

const REAL8 t0coeff = -2.8904

static

Definition at line 74 of file LALSimBlackHoleRingdown.h.

◆ t2coeff

const REAL8 t2coeff = -3.5171

static

Definition at line 75 of file LALSimBlackHoleRingdown.h.

◆ t3coeff

const REAL8 t3coeff = 2.5763

static

Definition at line 76 of file LALSimBlackHoleRingdown.h.

◆ s4coeff

const REAL8 s4coeff = -0.1229

static

Definition at line 77 of file LALSimBlackHoleRingdown.h.

◆ s5coeff

const REAL8 s5coeff = 0.4537

static

Definition at line 78 of file LALSimBlackHoleRingdown.h.

◆ s9coeff

const REAL8 s9coeff = 2.763032781169752

static

Definition at line 80 of file LALSimBlackHoleRingdown.h.

◆ s8coeff

const REAL8 s8coeff = -2.6081232221537394

static

Definition at line 81 of file LALSimBlackHoleRingdown.h.

◆ s7coeff

const REAL8 s7coeff = 1.2657111864932808

static

Definition at line 82 of file LALSimBlackHoleRingdown.h.

◆ s6coeff

const REAL8 s6coeff = -0.7835007857591175

static

Definition at line 83 of file LALSimBlackHoleRingdown.h.

◆ s5v2coeff

const REAL8 s5v2coeff = -0.3264724801557159

static

Definition at line 84 of file LALSimBlackHoleRingdown.h.

◆ s4v2coeff

const REAL8 s4v2coeff = -0.27506210736300474

static

Definition at line 85 of file LALSimBlackHoleRingdown.h.

◆ t0v2coeff

const REAL8 t0v2coeff = -2.649826989941522

static

Definition at line 86 of file LALSimBlackHoleRingdown.h.

◆ t3v2coeff

const REAL8 t3v2coeff = 3.910637513328723

static

Definition at line 87 of file LALSimBlackHoleRingdown.h.

◆ t2v2coeff

const REAL8 t2v2coeff = -3.850983155206041

static

Definition at line 88 of file LALSimBlackHoleRingdown.h.

◆ k00

const REAL8 k00 = -5.977230835551017

static

Definition at line 92 of file LALSimBlackHoleRingdown.h.

◆ k01

const REAL8 k01 = 3.39221

static

Definition at line 93 of file LALSimBlackHoleRingdown.h.

◆ k02

const REAL8 k02 = 4.48865

static

Definition at line 94 of file LALSimBlackHoleRingdown.h.

◆ k03

const REAL8 k03 = -5.77101

static

Definition at line 95 of file LALSimBlackHoleRingdown.h.

◆ k04

const REAL8 k04 = -13.0459

static

Definition at line 96 of file LALSimBlackHoleRingdown.h.

◆ k10

const REAL8 k10 = 35.1278

static

Definition at line 97 of file LALSimBlackHoleRingdown.h.

◆ k11

const REAL8 k11 = -72.9336

static

Definition at line 98 of file LALSimBlackHoleRingdown.h.

◆ k12

const REAL8 k12 = -86.0036

static

Definition at line 99 of file LALSimBlackHoleRingdown.h.

◆ k13

const REAL8 k13 = 93.7371

static

Definition at line 100 of file LALSimBlackHoleRingdown.h.

◆ k14

const REAL8 k14 = 200.975

static

Definition at line 101 of file LALSimBlackHoleRingdown.h.

◆ k20

const REAL8 k20 = - 146.822

static

Definition at line 102 of file LALSimBlackHoleRingdown.h.

◆ k21

const REAL8 k21 = 387.184

static

Definition at line 103 of file LALSimBlackHoleRingdown.h.

◆ k22

const REAL8 k22 = 447.009

static

Definition at line 104 of file LALSimBlackHoleRingdown.h.

◆ k23

const REAL8 k23 = -467.383

static

Definition at line 105 of file LALSimBlackHoleRingdown.h.

◆ k24

const REAL8 k24 = -884.339

static

Definition at line 106 of file LALSimBlackHoleRingdown.h.

◆ k30

const REAL8 k30 = 223.911

static

Definition at line 107 of file LALSimBlackHoleRingdown.h.

◆ k31

const REAL8 k31 = -648.502

static

Definition at line 108 of file LALSimBlackHoleRingdown.h.

◆ k32

const REAL8 k32 = -697.177

static

Definition at line 109 of file LALSimBlackHoleRingdown.h.

◆ k33

const REAL8 k33 = 753.738

static

Definition at line 110 of file LALSimBlackHoleRingdown.h.

◆ k34

const REAL8 k34 = 1166.89

static

Definition at line 111 of file LALSimBlackHoleRingdown.h.

Prototypes

Variables

Function Documentation

◆ XLALSimIMREOBGenerateQNMFreqV5()

◆ XLALSimIMREOBGenerateQNMFreqV5fromFinal()

Variable Documentation

◆ p0coeff

◆ p1coeff

◆ p2coeff

◆ t0coeff

◆ t2coeff

◆ t3coeff

◆ s4coeff

◆ s5coeff

◆ s9coeff

◆ s8coeff

◆ s7coeff

◆ s6coeff

◆ s5v2coeff

◆ s4v2coeff

◆ t0v2coeff

◆ t3v2coeff

◆ t2v2coeff

◆ k00

◆ k01

◆ k02

◆ k03

◆ k04

◆ k10

◆ k11

◆ k12

◆ k13

◆ k14

◆ k20

◆ k21

◆ k22

◆ k23

◆ k24

◆ k30

◆ k31

◆ k32

◆ k33

◆ k34