Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALInspiral 5.0.3.1-b246709
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
GeneratePPNInspiralTest.c File Reference

Generates a parametrized post-Newtonian inspiral waveform. More...

Detailed Description

Generates a parametrized post-Newtonian inspiral waveform.

Author
Creighton, T. D.

Usage

GeneratePPNInspiralTest [-m m1 m2] [-r dist] [-i inc phii] [-f f_min f_max]
[-t dt] [-w deltat] [-p order] [-d debuglevel] [-o outfile]
double i
const double w
static const INT4 r
static const INT4 m
p
double f_min
double f_max
char * outfile

Description

This program generates the amplitude, phase, and frequency of a post-Newtonian inspiral waveform as functions of time. The following option flags are accepted:

  • [-m] Sets the binary masses to m1 and m2 solar massses (default values: \(1.4M_\odot\)).
  • [-r] Sets the binary system distance to dist kpc (default value: 8.5kpc).
  • [-i] Sets the inclination and initial phase angles to inc and phii degrees (default values: 0\ degrees).
  • [-f] Sets the initial and final wave frequencies to f_min and f_max Hz (default values: 40Hz and 500Hz).
  • [-t] Sets the waveform sampling interval to dt seconds (default value: 0.01s).
  • [-w] Generates actual waveforms rather than phase and amplitude functions, sampled at intervals of deltat seconds (no default).
  • [-p] Sets the post \({}^{n/2}\)-Newtonian order to \(n=\)order (default value: \(n=4\)).
  • [-d] Sets the debug level to debuglevel (default value:\ 0).
  • [-o] Sets the output filename to outfile (by default no output is produced).

Algorithm

This program simply parses the command line, sets the appropriate fields of a PPNParamStruc, and passes it in to LALGeneratePPNInspiral(). No maximum waveform length is specified; the function will allocate as much data as necessary.

If the -w and -o options are given, the amplitude, phase, and frequency are generated as above, but are then resampled at intervals deltat to generate actual wave output.

Definition in file GeneratePPNInspiralTest.c.

Go to the source code of this file.

Macros

Error Codes
#define GENERATEPPNINSPIRALTESTC_ENORM   0
 Normal exit. More...
 
#define GENERATEPPNINSPIRALTESTC_ESUB   1
 Subroutine failed. More...
 
#define GENERATEPPNINSPIRALTESTC_EARG   2
 Error parsing arguments. More...
 
#define GENERATEPPNINSPIRALTESTC_EVAL   3
 Input argument out of valid range. More...
 
#define GENERATEPPNINSPIRALTESTC_EFILE   4
 Could not open file. More...
 
#define GENERATEPPNINSPIRALTESTC_EPRINT   5
 Wrote past end of message string. More...
 

Macro Definition Documentation

◆ GENERATEPPNINSPIRALTESTC_ENORM

#define GENERATEPPNINSPIRALTESTC_ENORM   0

Normal exit.

Definition at line 77 of file GeneratePPNInspiralTest.c.

◆ GENERATEPPNINSPIRALTESTC_ESUB

#define GENERATEPPNINSPIRALTESTC_ESUB   1

Subroutine failed.

Definition at line 78 of file GeneratePPNInspiralTest.c.

◆ GENERATEPPNINSPIRALTESTC_EARG

#define GENERATEPPNINSPIRALTESTC_EARG   2

Error parsing arguments.

Definition at line 79 of file GeneratePPNInspiralTest.c.

◆ GENERATEPPNINSPIRALTESTC_EVAL

#define GENERATEPPNINSPIRALTESTC_EVAL   3

Input argument out of valid range.

Definition at line 80 of file GeneratePPNInspiralTest.c.

◆ GENERATEPPNINSPIRALTESTC_EFILE

#define GENERATEPPNINSPIRALTESTC_EFILE   4

Could not open file.

Definition at line 81 of file GeneratePPNInspiralTest.c.

◆ GENERATEPPNINSPIRALTESTC_EPRINT

#define GENERATEPPNINSPIRALTESTC_EPRINT   5

Wrote past end of message string.

Definition at line 82 of file GeneratePPNInspiralTest.c.