GenerateSpinOrbitCW.h File Reference

#include <lal/LALStdlib.h>
#include <lal/SimulateCoherentGW.h>
#include <lal/SkyCoordinates.h>

Include dependency graph for GenerateSpinOrbitCW.h:

Go to the source code of this file.

Data Structures
struct	tagSpinOrbitCWParamStruc
	This structure stores the parameters for constructing a gravitational waveform with both a Taylor-polynomial intrinsic frequency and phase, and a binary-orbit modulation. More...
Defines
#define	GENERATESPINORBITCWH_ENUL   1
#define	GENERATESPINORBITCWH_EOUT   2
#define	GENERATESPINORBITCWH_EMEM   3
#define	GENERATESPINORBITCWH_EECC   4
#define	GENERATESPINORBITCWH_EFTL   5
#define	GENERATESPINORBITCWH_ESGN   6
#define	GENERATESPINORBITCWH_MSGENUL   "Unexpected null pointer in arguments"
#define	GENERATESPINORBITCWH_MSGEOUT   "Output field a, f, phi, or shift already exists"
#define	GENERATESPINORBITCWH_MSGEMEM   "Out of memory"
#define	GENERATESPINORBITCWH_MSGEECC   "Eccentricity out of range"
#define	GENERATESPINORBITCWH_MSGEFTL   "Periapsis motion is faster than light"
#define	GENERATESPINORBITCWH_MSGESGN   "Sign error: positive parameter expected"
Typedefs
typedef tagSpinOrbitCWParamStruc	SpinOrbitCWParamStruc
	This structure stores the parameters for constructing a gravitational waveform with both a Taylor-polynomial intrinsic frequency and phase, and a binary-orbit modulation.
Functions
	NRCSID (GENERATESPINORBITCWH,"$Id: GenerateSpinOrbitCW.h,v 1.6 2007/06/08 14:41:46 bema Exp $")
void	LALGenerateSpinOrbitCW (LALStatus *, CoherentGW *output, SpinOrbitCWParamStruc *params)
void	LALGenerateEllipticSpinOrbitCW (LALStatus *, CoherentGW *output, SpinOrbitCWParamStruc *params)
void	LALGenerateParabolicSpinOrbitCW (LALStatus *, CoherentGW *output, SpinOrbitCWParamStruc *params)
void	LALGenerateHyperbolicSpinOrbitCW (LALStatus *, CoherentGW *output, SpinOrbitCWParamStruc *params)

---

Define Documentation

#define GENERATESPINORBITCWH_ENUL   1

Definition at line 239 of file GenerateSpinOrbitCW.h.

#define GENERATESPINORBITCWH_EOUT   2

Definition at line 240 of file GenerateSpinOrbitCW.h.

#define GENERATESPINORBITCWH_EMEM   3

Definition at line 241 of file GenerateSpinOrbitCW.h.

#define GENERATESPINORBITCWH_EECC   4

Definition at line 242 of file GenerateSpinOrbitCW.h.

#define GENERATESPINORBITCWH_EFTL   5

Definition at line 243 of file GenerateSpinOrbitCW.h.

#define GENERATESPINORBITCWH_ESGN   6

Definition at line 244 of file GenerateSpinOrbitCW.h.

#define GENERATESPINORBITCWH_MSGENUL   "Unexpected null pointer in arguments"

Definition at line 246 of file GenerateSpinOrbitCW.h.

#define GENERATESPINORBITCWH_MSGEOUT   "Output field a, f, phi, or shift already exists"

Definition at line 247 of file GenerateSpinOrbitCW.h.

#define GENERATESPINORBITCWH_MSGEMEM   "Out of memory"

Definition at line 248 of file GenerateSpinOrbitCW.h.

#define GENERATESPINORBITCWH_MSGEECC   "Eccentricity out of range"

Definition at line 249 of file GenerateSpinOrbitCW.h.

#define GENERATESPINORBITCWH_MSGEFTL   "Periapsis motion is faster than light"

Definition at line 250 of file GenerateSpinOrbitCW.h.

#define GENERATESPINORBITCWH_MSGESGN   "Sign error: positive parameter expected"

Definition at line 251 of file GenerateSpinOrbitCW.h.

---

Typedef Documentation

typedef struct tagSpinOrbitCWParamStruc SpinOrbitCWParamStruc

This structure stores the parameters for constructing a gravitational waveform with both a Taylor-polynomial intrinsic frequency and phase, and a binary-orbit modulation.

As with the PPNParamStruc type in GeneratePPNInspiral.h, we divide the fields into passed fields (which are supplied to the final CoherentGW structure but not used in any calculations), input fields (that are used by the waveform generator), and output fields (that are set by the waveform generator).

---

Function Documentation

NRCSID	(	GENERATESPINORBITCWH	,
		"$Id: GenerateSpinOrbitCW.	h,
		v 1.6 2007/06/08 14:41:46 bema Exp $"
	)

void LALGenerateSpinOrbitCW	(	LALStatus *	,
		CoherentGW *	output,
		SpinOrbitCWParamStruc *	params
	)

Definition at line 136 of file GenerateSpinOrbitCW.c.

void LALGenerateEllipticSpinOrbitCW	(	LALStatus *	,
		CoherentGW *	output,
		SpinOrbitCWParamStruc *	params
	)

Definition at line 192 of file GenerateEllipticSpinOrbitCW.c.

void LALGenerateParabolicSpinOrbitCW	(	LALStatus *	,
		CoherentGW *	output,
		SpinOrbitCWParamStruc *	params
	)

Definition at line 177 of file GenerateParabolicSpinOrbitCW.c.

void LALGenerateHyperbolicSpinOrbitCW	(	LALStatus *	,
		CoherentGW *	output,
		SpinOrbitCWParamStruc *	params
	)

Definition at line 182 of file GenerateHyperbolicSpinOrbitCW.c.

---