LALSimInspiralTEOBResumROM.c File Reference

Prototypes
static void	TEOBResumROM_Init_LALDATA (void)
	Setup TEOBResum_ROM model using data files installed in $LAL_DATA_PATH. More...
static int	TEOBResumROM_Init (const char dir[])
	Setup SEOBNRv2ROMDoubleSpin model using data files installed in dir. More...
static bool	TEOBResumROM_IsSetup (void)
	Helper function to check if the SEOBNRv2ROMDoubleSpin model has been initialised. More...
static int	TEOBResumROMdataDS_Init (TEOBResumROMdataDS *romdata, const char dir[])
static void	TEOBResumROMdataDS_Cleanup (TEOBResumROMdataDS *romdata)
static int	TEOBResumROMdataDS_Init_submodel (TEOBResumROMdataDS_submodel **submodel, const int n_amp, const int n_phi, const int nq, const int nl1, const int nl2, const int ntimes, const double *params_min, const double *params_max, const char dir[], load_dataPtr load_data)
static double	gsl_cheb_evaluate_polynomial (int n, double x)
static double	gsl_cheb_eval_3d (gsl_vector *c_ijk, int nx, int ny, int nz, double x, double y, double z)
static int	chebyshev_interpolation3d (double q, double lambda1, double lambda2, int nx, int ny, int nz, gsl_vector *cvec_amp, gsl_vector *cvec_phi, int nk_amp, int nk_phi, const double xyz_min[], const double xyz_max[], gsl_vector *interp_amp, gsl_vector *interp_phi)
static void	TEOBResumROMdataDS_Cleanup_submodel (TEOBResumROMdataDS_submodel *submodel)
static int	TEOBResumROMCore (REAL8TimeSeries **hPlus, REAL8TimeSeries **hCross, double phiRef, double deltaT, double fLow, double distance, double inclination, double Mtot_sec, double eta, double lambda1, double lambda2)
static int	load_data_romeos (const char dir[], gsl_vector *cvec_amp, gsl_vector *cvec_phi, gsl_matrix *Bamp, gsl_matrix *Bphi, gsl_vector *times)
TEOBResum Reduced Order Model (Tidal effects)
C code for TEOBResum reduced order model which includes tidal effects. See ... for the basic approach. Further details in ... Author Jeroen Meidam, ... (Based on SEOBNRv2ROM code written by Michael Puerrer and John Veitch) This is a time domain model that approximates the time domain EOB model with tidal effects. The binary data files are available at https://github.com/benjaminlackey/cbcrom/tree/master/data. Put the *.dat files into a location in your LAL_DATA_PATH. They must have the names TEOBResumROM_Amp_ciall.dat TEOBResumROM_Phase_ciall.dat TEOBResumROM_Bamp_matrix.dat TEOBResumROM_Bphase_matrix.dat TEOBResumROM_times.dat Note Approximant name is TEOBResum_ROM Parameter ranges: 0.5 <= q <= 1.0 50 <= lambda_i <= 5000
int	XLALSimInspiralTEOBResumROM (REAL8TimeSeries **hPlus, REAL8TimeSeries **hCross, REAL8 phiRef, REAL8 deltaT, REAL8 fLow, UNUSED REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 lambda1, REAL8 lambda2)

Go to the source code of this file.

Data Structures
struct	TEOBResumROMdataDS_coeff
struct	TEOBResumROMdataDS_submodel
struct	TEOBResumROMdataDS

Macros
#define	Gntimes   73624
#define	Gnamp   12
#define	Gnphase   7
#define	Gnq   16
#define	Gnlambda1   16
#define	Gnlambda2   16

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

Variables
static const double	Gparams_min [] = {0.5,50.,50.}
static const double	Gparams_max [] = {1.0,5000.,5000.}
static TEOBResumROMdataDS	__lalsim_TEOBResumROMDS_data

Macro Definition Documentation

Gntimes

#define Gntimes   73624

Definition at line 70 of file LALSimInspiralTEOBResumROM.c.

Gnamp

#define Gnamp   12

Definition at line 71 of file LALSimInspiralTEOBResumROM.c.

Gnphase

#define Gnphase   7

Definition at line 72 of file LALSimInspiralTEOBResumROM.c.

Gnq

#define Gnq   16

Definition at line 73 of file LALSimInspiralTEOBResumROM.c.

Gnlambda1

#define Gnlambda1   16

Definition at line 74 of file LALSimInspiralTEOBResumROM.c.

Gnlambda2

#define Gnlambda2   16

Definition at line 75 of file LALSimInspiralTEOBResumROM.c.

Typedef Documentation

load_dataPtr

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

Definition at line 118 of file LALSimInspiralTEOBResumROM.c.

Function Documentation

TEOBResumROM_Init_LALDATA()

static void TEOBResumROM_Init_LALDATA ( void  )

static

Setup TEOBResum_ROM model using data files installed in $LAL_DATA_PATH.

Definition at line 786 of file LALSimInspiralTEOBResumROM.c.

TEOBResumROM_Init()

static int TEOBResumROM_Init ( const char  dir[] )

static

Setup SEOBNRv2ROMDoubleSpin model using data files installed in dir.

Definition at line 183 of file LALSimInspiralTEOBResumROM.c.

TEOBResumROM_IsSetup()

static bool TEOBResumROM_IsSetup ( void  )

static

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

Definition at line 201 of file LALSimInspiralTEOBResumROM.c.

TEOBResumROMdataDS_Init()

int TEOBResumROMdataDS_Init ( TEOBResumROMdataDS *  romdata, const char  dir[]  )

static

Definition at line 278 of file LALSimInspiralTEOBResumROM.c.

TEOBResumROMdataDS_Cleanup()

static void TEOBResumROMdataDS_Cleanup ( TEOBResumROMdataDS *  romdata )

static

Definition at line 302 of file LALSimInspiralTEOBResumROM.c.

TEOBResumROMdataDS_Init_submodel()

static int TEOBResumROMdataDS_Init_submodel ( TEOBResumROMdataDS_submodel **  submodel, const int  n_amp, const int  n_phi, const int  nq, const int  nl1, const int  nl2, const int  ntimes, const double *  params_min, const double *  params_max, const char  dir[], load_dataPtr  load_data  )

static

Definition at line 220 of file LALSimInspiralTEOBResumROM.c.

gsl_cheb_evaluate_polynomial()

static double gsl_cheb_evaluate_polynomial ( int  n, double  x  )

static

Definition at line 375 of file LALSimInspiralTEOBResumROM.c.

gsl_cheb_eval_3d()

static double gsl_cheb_eval_3d ( gsl_vector *  c_ijk, int  nx, int  ny, int  nz, double  x, double  y, double  z  )

static

Definition at line 411 of file LALSimInspiralTEOBResumROM.c.

chebyshev_interpolation3d()

static int chebyshev_interpolation3d ( double  q, double  lambda1, double  lambda2, int  nx, int  ny, int  nz, gsl_vector *  cvec_amp, gsl_vector *  cvec_phi, int  nk_amp, int  nk_phi, const double  xyz_min[], const double  xyz_max[], gsl_vector *  interp_amp, gsl_vector *  interp_phi  )

static

Definition at line 437 of file LALSimInspiralTEOBResumROM.c.

TEOBResumROMdataDS_Cleanup_submodel()

static void TEOBResumROMdataDS_Cleanup_submodel ( TEOBResumROMdataDS_submodel *  submodel )

static

Definition at line 269 of file LALSimInspiralTEOBResumROM.c.

TEOBResumROMCore()

static int TEOBResumROMCore ( REAL8TimeSeries **  hPlus, REAL8TimeSeries **  hCross, double  phiRef, double  deltaT, double  fLow, double  distance, double  inclination, double  Mtot_sec, double  eta, double  lambda1, double  lambda2  )

static

Definition at line 480 of file LALSimInspiralTEOBResumROM.c.

load_data_romeos()

static int load_data_romeos ( const char  dir[], gsl_vector *  cvec_amp, gsl_vector *  cvec_phi, gsl_matrix *  Bamp, gsl_matrix *  Bphi, gsl_vector *  times  )

static

Definition at line 209 of file LALSimInspiralTEOBResumROM.c.

XLALSimInspiralTEOBResumROM()

int XLALSimInspiralTEOBResumROM	(	REAL8TimeSeries **	hPlus,
		REAL8TimeSeries **	hCross,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	fLow,
		UNUSED REAL8	fRef,
		REAL8	distance,
		REAL8	inclination,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	lambda1,
		REAL8	lambda2
	)

Parameters

hPlus	Output: Frequency-domain waveform h+
hCross	Output: Frequency-domain waveform hx
phiRef	Orbital phase at reference frequency
deltaT	Sampling frequency (Hz)
fLow	Starting GW frequency (Hz)
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
inclination	Inclination of source (rad)
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
lambda1	dimensionless tidal deformability of body 1
lambda2	dimensionless tidal deformability of body 1

Definition at line 712 of file LALSimInspiralTEOBResumROM.c.

Variable Documentation

Gparams_min

const double Gparams_min[] = {0.5,50.,50.}

static

Definition at line 81 of file LALSimInspiralTEOBResumROM.c.

Gparams_max

const double Gparams_max[] = {1.0,5000.,5000.}

static

Definition at line 82 of file LALSimInspiralTEOBResumROM.c.

__lalsim_TEOBResumROMDS_data

TEOBResumROMdataDS __lalsim_TEOBResumROMDS_data

static

Definition at line 116 of file LALSimInspiralTEOBResumROM.c.