GeneratePPNInspiral.h File Reference

Prototypes
void	LALGeneratePPNInspiral (LALStatus *, CoherentGW *output, PPNParamStruc *params)
	Computes a parametrized post-Newtonian inspiral waveform. More...
void	LALGeneratePPNAmpCorInspiral (LALStatus *, CoherentGW *output, PPNParamStruc *params)
	Computes a parametrized post-Newtonian inspiral waveform with ampltidude corrections. More...
void	LALGetInspiralParams (LALStatus *, PPNParamStruc *output, GalacticInspiralParamStruc *input, RandomParams *params)
	Computes the input parameters for a PPN inspiral. More...

Go to the source code of this file.

Data Structures
struct	PPNParamStruc
	This structure stores the parameters for constructing a restricted post-Newtonian waveform. More...
struct	GalacticInspiralParamStruc
	This structure stores the position and mass parameters of a galactic inspiral event. More...

Macros
Error Codes
#define	GENERATEPPNINSPIRALH_ENUL   1
	Unexpected null pointer in arguments. More...
#define	GENERATEPPNINSPIRALH_EOUT   2
	output field a, f, phi, or shift already exists More...
#define	GENERATEPPNINSPIRALH_ETBAD   3
	Bad sampling interval. More...
#define	GENERATEPPNINSPIRALH_EFBAD   4
	Bad starting frequency; could not get valid start time. More...
#define	GENERATEPPNINSPIRALH_EPBAD   5
	Bad post-Newtonian parameters. More...
#define	GENERATEPPNINSPIRALH_EMBAD   6
	Bad masses. More...
#define	GENERATEPPNINSPIRALH_EDBAD   7
	Bad distance. More...
#define	GENERATEPPNINSPIRALH_EMEM   8
	Out of memory. More...
More Termination conditions
In addition to the error conditions above, there are a number of ways that the signal generation routine can terminate gracefully while still returning a valid waveform. In many cases one wants to continue generating a waveform "until things fall apart"; the following codes, returned in the PPNParamStruc below, allow the waveform generator to report exactly how things fell apart. For the sake of LAL namespace conventions, these termination codes are #defined and autodocumented exactly like error codes.
#define	GENERATEPPNINSPIRALH_EFSTOP   0
	Reached requested termination frequency. More...
#define	GENERATEPPNINSPIRALH_ELENGTH   1
	Reached maximum length, or end of provided time series vector. More...
#define	GENERATEPPNINSPIRALH_EFNOTMON   2
	Frequency no longer increasing monotonically. More...
#define	GENERATEPPNINSPIRALH_EPNFAIL   3
	Evolution dominated by higher-order PN terms. More...
#define	GENERATEPPNINSPIRALH_ERTOOSMALL   4
	Orbital radius too small for PN approximation. More...