LALSimNRSurRemnantUtils.h File Reference

Utils for NR surrogates for remnant BH mass, spin and recoil kick. More...

Prototypes
void	NRSurRemnant_LoadH5File (LALH5File **file, const char *NRSurRemnant_DATAFILE)
	Loads H5 file for a NRSurRemnant model. More...
int	NRSurRemnant_LoadScalarFit (ScalarFitData **fit_data, LALH5File *file, const char *grp_name)
	Loads a single NRSurRemnant GPR fit, as described in the supplementary materials of arxiv:1809.09125. More...
int	NRSurRemnant_LoadVectorFit (VectorFitData **vector_data, UINT4 vec_dim, LALH5File *file, const char *grp_name)
	Loads a vector of NRSurRemnant GPR fits. More...
int	PrecessingNRSurRemnant_Init (PrecessingRemnantFitData *sur_data, LALH5File *file)
	Initializes fit data for a precessing NRSurRemnant. More...
int	AlignedSpinNRSurRemnant_Init (AlignedSpinRemnantFitData *sur_data, LALH5File *file)
	Initializes fit data for an aligned-spin NRSurRemnant. More...

Detailed Description

Utils for NR surrogates for remnant BH mass, spin and recoil kick.

Author

Vijay Varma

Definition in file LALSimNRSurRemnantUtils.h.

Go to the source code of this file.

Data Structures
struct	VectorFitData
	Data used in a single vector fit NOTE: basisFunctionOrders, coefs, componentIndices, and n_coefs are only used by NRSur7dq2. More...
struct	PrecessingRemnantFitData
	NRSurRemnant GPR fit data for the mass, spin, and recoil kick for generically precessing BBHs. More...
struct	AlignedSpinRemnantFitData
	NRSurRemnant GPR fit data for the mass, spin, and recoil kick for aligned-spin BBHs. More...

Macros
#define	print_warning(...)
#define	ScalarFitData   NRHybSurFitData

Macro Definition Documentation

print_warning

#define print_warning

(

...

)

Value:

    if (lalDebugLevel & LALERRORBIT) \
        printf("Warning - %s (%s:%d): ", __func__, __FILE__, __LINE__); \
        printf(__VA_ARGS__);

Definition at line 38 of file LALSimNRSurRemnantUtils.h.

ScalarFitData

#define ScalarFitData   NRHybSurFitData

Definition at line 49 of file LALSimNRSurRemnantUtils.h.

Function Documentation

NRSurRemnant_LoadH5File()

void NRSurRemnant_LoadH5File	(	LALH5File **	file,
		const char *	NRSurRemnant_DATAFILE
	)

Loads H5 file for a NRSurRemnant model.

Parameters

file	Output: Returns the opened H5 file.
NRSurRemnant_DATAFILE	H5 file name to load.

Definition at line 65 of file LALSimNRSurRemnantUtils.c.

NRSurRemnant_LoadScalarFit()

int NRSurRemnant_LoadScalarFit	(	ScalarFitData **	fit_data,
		LALH5File *	file,
		const char *	grp_name
	)

Loads a single NRSurRemnant GPR fit, as described in the supplementary materials of arxiv:1809.09125.

Parameters

fit_data	Output: Fit data. *fit_data should be NULL. Space will be allocated.
file	Opened H5 file.
grp_name	H5 group name.

Definition at line 97 of file LALSimNRSurRemnantUtils.c.

NRSurRemnant_LoadVectorFit()

int NRSurRemnant_LoadVectorFit	(	VectorFitData **	vector_data,
		UINT4	vec_dim,
		LALH5File *	file,
		const char *	grp_name
	)

Loads a vector of NRSurRemnant GPR fits.

Parameters

vector_data	Output: Vector of fit data. *vector_data should be NULL. Space will be allocated.
vec_dim	Length of the vector
file	Opened H5 file.
grp_name	H5 group name.

Definition at line 198 of file LALSimNRSurRemnantUtils.c.

PrecessingNRSurRemnant_Init()

int PrecessingNRSurRemnant_Init	(	PrecessingRemnantFitData *	sur_data,
		LALH5File *	file
	)

Initializes fit data for a precessing NRSurRemnant.

The data includes a ScalarFitData for the final mass, and a VectorFitData for the final spin and kick 3-vectors.

Parameters

sur_data	Output: Loaded surrogate data.
file	Opened H5 file.

Definition at line 239 of file LALSimNRSurRemnantUtils.c.

AlignedSpinNRSurRemnant_Init()

int AlignedSpinNRSurRemnant_Init	(	AlignedSpinRemnantFitData *	sur_data,
		LALH5File *	file
	)

Initializes fit data for an aligned-spin NRSurRemnant.

The data includes a ScalarFitData for the final mass, z-component of the final spin, and x and y components of the recoil kick. The other components of the spin and kick are zero due to the symmetries of aligned-spin systems and are not modelled by the surrogate.

Parameters

sur_data	Output: Loaded surrogate data.
file	Opened H5 file.

Definition at line 295 of file LALSimNRSurRemnantUtils.c.