20#ifndef _GENERATEPPNINSPIRAL_H
21#define _GENERATEPPNINSPIRAL_H
23#include <lal/LALAtomicDatatypes.h>
24#include <lal/LALDatatypes.h>
25#include <lal/Random.h>
26#include <lal/SimulateCoherentGW.h>
27#include <lal/SkyCoordinates.h>
29#if defined(__cplusplus)
168#define GENERATEPPNINSPIRALH_ENUL 1
169#define GENERATEPPNINSPIRALH_EOUT 2
170#define GENERATEPPNINSPIRALH_ETBAD 3
171#define GENERATEPPNINSPIRALH_EFBAD 4
172#define GENERATEPPNINSPIRALH_EPBAD 5
173#define GENERATEPPNINSPIRALH_EMBAD 6
174#define GENERATEPPNINSPIRALH_EDBAD 7
175#define GENERATEPPNINSPIRALH_EMEM 8
179#define GENERATEPPNINSPIRALH_MSGENUL "Unexpected null pointer in arguments"
180#define GENERATEPPNINSPIRALH_MSGEOUT "output field a, f, phi, or shift already exists"
181#define GENERATEPPNINSPIRALH_MSGETBAD "Bad sampling interval"
182#define GENERATEPPNINSPIRALH_MSGEFBAD "Bad starting frequency; could not get valid start time"
183#define GENERATEPPNINSPIRALH_MSGEPBAD "Bad post-Newtonian parameters"
184#define GENERATEPPNINSPIRALH_MSGEMBAD "Bad masses"
185#define GENERATEPPNINSPIRALH_MSGEDBAD "Bad distance"
186#define GENERATEPPNINSPIRALH_MSGEMEM "Out of memory"
202#define GENERATEPPNINSPIRALH_EFSTOP 0
203#define GENERATEPPNINSPIRALH_ELENGTH 1
204#define GENERATEPPNINSPIRALH_EFNOTMON 2
205#define GENERATEPPNINSPIRALH_EPNFAIL 3
206#define GENERATEPPNINSPIRALH_ERTOOSMALL 4
210#define GENERATEPPNINSPIRALH_MSGEFSTOP "Reached requested termination frequency"
211#define GENERATEPPNINSPIRALH_MSGELENGTH "Reached maximum length, or end of provided time series vector"
212#define GENERATEPPNINSPIRALH_MSGEFNOTMON "Frequency no longer increasing monotonically"
213#define GENERATEPPNINSPIRALH_MSGEPNFAIL "Evolution dominated by higher-order PN terms"
214#define GENERATEPPNINSPIRALH_MSGERTOOSMALL "Orbital radius too small for PN approximation"
230typedef struct tagPPNParamStruc {
284typedef struct tagGalacticInspiralParamStruc {
327#elif defined(__cplusplus)
void LALGeneratePPNInspiral(LALStatus *, CoherentGW *output, PPNParamStruc *params)
Computes a parametrized post-Newtonian inspiral waveform.
void LALGeneratePPNAmpCorInspiral(LALStatus *, CoherentGW *output, PPNParamStruc *params)
Computes a parametrized post-Newtonian inspiral waveform with ampltidude corrections.
void LALGetInspiralParams(LALStatus *, PPNParamStruc *output, GalacticInspiralParamStruc *input, RandomParams *params)
Computes the input parameters for a PPN inspiral.
This structure stores the position and mass parameters of a galactic inspiral event.
REAL4 lGal
The Galactocentric Galactic longitude of the system (ie the Galactic longitude of the direction from ...
REAL4 z
The distance of the system from the Galactic plane, in kpc.
LIGOTimeGPS geocentEndTime
The geocentric end time of the inspiral event.
REAL4 rho
The distance of the binary system from the Galactic axis, in kpc.
This structure stores the parameters for constructing a restricted post-Newtonian waveform.
REAL4 fStopIn
The requested termination frequency of the waveform, in Hz; If set to 0, the waveform will be generat...
REAL4Vector * ppn
The parameters selecting the type of post-Newtonian expansion; If ppn=NULL, a "normal" (physical) ex...
const CHAR * termDescription
The termination code description (above)
INT4 termCode
The termination condition (above) that stopped computation of the waveform.
REAL4 dfdt
The maximum value of encountered over any timestep used in generating the waveform.
LIGOTimeGPS epoch
start time of output time series
REAL4 phi
The phase at coalescence (or arbitrary reference phase for a post -Newtonian approximation),...
REAL4 psi
polarization angle (radians)
REAL4 fStart
The actual starting frequency of the waveform, in Hz (normally close but not identical to fStartIn)
INT4 ampOrder
PN amplitude selection 0-5.
SkyPosition position
location of source on sky
UINT4 length
The length of the generated waveform.
REAL4 fStop
The frequency at the termination of the waveform, in Hz.
REAL4 eta
The mass ratio of the binary system; Physically this parameter must lie in the range ; values outsid...
REAL8 tc
The time from the start of the waveform to coalescence (in the point-mass approximation),...
REAL4 mTot
The total mass of the binary system, in solar masses.
REAL4 fStartIn
The requested starting frequency of the waveform, in Hz.
REAL8 deltaT
The requested sampling interval of the waveform, in s.
REAL4 d
The distance to the system, in metres.
UINT4 lengthIn
The maximum number of samples in the generated waveform; If zero, the waveforms can be arbitrarily lo...
REAL4 inc
The inclination of the system to the line of sight, in radians.