Detailed Description

This structure stores the parameters for constructing a restricted post-Newtonian waveform.

It is divided into three parts: parameters passed along to the output structure but not used by waveform generator, parameters used as input to the waveform generator, and parameters set by the generator to evaluate its success.

Definition at line 230 of file GeneratePPNInspiral.h.

Data Fields
Passed parameters.
SkyPosition	position
	location of source on sky More...

REAL4	psi
	polarization angle (radians) More...

LIGOTimeGPS	epoch
	start time of output time series More...

Input parameters.
REAL4	mTot
	The total mass \(m_\mathrm{tot}=m_1+m_2\) of the binary system, in solar masses. More...

REAL4	eta
	The mass ratio \(\eta=m_1m_2/m_\mathrm{tot}^2\) of the binary system; Physically this parameter must lie in the range \(\eta\in(0,1/4]\); values outside of this range may be permitted in order to represent "nonphysical" post-Newtonian expansions. More...

REAL4	d
	The distance to the system, in metres. More...

REAL4	inc
	The inclination of the system to the line of sight, in radians. More...

REAL4	phi
	The phase at coalescence \(\phi_c\) (or arbitrary reference phase for a post \({}^{5/2}\)-Newtonian approximation), in radians. More...

REAL8	deltaT
	The requested sampling interval of the waveform, in s. More...

REAL4	fStartIn
	The requested starting frequency of the waveform, in Hz. More...

REAL4	fStopIn
	The requested termination frequency of the waveform, in Hz; If set to 0, the waveform will be generated until a termination condition (above) is met; If set to a negative number, the generator will use its absolute value as the terminating frequency, but will ignore post-Newtonian breakdown; it will terminate only at the requested frequency \(-\mathtt{fStopIn}\), a local maximum frequency, or the central singularity. More...

UINT4	lengthIn
	The maximum number of samples in the generated waveform; If zero, the waveforms can be arbitrarily long. More...

REAL4Vector *	ppn
	The parameters \(p_n\) selecting the type of post-Newtonian expansion; If `ppn=NULL,` a "normal" (physical) expansion is assumed. More...

INT4	ampOrder
	PN amplitude selection 0-5. More...

Output parameters.
REAL8	tc
	The time \(t_c-t\) from the start of the waveform to coalescence (in the point-mass approximation), in s. More...

REAL4	dfdt
	The maximum value of \(\Delta f\Delta t\) encountered over any timestep \(\Delta t\) used in generating the waveform. More...

REAL4	fStart
	The actual starting frequency of the waveform, in Hz (normally close but not identical to `fStartIn`) More...

REAL4	fStop
	The frequency at the termination of the waveform, in Hz. More...

UINT4	length
	The length of the generated waveform. More...

INT4	termCode
	The termination condition (above) that stopped computation of the waveform. More...

const CHAR *	termDescription
	The termination code description (above) More...

Field Documentation

◆ position

SkyPosition PPNParamStruc::position

location of source on sky

Definition at line 233 of file GeneratePPNInspiral.h.

◆ psi

REAL4 PPNParamStruc::psi

polarization angle (radians)

Definition at line 234 of file GeneratePPNInspiral.h.

◆ epoch

LIGOTimeGPS PPNParamStruc::epoch

start time of output time series

Definition at line 235 of file GeneratePPNInspiral.h.

◆ mTot

REAL4 PPNParamStruc::mTot

The total mass \(m_\mathrm{tot}=m_1+m_2\) of the binary system, in solar masses.

Definition at line 240 of file GeneratePPNInspiral.h.

◆ eta

REAL4 PPNParamStruc::eta

The mass ratio \(\eta=m_1m_2/m_\mathrm{tot}^2\) of the binary system; Physically this parameter must lie in the range \(\eta\in(0,1/4]\); values outside of this range may be permitted in order to represent "nonphysical" post-Newtonian expansions.

Definition at line 241 of file GeneratePPNInspiral.h.

◆ d

REAL4 PPNParamStruc::d

The distance to the system, in metres.

Definition at line 246 of file GeneratePPNInspiral.h.

◆ inc

REAL4 PPNParamStruc::inc

The inclination of the system to the line of sight, in radians.

Definition at line 247 of file GeneratePPNInspiral.h.

◆ phi

REAL4 PPNParamStruc::phi

The phase at coalescence \(\phi_c\) (or arbitrary reference phase for a post \({}^{5/2}\)-Newtonian approximation), in radians.

Definition at line 248 of file GeneratePPNInspiral.h.

◆ deltaT

REAL8 PPNParamStruc::deltaT

The requested sampling interval of the waveform, in s.

Definition at line 251 of file GeneratePPNInspiral.h.

◆ fStartIn

REAL4 PPNParamStruc::fStartIn

The requested starting frequency of the waveform, in Hz.

Definition at line 252 of file GeneratePPNInspiral.h.

◆ fStopIn

REAL4 PPNParamStruc::fStopIn

The requested termination frequency of the waveform, in Hz; If set to 0, the waveform will be generated until a termination condition (above) is met; If set to a negative number, the generator will use its absolute value as the terminating frequency, but will ignore post-Newtonian breakdown; it will terminate only at the requested frequency \(-\mathtt{fStopIn}\), a local maximum frequency, or the central singularity.

Definition at line 253 of file GeneratePPNInspiral.h.

◆ lengthIn

UINT4 PPNParamStruc::lengthIn

The maximum number of samples in the generated waveform; If zero, the waveforms can be arbitrarily long.

Definition at line 261 of file GeneratePPNInspiral.h.

◆ ppn

REAL4Vector* PPNParamStruc::ppn

The parameters \(p_n\) selecting the type of post-Newtonian expansion; If ppn=NULL, a "normal" (physical) expansion is assumed.

Definition at line 262 of file GeneratePPNInspiral.h.

◆ ampOrder

INT4 PPNParamStruc::ampOrder

PN amplitude selection 0-5.

Definition at line 263 of file GeneratePPNInspiral.h.

◆ tc

REAL8 PPNParamStruc::tc

The time \(t_c-t\) from the start of the waveform to coalescence (in the point-mass approximation), in s.

Definition at line 268 of file GeneratePPNInspiral.h.

◆ dfdt

REAL4 PPNParamStruc::dfdt

The maximum value of \(\Delta f\Delta t\) encountered over any timestep \(\Delta t\) used in generating the waveform.

Definition at line 269 of file GeneratePPNInspiral.h.

◆ fStart

REAL4 PPNParamStruc::fStart

The actual starting frequency of the waveform, in Hz (normally close but not identical to fStartIn)

Definition at line 270 of file GeneratePPNInspiral.h.

◆ fStop

REAL4 PPNParamStruc::fStop

The frequency at the termination of the waveform, in Hz.

Definition at line 271 of file GeneratePPNInspiral.h.

◆ length

UINT4 PPNParamStruc::length

The length of the generated waveform.

Definition at line 272 of file GeneratePPNInspiral.h.

◆ termCode

INT4 PPNParamStruc::termCode

The termination condition (above) that stopped computation of the waveform.

Definition at line 273 of file GeneratePPNInspiral.h.

◆ termDescription

const CHAR* PPNParamStruc::termDescription

The termination code description (above)

Definition at line 274 of file GeneratePPNInspiral.h.