Prototypes
static UNUSED bool	SEOBNRv5HMROM_IsSetup (UINT4 index_mode, SEOBNRROMdataDS *romdataset)
	Helper function to check if the SEOBNRv5HMROM model has been initialised. More...

static UNUSED void	SEOBNRv5HMROM_Init_LALDATA (void)
	Setup SEOBNRv5HMROM model using data files installed in $LAL_DATA_PATH. More...

static UNUSED void	SEOBNRv5ROM_Init_LALDATA (void)
	Setup SEOBNRv5ROM model using data files installed in $LAL_DATA_PATH. More...

static UNUSED int	SEOBNRv5HMROM_Init (const char dir[], UINT4 index_mode, bool use_hm, SEOBNRROMdataDS *romdataset)
	Setup SEOBNRv5HMROM mode using data files installed in dir. More...

static UNUSED int	SEOBNRROMdataDS_Init (SEOBNRROMdataDS *romdata, const char dir[], UINT4, bool)

static UNUSED void	SEOBNRROMdataDS_Cleanup (SEOBNRROMdataDS *romdata)

static UNUSED int	SEOBNRROMdataDS_Init_submodel (UNUSED SEOBNRROMdataDS_submodel **submodel, UNUSED const char dir[], UNUSED const char grp_name[], UNUSED UINT4 index_mode, UNUSED bool use_hm)

static UNUSED void	SEOBNRROMdataDS_Cleanup_submodel (SEOBNRROMdataDS_submodel *submodel)

static UNUSED void	SplineData_Destroy (SplineData *splinedata)

static UNUSED void	SplineData_Init (SplineData *splinedata, int ncx, int ncy, int ncz, const double qvec, const double chi1vec, const double chi2vec)

static UNUSED void	AmpPhaseSplineData_Init (AmpPhaseSplineData ***data, const int num_modes)

static UNUSED void	AmpPhaseSplineData_Destroy (AmpPhaseSplineData **data, const int num_modes)

static UNUSED int	TaylorF2Amplitude (const double q, const double chi1, const double chi2, const int l, const int m, gsl_vector Mfs, gsl_vector *PNamp)

static UNUSED int	TaylorF2Phasing (double Mtot, double q, double chi1, double chi2, int l, int m, gsl_vector Mfs, gsl_vector *PNphase)

static UNUSED double	GetDeltaphilm (int l, int m)

static UNUSED double	GetModeAmpFactor (double eta, double delta, double chi1, double chi2, int l, int m, double v)

static UNUSED int	BuildInspiralGeomFrequencyGrid (gsl_vector **Mfreq, const double Mfmin, const double Mfmax, const double q, const double acc)

static UNUSED int	SEOBNRv5HMROMCoreModes (SphHarmFrequencySeries *hlm_list, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 Mtot_sec, REAL8 q, REAL8 chi1, REAL8 chi2, const REAL8Sequence freqs, REAL8 deltaF, INT4 nk_max, UINT4 nModes, REAL8 sign_odd_modes, SEOBNRROMdataDS *romdataset)
	Core function for computing the ROM waveform. More...

static UNUSED void	SEOBNRROMdataDS_coeff_Init (SEOBNRROMdataDS_coeff **romdatacoeff, int nk_cmode, int nk_phase)

static UNUSED void	SEOBNRROMdataDS_coeff_Cleanup (SEOBNRROMdataDS_coeff *romdatacoeff)

static size_t	NextPow2 (const size_t n)

static UINT8	Setup_EOBROM__std_mode_array_structure (LALValue *ModeArray, UINT4 nModes)
	ModeArray is a structure which allows to select the modes to include in the waveform. More...

static INT8	Check_EOBROM_mode_array_structure (LALValue *ModeArray, UINT4 nModes)
	ModeArray is a structure which allows to select the modes to include in the waveform. More...

static int	SEOBROMComputehplushcrossFromhlm (COMPLEX16FrequencySeries hplusFS, COMPLEX16FrequencySeries hcrossFS, LALValue ModeArray, SphHarmFrequencySeries hlm, REAL8 inc, REAL8 phi)

static int	TP_Spline_interpolation_3d (REAL8 q, REAL8 chi1, REAL8 chi2, gsl_vector cvec, int nk, int nk_max, int ncx, int ncy, int ncz, const double qvec, const double chi1vec, const double chi2vec, gsl_vector *c_out)

static UNUSED UINT8	SEOBNRv5HMROM_Select_HF_patch (REAL8 q, REAL8 chi1)

static UNUSED UINT8	SEOBNRv5HMROM_phase_sparse_grid (gsl_vector phase_f, REAL8 q, REAL8 chi1, REAL8 chi2, const char freq_range, INT4 nk_max, SEOBNRROMdataDS *romdataset)

static UNUSED UINT8	SEOBNRv5HMROM_cmode_sparse_grid (gsl_vector creal_f, gsl_vector cimag_f, REAL8 q, REAL8 chi1, REAL8 chi2, const char freq_range, UINT8 nMode, INT4 nk_max, SEOBNRROMdataDS romdataset)

static UNUSED UINT8	SEOBNRv5HMROM_phase_sparse_grid_hybrid (gsl_vector freq, gsl_vector phase, gsl_vector freq_lo, gsl_vector freq_hi, REAL8 q, REAL8 chi1, REAL8 chi2, INT4 nk_max, SEOBNRROMdataDS *romdataset)

static UNUSED UINT8	SEOBNRv5HMROM_cmode_sparse_grid_hybrid (gsl_vector freq, gsl_vector cmode_real, gsl_vector cmode_imag, gsl_vector freq_lo, gsl_vector freq_hi, REAL8 q, REAL8 chi1, REAL8 chi2, UINT8 nMode, INT8 nk_max, SEOBNRROMdataDS romdataset)

static UNUSED UINT8	SEOBNRv5HMROM_freq_phase_sparse_grid_hybrid (UNUSED gsl_vector freq, UNUSED gsl_vector phase, REAL8 q, REAL8 chi1, REAL8 chi2, INT4 nk_max, SEOBNRROMdataDS *romdataset)

static UNUSED UINT8	SEOBNRv5HMROM_freq_cmode_sparse_grid_hybrid (gsl_vector freq_cmode, gsl_vector cmode_real, gsl_vector *cmode_imag, REAL8 q, REAL8 chi1, REAL8 chi2, UINT8 nMode, INT8 nk_max, SEOBNRROMdataDS romdataset)

static UNUSED UINT8	SEOBNRv5HMROM_approx_phi_lm (gsl_vector freq_mode_lm, gsl_vector phase_approx_lm, gsl_vector freq_carrier_hyb, gsl_vector phase_carrier_hyb, UINT4 nMode)

static UNUSED UINT8	SEOBNRv5HMROM_phase_sparse_grid_hybrid_output_align (gsl_vector freq, gsl_vector phase, REAL8 Deltat_align, REAL8 Deltaphi_align, gsl_vector phase_lo, gsl_vector phase_hi, gsl_vector freq_lo, gsl_vector freq_hi, double f_hyb_lo, double f_hyb_hi)

static UNUSED UINT8	SEOBNRv5HMROM_phase_sparse_grid_hybrid_input_align (gsl_vector freq, gsl_vector phase, gsl_vector phase_lo, gsl_vector phase_hi, gsl_vector freq_lo, gsl_vector freq_hi, double f_hyb_lo, double f_hyb_hi, REAL8 Deltat_22_align, REAL8 Deltaphi_22_align, INT4 modeM)

static UNUSED UINT8	SEOBNRv5HMROM_amplitude_sparse_grid_hybrid_general (gsl_vector freq, gsl_vector amp, gsl_vector amp_lo, gsl_vector amp_hi, gsl_vector freq_lo, gsl_vector freq_hi, double f_hyb_lo, double f_hyb_hi)

static UNUSED int	hybridize_ROM_with_PN_amplitude (gsl_spline *hyb_spline, AmpPhaseSplineData ampPhaseSplineData_for_mode, gsl_vector PN_freq, gsl_vector PN_amp, double f_hyb_win_lo, double f_hyb_win_hi)

static UNUSED int	hybridize_ROM_with_PN_phase_output_align (gsl_spline *hyb_spline, REAL8 Deltat_align, REAL8 Deltaphi_align, AmpPhaseSplineData ampPhaseSplineData_for_mode, gsl_vector PN_freq, gsl_vector PN_phase, double f_hyb_win_lo, double f_hyb_win_hi)

static UNUSED int	hybridize_ROM_with_PN_phase_input_align (gsl_spline *hyb_spline, AmpPhaseSplineData ampPhaseSplineData_for_mode, gsl_vector PN_freq, gsl_vector PN_phase, double f_hyb_win_lo, double f_hyb_win_hi, REAL8 Deltat_22_align, REAL8 Deltaphi_22_align, INT4 modeM)

static UNUSED int	SEOBNRv5HMROMCoreModeAmpPhaseSplines (UNUSED AmpPhaseSplineData *ampPhaseSplineData, UNUSED REAL8 q, UNUSED REAL8 chi1, UNUSED REAL8 chi2, UNUSED INT4 nk_max, UNUSED UINT4 nModes, UNUSED SEOBNRROMdataDS romdataset)

static UNUSED int	SEOBNRv5HMROMCoreModesHybridized (UNUSED SphHarmFrequencySeries *hlm_list, UNUSED REAL8 phiRef, UNUSED REAL8 fRef, UNUSED REAL8 distance, UNUSED REAL8 Mtot_sec, UNUSED REAL8 q, UNUSED REAL8 chi1, UNUSED REAL8 chi2, UNUSED const REAL8Sequence freqs_in, UNUSED REAL8 deltaF, UNUSED INT4 nk_max, UNUSED UINT4 nModes, REAL8 sign_odd_modes, UNUSED SEOBNRROMdataDS *romdataset)

static UNUSED int	SEOBNRv5ROMTimeFrequencySetup (gsl_spline spline_phi, gsl_interp_accel acc_phi, REAL8 Mf_final, REAL8 Mtot_sec, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, REAL8 Mf_start, REAL8 Mf_ROM_min, REAL8 Mf_ROM_max)

static UNUSED int	spline_to_gsl_vectors (gsl_spline s, gsl_vector x, gsl_vector *y)

int	SEOBNRROMdataDS_Init (UNUSED SEOBNRROMdataDS *romdata, UNUSED const char dir[], UNUSED UINT4 index_mode, UNUSED bool use_hm)

static UNUSED int	SEOBNRROMdataDS_Init_submodel (SEOBNRROMdataDS_submodel **submodel, UNUSED const char dir[], UNUSED const char grp_name[], UNUSED UINT4 index_mode, UNUSED bool use_hm)

static UNUSED int	SEOBNRv5HMROMCoreModes (UNUSED SphHarmFrequencySeries *hlm_list, UNUSED REAL8 phiRef, UNUSED REAL8 fRef, UNUSED REAL8 distance, UNUSED REAL8 Mtot_sec, UNUSED REAL8 q, UNUSED REAL8 chi1, UNUSED REAL8 chi2, UNUSED const REAL8Sequence freqs_in, UNUSED REAL8 deltaF, UNUSED INT4 nk_max, UNUSED UINT4 nModes, REAL8 sign_odd_modes, UNUSED SEOBNRROMdataDS *romdataset)
	Core function for computing the ROM modes. More...

static int	SEOBROMComputehplushcrossFromhlm (COMPLEX16FrequencySeries hplusFS, COMPLEX16FrequencySeries hcrossFS, LALValue ModeArray, SphHarmFrequencySeries hlm, REAL8 inc, UNUSED REAL8 phi)
	This function combines the modes hlm frequencyseries with the sYlm to produce the polarizations hplus, hcross. More...

int	XLALSimIMRSEOBNRv5HMROM (UNUSED struct tagCOMPLEX16FrequencySeries hptilde, UNUSED struct tagCOMPLEX16FrequencySeries hctilde, UNUSED REAL8 phiRef, UNUSED REAL8 deltaF, REAL8 fLow, UNUSED REAL8 fHigh, UNUSED REAL8 fRef, UNUSED REAL8 distance, UNUSED REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, UNUSED INT4 nk_max, UNUSED UINT4 nModes, bool use_hybridization, LALDict *LALParams)
	Compute waveform in LAL format for the SEOBNRv5HM_ROM model. More...

int	XLALSimIMRSEOBNRv5HMROMFrequencySequence (UNUSED struct tagCOMPLEX16FrequencySeries hptilde, UNUSED struct tagCOMPLEX16FrequencySeries hctilde, const REAL8Sequence freqs, UNUSED REAL8 phiRef, UNUSED REAL8 fRef, UNUSED REAL8 distance, UNUSED REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, UNUSED INT4 nk_max, UNUSED UINT4 nModes, LALDict LALParams)
	Compute waveform polarizations at user specified frequencies for the SEOBNRv5HM_ROM model. More...

int	XLALSimIMRSEOBNRv5HMROM_Modes (SphHarmFrequencySeries **hlm, UNUSED REAL8 phiRef, UNUSED REAL8 deltaF, REAL8 fLow, UNUSED REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, UNUSED INT4 nk_max, UNUSED UINT4 nModes, bool use_hybridization)
	Compute modes in LAL format for the SEOBNRv5HM_ROM model. More...

int	XLALSimIMRSEOBNRv5HMROMFrequencySequence_Modes (SphHarmFrequencySeries *hlm, const REAL8Sequence freqs, UNUSED REAL8 phiRef, UNUSED REAL8 fRef, UNUSED REAL8 distance, UNUSED REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, UNUSED INT4 nk_max, UNUSED UINT4 nModes, LALDict *LALParams)
	Compute waveform modes at user specified frequencies for the SEOBNRv5HM_ROM model. More...

int	XLALSimIMRSEOBNRv5ROMTimeOfFrequency (REAL8 *t, REAL8 frequency, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
	Compute the 'time' elapsed in the ROM waveform from a given starting frequency until the ringdown. More...

Data Structures
struct	SEOBNRROMdataDS_coeff

struct	SEOBNRROMdataDS_submodel

struct	SEOBNRROMdataDS

struct	SplineData

struct	AmpPhaseSplineData

Macros
#define	NMODES 7

#define	f_hyb_ini 0.003

#define	f_hyb_end 0.004

#define	Mf_low_22 0.0004925491025543576

#define	Mf_low_33 (Mf_low_22 * (3.0/2.0))

#define	Mf_low_21 (Mf_low_22 * (1.0/2.0))

#define	Mf_low_44 (Mf_low_22 * (4.0/2.0))

#define	Mf_low_55 (Mf_low_22 * (5.0/2.0))

#define	Mf_low_32 (Mf_low_22)

#define	Mf_low_43 (Mf_low_22 * (3.0/2.0))

Typedefs
typedef int(*	load_dataPtr) (const char , gsl_vector , gsl_vector , gsl_matrix , gsl_matrix , gsl_vector )

Variables
const char	mode_array_v5hm [NMODES][3]

const UINT4	lmModes_v5hm [NMODES][2] = {{2, 2}, {3, 3}, {2, 1}, {4, 4}, {5, 5}, {3, 2}, {4, 3}}

const REAL8	const_phaseshift_lm_v5hm [NMODES] = {0.,0.,0.,0.,0.,0.,0.}

const REAL8	const_fmax_lm_v5hm [NMODES] = {1.7, 1.55, 1.7, 1.35, 1.25, 1.7, 1.7}

const REAL8	Mf_low_lm_v5hm [NMODES] = {Mf_low_22, Mf_low_33, Mf_low_21, Mf_low_44, Mf_low_55, Mf_low_32, Mf_low_43}

static SEOBNRROMdataDS	__lalsim_SEOBNRv5HMROMDS_data [NMODES]

static SEOBNRROMdataDS	__lalsim_SEOBNRv5ROMDS_data [1]

Macro Definition Documentation

◆ NMODES

#define NMODES 7

Definition at line 64 of file LALSimIMRSEOBNRv5HMROM.c.

◆ f_hyb_ini

#define f_hyb_ini 0.003

Definition at line 65 of file LALSimIMRSEOBNRv5HMROM.c.

◆ f_hyb_end

#define f_hyb_end 0.004

Definition at line 66 of file LALSimIMRSEOBNRv5HMROM.c.

◆ Mf_low_22

#define Mf_low_22 0.0004925491025543576

Definition at line 128 of file LALSimIMRSEOBNRv5HMROM.c.

◆ Mf_low_33

#define Mf_low_33 (Mf_low_22 * (3.0/2.0))

Definition at line 129 of file LALSimIMRSEOBNRv5HMROM.c.

◆ Mf_low_21

#define Mf_low_21 (Mf_low_22 * (1.0/2.0))

Definition at line 130 of file LALSimIMRSEOBNRv5HMROM.c.

◆ Mf_low_44

#define Mf_low_44 (Mf_low_22 * (4.0/2.0))

Definition at line 131 of file LALSimIMRSEOBNRv5HMROM.c.

◆ Mf_low_55

#define Mf_low_55 (Mf_low_22 * (5.0/2.0))

Definition at line 132 of file LALSimIMRSEOBNRv5HMROM.c.

◆ Mf_low_32

#define Mf_low_32 (Mf_low_22)

Definition at line 133 of file LALSimIMRSEOBNRv5HMROM.c.

◆ Mf_low_43

#define Mf_low_43 (Mf_low_22 * (3.0/2.0))

Definition at line 134 of file LALSimIMRSEOBNRv5HMROM.c.

Typedef Documentation

◆ load_dataPtr

typedef int(* load_dataPtr) (const char *, gsl_vector *, gsl_vector *, gsl_matrix *, gsl_matrix *, gsl_vector *)

Definition at line 179 of file LALSimIMRSEOBNRv5HMROM.c.

Function Documentation

◆ SEOBNRv5HMROM_IsSetup()

static bool SEOBNRv5HMROM_IsSetup	(	UINT4	index_mode,
		SEOBNRROMdataDS *	romdataset
	)

static

Helper function to check if the SEOBNRv5HMROM model has been initialised.

Definition at line 526 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROM_Init_LALDATA()

static UNUSED void SEOBNRv5HMROM_Init_LALDATA ( void )

static

Setup SEOBNRv5HMROM model using data files installed in $LAL_DATA_PATH.

Definition at line 463 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5ROM_Init_LALDATA()

static UNUSED void SEOBNRv5ROM_Init_LALDATA ( void )

static

Setup SEOBNRv5ROM model using data files installed in $LAL_DATA_PATH.

Definition at line 495 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROM_Init()

static int SEOBNRv5HMROM_Init	(	const char	dir[],
		UINT4	index_mode,
		bool	use_hm,
		SEOBNRROMdataDS *	romdataset
	)

static

Setup SEOBNRv5HMROM mode using data files installed in dir.

Definition at line 679 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRROMdataDS_Init() [1/2]

static UNUSED int SEOBNRROMdataDS_Init	(	SEOBNRROMdataDS *	romdata,
		const char	dir[],
		UINT4	,
		bool
	)

static

◆ SEOBNRROMdataDS_Cleanup()

static void SEOBNRROMdataDS_Cleanup ( SEOBNRROMdataDS * romdata )

static

Definition at line 772 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRROMdataDS_Init_submodel() [1/2]

static UNUSED int SEOBNRROMdataDS_Init_submodel	(	UNUSED SEOBNRROMdataDS_submodel **	submodel,
		UNUSED const char	dir[],
		UNUSED const char	grp_name[],
		UNUSED UINT4	index_mode,
		UNUSED bool	use_hm
	)

static

◆ SEOBNRROMdataDS_Cleanup_submodel()

static void SEOBNRROMdataDS_Cleanup_submodel ( SEOBNRROMdataDS_submodel * submodel )

static

Definition at line 783 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SplineData_Destroy()

static void SplineData_Destroy ( SplineData * splinedata )

static

Definition at line 586 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SplineData_Init()

static void SplineData_Init	(	SplineData **	splinedata,
		int	ncx,
		int	ncy,
		int	ncz,
		const double *	qvec,
		const double *	chi1vec,
		const double *	chi2vec
	)

static

Definition at line 536 of file LALSimIMRSEOBNRv5HMROM.c.

◆ AmpPhaseSplineData_Init()

static void AmpPhaseSplineData_Init	(	AmpPhaseSplineData ***	data,
		const int	num_modes
	)

static

Definition at line 596 of file LALSimIMRSEOBNRv5HMROM.c.

◆ AmpPhaseSplineData_Destroy()

static void AmpPhaseSplineData_Destroy	(	AmpPhaseSplineData **	data,
		const int	num_modes
	)

static

Definition at line 611 of file LALSimIMRSEOBNRv5HMROM.c.

◆ TaylorF2Amplitude()

static int TaylorF2Amplitude	(	const double	q,
		const double	chi1,
		const double	chi2,
		const int	l,
		const int	m,
		gsl_vector *	Mfs,
		gsl_vector **	PNamp
	)

static

Definition at line 2014 of file LALSimIMRSEOBNRv5HMROM.c.

◆ TaylorF2Phasing()

static int TaylorF2Phasing	(	double	Mtot,
		double	q,
		double	chi1,
		double	chi2,
		int	l,
		int	m,
		gsl_vector *	Mfs,
		gsl_vector **	PNphase
	)

static

Definition at line 1938 of file LALSimIMRSEOBNRv5HMROM.c.

◆ GetDeltaphilm()

static double GetDeltaphilm	(	int	l,
		int	m
	)

static

Definition at line 1894 of file LALSimIMRSEOBNRv5HMROM.c.

◆ GetModeAmpFactor()

static double GetModeAmpFactor	(	double	eta,
		double	delta,
		double	chi1,
		double	chi2,
		int	l,
		int	m,
		double	v
	)

static

Definition at line 1914 of file LALSimIMRSEOBNRv5HMROM.c.

◆ BuildInspiralGeomFrequencyGrid()

static int BuildInspiralGeomFrequencyGrid	(	gsl_vector **	Mfreq,
		const double	Mfmin,
		const double	Mfmax,
		const double	q,
		const double	acc
	)

static

Definition at line 2055 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROMCoreModes() [1/2]

static UNUSED int SEOBNRv5HMROMCoreModes	(	SphHarmFrequencySeries **	hlm_list,
		REAL8	phiRef,
		REAL8	fRef,
		REAL8	distance,
		REAL8	Mtot_sec,
		REAL8	q,
		REAL8	chi1,
		REAL8	chi2,
		const REAL8Sequence *	freqs,
		REAL8	deltaF,
		INT4	nk_max,
		UINT4	nModes,
		REAL8	sign_odd_modes,
		SEOBNRROMdataDS *	romdataset
	)

static

Core function for computing the ROM waveform.

Interpolate projection coefficient data and evaluate coefficients at desired (q, chi). Construct 1D splines for amplitude and phase. Compute strain waveform from amplitude and phase.

Parameters

hlm_list	Spherical modes frequency series for the waveform
phiRef	Orbital phase at reference time
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
Mtot_sec	Total mass in seconds *
q	Mass ratio *
chi1	Dimensionless aligned component spin 1
chi2	Dimensionless aligned component spin 2
freqs	Frequency points at which to evaluate the waveform (Hz)
deltaF	If deltaF > 0, the frequency points given in freqs are uniformly spaced with spacing deltaF. Otherwise, the frequency points are spaced non-uniformly. Then we will use deltaF = 0 to create the frequency series we return.
nk_max	truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1
nModes	Number of modes to generate
sign_odd_modes	Sign of the odd-m modes, used when swapping the two bodies
romdataset	Dataset for the 22 or HM ROM

◆ SEOBNRROMdataDS_coeff_Init()

static void SEOBNRROMdataDS_coeff_Init	(	SEOBNRROMdataDS_coeff **	romdatacoeff,
		int	nk_cmode,
		int	nk_phase
	)

static

Definition at line 909 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRROMdataDS_coeff_Cleanup()

static void SEOBNRROMdataDS_coeff_Cleanup ( SEOBNRROMdataDS_coeff * romdatacoeff )

static

Definition at line 923 of file LALSimIMRSEOBNRv5HMROM.c.

◆ NextPow2()

static size_t NextPow2 ( const size_t n )

static

Definition at line 931 of file LALSimIMRSEOBNRv5HMROM.c.

◆ Setup_EOBROM__std_mode_array_structure()

static UINT8 Setup_EOBROM__std_mode_array_structure	(	LALValue *	ModeArray,
		UINT4	nModes
	)

static

ModeArray is a structure which allows to select the modes to include in the waveform.

This function will create a structure with the default modes for every model

Definition at line 1774 of file LALSimIMRSEOBNRv5HMROM.c.

◆ Check_EOBROM_mode_array_structure()

static INT8 Check_EOBROM_mode_array_structure	(	LALValue *	ModeArray,
		UINT4	nModes
	)

static

ModeArray is a structure which allows to select the modes to include in the waveform.

This function check if the selected modes are available

Definition at line 1807 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBROMComputehplushcrossFromhlm() [1/2]

static int SEOBROMComputehplushcrossFromhlm	(	COMPLEX16FrequencySeries *	hplusFS,
		COMPLEX16FrequencySeries *	hcrossFS,
		LALValue *	ModeArray,
		SphHarmFrequencySeries *	hlm,
		REAL8	inc,
		REAL8	phi
	)

static

Parameters

hplusFS	< Output: frequency series for hplus, already created
hcrossFS	< Output: frequency series for hplus, already created
ModeArray	< Input: ModeArray structure with the modes to include
hlm	< Input: list with frequency series for each mode hlm
inc	< Input: inclination
phi	< Input: phase

◆ TP_Spline_interpolation_3d()

static int TP_Spline_interpolation_3d	(	REAL8	q,
		REAL8	chi1,
		REAL8	chi2,
		gsl_vector *	cvec,
		int	nk,
		int	nk_max,
		int	ncx,
		int	ncy,
		int	ncz,
		const double *	qvec,
		const double *	chi1vec,
		const double *	chi2vec,
		gsl_vector *	c_out
	)

static

Definition at line 635 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROM_Select_HF_patch()

static UNUSED UINT8 SEOBNRv5HMROM_Select_HF_patch	(	REAL8	q,
		REAL8	chi1
	)

static

Definition at line 1456 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROM_phase_sparse_grid()

static UNUSED UINT8 SEOBNRv5HMROM_phase_sparse_grid	(	gsl_vector *	phase_f,
		REAL8	q,
		REAL8	chi1,
		REAL8	chi2,
		const char *	freq_range,
		INT4	nk_max,
		SEOBNRROMdataDS *	romdataset
	)

static

Definition at line 1327 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROM_cmode_sparse_grid()

static UNUSED UINT8 SEOBNRv5HMROM_cmode_sparse_grid	(	gsl_vector *	creal_f,
		gsl_vector *	cimag_f,
		REAL8	q,
		REAL8	chi1,
		REAL8	chi2,
		const char *	freq_range,
		UINT8	nMode,
		INT4	nk_max,
		SEOBNRROMdataDS *	romdataset
	)

static

Definition at line 1381 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROM_phase_sparse_grid_hybrid()

static UNUSED UINT8 SEOBNRv5HMROM_phase_sparse_grid_hybrid	(	gsl_vector *	freq,
		gsl_vector *	phase,
		gsl_vector *	freq_lo,
		gsl_vector *	freq_hi,
		REAL8	q,
		REAL8	chi1,
		REAL8	chi2,
		INT4	nk_max,
		SEOBNRROMdataDS *	romdataset
	)

static

Definition at line 935 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROM_cmode_sparse_grid_hybrid()

static UNUSED UINT8 SEOBNRv5HMROM_cmode_sparse_grid_hybrid	(	gsl_vector *	freq,
		gsl_vector *	cmode_real,
		gsl_vector *	cmode_imag,
		gsl_vector *	freq_lo,
		gsl_vector *	freq_hi,
		REAL8	q,
		REAL8	chi1,
		REAL8	chi2,
		UINT8	nMode,
		INT8	nk_max,
		SEOBNRROMdataDS *	romdataset
	)

static

Definition at line 1221 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROM_freq_phase_sparse_grid_hybrid()

static UNUSED UINT8 SEOBNRv5HMROM_freq_phase_sparse_grid_hybrid	(	UNUSED gsl_vector **	freq,
		UNUSED gsl_vector **	phase,
		REAL8	q,
		REAL8	chi1,
		REAL8	chi2,
		INT4	nk_max,
		SEOBNRROMdataDS *	romdataset
	)

static

Definition at line 962 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROM_freq_cmode_sparse_grid_hybrid()

static UNUSED UINT8 SEOBNRv5HMROM_freq_cmode_sparse_grid_hybrid	(	gsl_vector **	freq_cmode,
		gsl_vector **	cmode_real,
		gsl_vector **	cmode_imag,
		REAL8	q,
		REAL8	chi1,
		REAL8	chi2,
		UINT8	nMode,
		INT8	nk_max,
		SEOBNRROMdataDS *	romdataset
	)

static

Definition at line 1249 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROM_approx_phi_lm()

static UNUSED UINT8 SEOBNRv5HMROM_approx_phi_lm	(	gsl_vector *	freq_mode_lm,
		gsl_vector *	phase_approx_lm,
		gsl_vector *	freq_carrier_hyb,
		gsl_vector *	phase_carrier_hyb,
		UINT4	nMode
	)

static

Definition at line 1185 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROM_phase_sparse_grid_hybrid_output_align()

static UNUSED UINT8 SEOBNRv5HMROM_phase_sparse_grid_hybrid_output_align	(	gsl_vector **	freq,
		gsl_vector **	phase,
		REAL8 *	Deltat_align,
		REAL8 *	Deltaphi_align,
		gsl_vector *	phase_lo,
		gsl_vector *	phase_hi,
		gsl_vector *	freq_lo,
		gsl_vector *	freq_hi,
		double	f_hyb_lo,
		double	f_hyb_hi
	)

static

Definition at line 1037 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROM_phase_sparse_grid_hybrid_input_align()

static UNUSED UINT8 SEOBNRv5HMROM_phase_sparse_grid_hybrid_input_align	(	gsl_vector **	freq,
		gsl_vector **	phase,
		gsl_vector *	phase_lo,
		gsl_vector *	phase_hi,
		gsl_vector *	freq_lo,
		gsl_vector *	freq_hi,
		double	f_hyb_lo,
		double	f_hyb_hi,
		REAL8	Deltat_22_align,
		REAL8	Deltaphi_22_align,
		INT4	modeM
	)

static

Definition at line 1093 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROM_amplitude_sparse_grid_hybrid_general()

static UNUSED UINT8 SEOBNRv5HMROM_amplitude_sparse_grid_hybrid_general	(	gsl_vector **	freq,
		gsl_vector **	amp,
		gsl_vector *	amp_lo,
		gsl_vector *	amp_hi,
		gsl_vector *	freq_lo,
		gsl_vector *	freq_hi,
		double	f_hyb_lo,
		double	f_hyb_hi
	)

static

Definition at line 1141 of file LALSimIMRSEOBNRv5HMROM.c.

◆ hybridize_ROM_with_PN_amplitude()

static UNUSED int hybridize_ROM_with_PN_amplitude	(	gsl_spline **	hyb_spline,
		AmpPhaseSplineData *	ampPhaseSplineData_for_mode,
		gsl_vector *	PN_freq,
		gsl_vector *	PN_amp,
		double	f_hyb_win_lo,
		double	f_hyb_win_hi
	)

static

Parameters

hyb_spline	Output: spline
ampPhaseSplineData_for_mode	ROM spline data
PN_freq	PN frequency
PN_amp	PN amplitude
f_hyb_win_lo	hybridization window start
f_hyb_win_hi	hybridization window end

Definition at line 2098 of file LALSimIMRSEOBNRv5HMROM.c.

◆ hybridize_ROM_with_PN_phase_output_align()

static UNUSED int hybridize_ROM_with_PN_phase_output_align	(	gsl_spline **	hyb_spline,
		REAL8 *	Deltat_align,
		REAL8 *	Deltaphi_align,
		AmpPhaseSplineData *	ampPhaseSplineData_for_mode,
		gsl_vector *	PN_freq,
		gsl_vector *	PN_phase,
		double	f_hyb_win_lo,
		double	f_hyb_win_hi
	)

static

Parameters

hyb_spline	Output: spline
Deltat_align	Output: time alignment
Deltaphi_align	Output: phase alignment
ampPhaseSplineData_for_mode	ROM spline data
PN_freq	PN frequency
PN_phase	PN phase
f_hyb_win_lo	hybridization window start
f_hyb_win_hi	hybridization window end

Definition at line 2159 of file LALSimIMRSEOBNRv5HMROM.c.

◆ hybridize_ROM_with_PN_phase_input_align()

static UNUSED int hybridize_ROM_with_PN_phase_input_align	(	gsl_spline **	hyb_spline,
		AmpPhaseSplineData *	ampPhaseSplineData_for_mode,
		gsl_vector *	PN_freq,
		gsl_vector *	PN_phase,
		double	f_hyb_win_lo,
		double	f_hyb_win_hi,
		REAL8	Deltat_22_align,
		REAL8	Deltaphi_22_align,
		INT4	modeM
	)

static

Parameters

hyb_spline	Output: spline
ampPhaseSplineData_for_mode	ROM spline data
PN_freq	PN frequency
PN_phase	PN phase
f_hyb_win_lo	hybridization window start
f_hyb_win_hi	hybridization window end
Deltat_22_align	Input: 22 time alignment
Deltaphi_22_align	Input: 22 phase alignment
modeM	Input: m mode number

Definition at line 2207 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROMCoreModeAmpPhaseSplines()

static UNUSED int SEOBNRv5HMROMCoreModeAmpPhaseSplines	(	UNUSED AmpPhaseSplineData **	ampPhaseSplineData,
		UNUSED REAL8	q,
		UNUSED REAL8	chi1,
		UNUSED REAL8	chi2,
		UNUSED INT4	nk_max,
		UNUSED UINT4	nModes,
		UNUSED SEOBNRROMdataDS *	romdataset
	)

static

Parameters

ampPhaseSplineData	< Output: amplitude and phase splines for the modes
q	Mass ratio *
chi1	Dimensionless aligned component spin 1
chi2	Dimensionless aligned component spin 2
nk_max	truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1 (default).
nModes	Number of modes to generate
romdataset	Dataset for the 22 or HM ROM

Definition at line 1478 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROMCoreModesHybridized()

static UNUSED int SEOBNRv5HMROMCoreModesHybridized	(	UNUSED SphHarmFrequencySeries **	hlm_list,
		UNUSED REAL8	phiRef,
		UNUSED REAL8	fRef,
		UNUSED REAL8	distance,
		UNUSED REAL8	Mtot_sec,
		UNUSED REAL8	q,
		UNUSED REAL8	chi1,
		UNUSED REAL8	chi2,
		UNUSED const REAL8Sequence *	freqs_in,
		UNUSED REAL8	deltaF,
		UNUSED INT4	nk_max,
		UNUSED UINT4	nModes,
		REAL8	sign_odd_modes,
		UNUSED SEOBNRROMdataDS *	romdataset
	)

static

Parameters

hlm_list	< Output: Spherical modes frequency series for the waveform
phiRef	< orbital reference phase
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
Mtot_sec	Total mass in seconds *
q	Mass ratio *
chi1	Dimensionless aligned component spin 1
chi2	Dimensionless aligned component spin 2
freqs_in	Frequency points at which to evaluate the waveform (Hz)
deltaF	Frequency points at which to evaluate the waveform (Hz)
nk_max	truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1. We *nk_max == -1 is the default setting
nModes	Number of modes to generate
sign_odd_modes	Sign of the odd-m modes, used when swapping the two bodies
romdataset	Dataset for the 22 or HM ROM

Definition at line 2260 of file LALSimIMRSEOBNRv5HMROM.c.

◆ spline_to_gsl_vectors()

static UNUSED int spline_to_gsl_vectors	(	gsl_spline *	s,
		gsl_vector **	x,
		gsl_vector **	y
	)

static

Definition at line 446 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRROMdataDS_Init() [2/2]

int SEOBNRROMdataDS_Init	(	UNUSED SEOBNRROMdataDS *	romdata,
		UNUSED const char	dir[],
		UNUSED UINT4	index_mode,
		UNUSED bool	use_hm
	)

Definition at line 696 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRROMdataDS_Init_submodel() [2/2]

static UNUSED int SEOBNRROMdataDS_Init_submodel	(	SEOBNRROMdataDS_submodel **	submodel,
		UNUSED const char	dir[],
		UNUSED const char	grp_name[],
		UNUSED UINT4	index_mode,
		UNUSED bool	use_hm
	)

static

Definition at line 798 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBNRv5HMROMCoreModes() [2/2]

static UNUSED int SEOBNRv5HMROMCoreModes	(	UNUSED SphHarmFrequencySeries **	hlm_list,
		UNUSED REAL8	phiRef,
		UNUSED REAL8	fRef,
		UNUSED REAL8	distance,
		UNUSED REAL8	Mtot_sec,
		UNUSED REAL8	q,
		UNUSED REAL8	chi1,
		UNUSED REAL8	chi2,
		UNUSED const REAL8Sequence *	freqs_in,
		UNUSED REAL8	deltaF,
		UNUSED INT4	nk_max,
		UNUSED UINT4	nModes,
		REAL8	sign_odd_modes,
		UNUSED SEOBNRROMdataDS *	romdataset
	)

static

Core function for computing the ROM modes.

It rebuilds the modes starting from "orbital phase" and co-orbital modes. This function returns SphHarmFrequencySeries

Parameters

hlm_list	< Spherical modes frequency series for the waveform
phiRef	< orbital reference phase
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
Mtot_sec	Total mass in seconds *
q	Mass ratio *
chi1	Dimensionless aligned component spin 1
chi2	Dimensionless aligned component spin 2
freqs_in	Frequency points at which to evaluate the waveform (Hz)
deltaF	Frequency points at which to evaluate the waveform (Hz)
nk_max	truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1. We *nk_max == -1 is the default setting
nModes	Number of modes to generate
sign_odd_modes	Sign of the odd-m modes, used when swapping the two bodies
romdataset	Dataset for the 22 or HM ROM

Definition at line 1605 of file LALSimIMRSEOBNRv5HMROM.c.

◆ SEOBROMComputehplushcrossFromhlm() [2/2]

static int SEOBROMComputehplushcrossFromhlm	(	COMPLEX16FrequencySeries *	hplusFS,
		COMPLEX16FrequencySeries *	hcrossFS,
		LALValue *	ModeArray,
		SphHarmFrequencySeries *	hlm,
		REAL8	inc,
		UNUSED REAL8	phi
	)

static

This function combines the modes hlm frequencyseries with the sYlm to produce the polarizations hplus, hcross.

Parameters

hplusFS	< Output: frequency series for hplus, already created
hcrossFS	< Output: frequency series for hplus, already created
ModeArray	< Input: ModeArray structure with the modes to include
hlm	< Input: list with frequency series for each mode hlm
inc	< Input: inclination
phi	< Input: phase

Definition at line 1866 of file LALSimIMRSEOBNRv5HMROM.c.

Variable Documentation

◆ mode_array_v5hm

const char mode_array_v5hm[NMODES][3]

Initial value:

=
{"22",
"33",
"21",
"44",
"55",
"32",
"43"}

Definition at line 100 of file LALSimIMRSEOBNRv5HMROM.c.

◆ lmModes_v5hm

const UINT4 lmModes_v5hm[NMODES][2] = {{2, 2}, {3, 3}, {2, 1}, {4, 4}, {5, 5}, {3, 2}, {4, 3}}

Definition at line 109 of file LALSimIMRSEOBNRv5HMROM.c.

◆ const_phaseshift_lm_v5hm

const REAL8 const_phaseshift_lm_v5hm[NMODES] = {0.,0.,0.,0.,0.,0.,0.}

Definition at line 114 of file LALSimIMRSEOBNRv5HMROM.c.

◆ const_fmax_lm_v5hm

const REAL8 const_fmax_lm_v5hm[NMODES] = {1.7, 1.55, 1.7, 1.35, 1.25, 1.7, 1.7}

Definition at line 124 of file LALSimIMRSEOBNRv5HMROM.c.

◆ Mf_low_lm_v5hm

const REAL8 Mf_low_lm_v5hm[NMODES] = {Mf_low_22, Mf_low_33, Mf_low_21, Mf_low_44, Mf_low_55, Mf_low_32, Mf_low_43}

Definition at line 135 of file LALSimIMRSEOBNRv5HMROM.c.

◆ __lalsim_SEOBNRv5HMROMDS_data

SEOBNRROMdataDS __lalsim_SEOBNRv5HMROMDS_data[NMODES]

static

Definition at line 176 of file LALSimIMRSEOBNRv5HMROM.c.

◆ __lalsim_SEOBNRv5ROMDS_data

SEOBNRROMdataDS __lalsim_SEOBNRv5ROMDS_data[1]

static

Definition at line 177 of file LALSimIMRSEOBNRv5HMROM.c.

Prototypes

Data Structures

Macros

Typedefs

Variables

Macro Definition Documentation

◆ NMODES

◆ f_hyb_ini

◆ f_hyb_end

◆ Mf_low_22

◆ Mf_low_33

◆ Mf_low_21

◆ Mf_low_44

◆ Mf_low_55

◆ Mf_low_32

◆ Mf_low_43

Typedef Documentation

◆ load_dataPtr

Function Documentation

◆ SEOBNRv5HMROM_IsSetup()

◆ SEOBNRv5HMROM_Init_LALDATA()

◆ SEOBNRv5ROM_Init_LALDATA()

◆ SEOBNRv5HMROM_Init()

◆ SEOBNRROMdataDS_Init() [1/2]

◆ SEOBNRROMdataDS_Cleanup()

◆ SEOBNRROMdataDS_Init_submodel() [1/2]

◆ SEOBNRROMdataDS_Cleanup_submodel()

◆ SplineData_Destroy()

◆ SplineData_Init()

◆ AmpPhaseSplineData_Init()

◆ AmpPhaseSplineData_Destroy()

◆ TaylorF2Amplitude()

◆ TaylorF2Phasing()

◆ GetDeltaphilm()

◆ GetModeAmpFactor()

◆ BuildInspiralGeomFrequencyGrid()

◆ SEOBNRv5HMROMCoreModes() [1/2]

◆ SEOBNRROMdataDS_coeff_Init()

◆ SEOBNRROMdataDS_coeff_Cleanup()

◆ NextPow2()

◆ Setup_EOBROM__std_mode_array_structure()

◆ Check_EOBROM_mode_array_structure()

◆ SEOBROMComputehplushcrossFromhlm() [1/2]

◆ TP_Spline_interpolation_3d()

◆ SEOBNRv5HMROM_Select_HF_patch()

◆ SEOBNRv5HMROM_phase_sparse_grid()

◆ SEOBNRv5HMROM_cmode_sparse_grid()

◆ SEOBNRv5HMROM_phase_sparse_grid_hybrid()

◆ SEOBNRv5HMROM_cmode_sparse_grid_hybrid()

◆ SEOBNRv5HMROM_freq_phase_sparse_grid_hybrid()

◆ SEOBNRv5HMROM_freq_cmode_sparse_grid_hybrid()

◆ SEOBNRv5HMROM_approx_phi_lm()

◆ SEOBNRv5HMROM_phase_sparse_grid_hybrid_output_align()

◆ SEOBNRv5HMROM_phase_sparse_grid_hybrid_input_align()

◆ SEOBNRv5HMROM_amplitude_sparse_grid_hybrid_general()

◆ hybridize_ROM_with_PN_amplitude()

◆ hybridize_ROM_with_PN_phase_output_align()

◆ hybridize_ROM_with_PN_phase_input_align()

◆ SEOBNRv5HMROMCoreModeAmpPhaseSplines()

◆ SEOBNRv5HMROMCoreModesHybridized()

◆ spline_to_gsl_vectors()

◆ SEOBNRROMdataDS_Init() [2/2]

◆ SEOBNRROMdataDS_Init_submodel() [2/2]

◆ SEOBNRv5HMROMCoreModes() [2/2]

◆ SEOBROMComputehplushcrossFromhlm() [2/2]

Variable Documentation

◆ mode_array_v5hm

◆ lmModes_v5hm

◆ const_phaseshift_lm_v5hm

◆ const_fmax_lm_v5hm

◆ Mf_low_lm_v5hm

◆ __lalsim_SEOBNRv5HMROMDS_data

◆ __lalsim_SEOBNRv5ROMDS_data