LALSimulation  5.4.0.1-fe68b98
LALSimInspiralWaveformFlags.h File Reference

Prototypes

LALSimInspiralWaveformFlags * XLALSimInspiralCreateWaveformFlags (void)
 Create a new LALSimInspiralWaveformFlags struct with all flags set to their default values. More...
 
void XLALSimInspiralDestroyWaveformFlags (LALSimInspiralWaveformFlags *waveFlags)
 Destroy a LALSimInspiralWaveformFlags struct. More...
 
bool XLALSimInspiralWaveformParamsFlagsAreDefault (LALDict *params)
 Returns true if waveFlags is non-NULL and all of its fields have default value; returns false otherwise. More...
 
bool XLALSimInspiralWaveformFlagsIsDefaultOLD (LALSimInspiralWaveformFlags *waveFlags)
 Returns true if waveFlags is non-NULL and all of its fields have default value; returns false otherwise. More...
 
bool XLALSimInspiralWaveformFlagsEqualOLD (LALSimInspiralWaveformFlags *waveFlags1, LALSimInspiralWaveformFlags *waveFlags2)
 Checks if all flags in two LALSimInspiralWaveformFlags structs are equal. More...
 
bool XLALSimInspiralWaveformFlagsEqual (LALDict *LALpars1, LALDict *LALpars2)
 Checks if all flags in two LALSimInspiralWaveformFlags structs are equal. More...
 
void XLALSimInspiralSetSpinOrder (LALSimInspiralWaveformFlags *waveFlags, LALSimInspiralSpinOrder spinO)
 Set the LALSimInspiralSpinOrder within a LALSimInspiralWaveformFlags struct. More...
 
LALSimInspiralSpinOrder XLALSimInspiralGetSpinOrder (LALSimInspiralWaveformFlags *waveFlags)
 Get the LALSimInspiralSpinOrder within a LALSimInspiralWaveformFlags struct, or LAL_SIM_INSPIRAL_SPIN_ORDER_DEFAULT if waveFlags is NULL. More...
 
bool XLALSimInspiralSpinOrderIsDefault (LALSimInspiralSpinOrder spinO)
 Returns true if LALSimInspiralSpinOrder has default value returns false otherwise. More...
 
void XLALSimInspiralSetTidalOrder (LALSimInspiralWaveformFlags *waveFlags, LALSimInspiralTidalOrder tideO)
 Set the LALSimInspiralTidalOrder within a LALSimInspiralWaveformFlags struct. More...
 
LALSimInspiralTidalOrder XLALSimInspiralGetTidalOrder (LALSimInspiralWaveformFlags *waveFlags)
 Get the LALSimInspiralTidalOrder within a LALSimInspiralWaveformFlags struct, or LAL_SIM_INSPIRAL_TIDAL_ORDER_DEFAULT if waveFlags is NULL. More...
 
bool XLALSimInspiralTidalOrderIsDefault (LALSimInspiralTidalOrder tideO)
 Returns true if LALSimInspiralTidalOrder has default value returns false otherwise. More...
 
void XLALSimInspiralSetFrameAxis (LALSimInspiralWaveformFlags *waveFlags, LALSimInspiralFrameAxis axisChoice)
 Set the LALSimInspiralFrameAxis within a LALSimInspiralWaveformFlags struct. More...
 
LALSimInspiralFrameAxis XLALSimInspiralGetFrameAxis (LALSimInspiralWaveformFlags *waveFlags)
 Get the LALSimInspiralFrameAxis within a LALSimInspiralWaveformFlags struct, or LAL_SIM_INSPIRAL_FRAME_AXIS_DEFAULT if waveFlags is NULL. More...
 
bool XLALSimInspiralFrameAxisIsDefault (LALSimInspiralFrameAxis axisChoice)
 Returns true if LALSimInspiralFrameAxis has default value returns false otherwise. More...
 
void XLALSimInspiralSetModesChoice (LALSimInspiralWaveformFlags *waveFlags, LALSimInspiralModesChoice modesChoice)
 Set the LALSimInspiralModesChoice within a LALSimInspiralWaveformFlags struct. More...
 
LALSimInspiralModesChoice XLALSimInspiralGetModesChoice (LALSimInspiralWaveformFlags *waveFlags)
 Get the LALSimInspiralModesChoice within a LALSimInspiralWaveformFlags struct, or LAL_SIM_INSPIRAL_MODES_CHOICE_DEFAULT if waveFlags is NULL. More...
 
bool XLALSimInspiralModesChoiceIsDefault (LALSimInspiralModesChoice modesChoice)
 Returns true if LALSimInspiralModesChoice has default value returns false otherwise. More...
 
void XLALSimInspiralSetNumrelDataOLD (LALSimInspiralWaveformFlags *waveFlags, const char *numreldata)
 Set the numreldata string within a LALSimInspiralWaveformFlags struct. More...
 
charXLALSimInspiralGetNumrelDataOLD (LALSimInspiralWaveformFlags *waveFlags)
 Returns a deepcopy of the pointer of the numeraldata attribute of the waveFlags structure. More...
 
LALValue * XLALSimInspiralCreateModeArray (void)
 Create a LALValue pointer to store the mode array. More...
 
LALValue * XLALSimInspiralModeArrayActivateMode (LALValue *modes, unsigned l, int m)
 
LALValue * XLALSimInspiralModeArrayDeactivateMode (LALValue *modes, unsigned l, int m)
 
LALValue * XLALSimInspiralModeArrayActivateAllModes (LALValue *modes)
 
LALValue * XLALSimInspiralModeArrayDeactivateAllModes (LALValue *modes)
 
int XLALSimInspiralModeArrayIsModeActive (LALValue *modes, unsigned l, int m)
 
LALValue * XLALSimInspiralModeArrayActivateAllModesAtL (LALValue *modes, unsigned l)
 
LALValue * XLALSimInspiralModeArrayDeactivateAllModesAtL (LALValue *modes, unsigned l)
 
int XLALSimInspiralModeArrayPrintModes (LALValue *modes)
 
INT2SequenceXLALSimInspiralModeArrayReadModes (LALValue *modes)
 
charXLALSimInspiralModeArrayToModeString (LALValue *modes)
 
LALValue * XLALSimInspiralModeArrayFromModeString (const char *modestr)
 

Go to the source code of this file.

Macros

#define LAL_SIM_INSPIRAL_SPIN_ORDER_DEFAULT   LAL_SIM_INSPIRAL_SPIN_ORDER_ALL
 Default values for all enumerated flags. More...
 
#define LAL_SIM_INSPIRAL_TIDAL_ORDER_DEFAULT   LAL_SIM_INSPIRAL_TIDAL_ORDER_ALL
 
#define LAL_SIM_INSPIRAL_GMTIDES_DEFAULT   LAL_SIM_INSPIRAL_GMTIDES_OFF
 
#define LAL_SIM_INSPIRAL_FRAME_AXIS_DEFAULT   LAL_SIM_INSPIRAL_FRAME_AXIS_ORBITAL_L
 
#define LAL_SIM_INSPIRAL_MODES_CHOICE_DEFAULT   LAL_SIM_INSPIRAL_MODES_CHOICE_RESTRICTED
 
#define LAL_SIM_L_MAX_MODE_ARRAY   8
 Maximum L spherical harmonic mode that is supported in Mode Array. More...
 

Enumerations

enum  LALSimInspiralSpinOrder {
  LAL_SIM_INSPIRAL_SPIN_ORDER_0PN = 0 , LAL_SIM_INSPIRAL_SPIN_ORDER_05PN = 1 , LAL_SIM_INSPIRAL_SPIN_ORDER_1PN = 2 , LAL_SIM_INSPIRAL_SPIN_ORDER_15PN = 3 ,
  LAL_SIM_INSPIRAL_SPIN_ORDER_2PN = 4 , LAL_SIM_INSPIRAL_SPIN_ORDER_25PN = 5 , LAL_SIM_INSPIRAL_SPIN_ORDER_3PN = 6 , LAL_SIM_INSPIRAL_SPIN_ORDER_35PN = 7 ,
  LAL_SIM_INSPIRAL_SPIN_ORDER_ALL = -1
}
 Enumeration of allowed PN orders of spin effects. More...
 
enum  LALSimInspiralTidalOrder {
  LAL_SIM_INSPIRAL_TIDAL_ORDER_0PN = 0 , LAL_SIM_INSPIRAL_TIDAL_ORDER_5PN = 10 , LAL_SIM_INSPIRAL_TIDAL_ORDER_6PN = 12 , LAL_SIM_INSPIRAL_TIDAL_ORDER_65PN = 13 ,
  LAL_SIM_INSPIRAL_TIDAL_ORDER_7PN = 14 , LAL_SIM_INSPIRAL_TIDAL_ORDER_75PN = 15 , LAL_SIM_INSPIRAL_TIDAL_ORDER_ALL = -1
}
 Enumeration of allowed PN orders of tidal effects. More...
 
enum  LALSimInspiralGETides {
  LAL_SIM_INSPIRAL_GETIDES_OFF , LAL_SIM_INSPIRAL_GETIDES_NNLO , LAL_SIM_INSPIRAL_GETIDES_GSF2 , LAL_SIM_INSPIRAL_GETIDES_GSF23 ,
  LAL_SIM_INSPIRAL_GETIDES_NOPT
}
 
enum  LALSimInspiralGMTides { LAL_SIM_INSPIRAL_GMTIDES_OFF , LAL_SIM_INSPIRAL_GMTIDES_PN , LAL_SIM_INSPIRAL_GMTIDES_GSF , LAL_SIM_INSPIRAL_GMTIDES_NOPT }
 
enum  LALSimInspiralFrameAxis { LAL_SIM_INSPIRAL_FRAME_AXIS_VIEW , LAL_SIM_INSPIRAL_FRAME_AXIS_TOTAL_J , LAL_SIM_INSPIRAL_FRAME_AXIS_ORBITAL_L }
 Enumerator for choosing the reference frame associated with PSpinInspiralRD waveforms. More...
 
enum  LALSimInspiralModesChoice {
  LAL_SIM_INSPIRAL_MODES_CHOICE_DEFAULT = 1 , LAL_SIM_INSPIRAL_MODES_CHOICE_3L = 1<<1 , LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3L = (1<<2) - 1 , LAL_SIM_INSPIRAL_MODES_CHOICE_4L = 1<<2 ,
  LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND4L = (1<<3) - 1 , LAL_SIM_INSPIRAL_MODES_CHOICE_2AND4L = (1<<3) - 1 - (1<<1) , LAL_SIM_INSPIRAL_MODES_CHOICE_3AND4L = (1<<3) - (1<<1) , LAL_SIM_INSPIRAL_MODES_CHOICE_5L = 1<<3 ,
  LAL_SIM_INSPIRAL_MODES_CHOICE_2AND5L = (1<<3) + 1 , LAL_SIM_INSPIRAL_MODES_CHOICE_3AND5L = (1<<3) + (1<<1) , LAL_SIM_INSPIRAL_MODES_CHOICE_4AND5L = (1<<3) + (1<<2) , LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND5L = (1<<4) - 1 -(1<<2) ,
  LAL_SIM_INSPIRAL_MODES_CHOICE_2AND4AND5L = (1<<4) - 1 -(1<<1) , LAL_SIM_INSPIRAL_MODES_CHOICE_3AND4AND5L = (1<<4) - (1<<1) , LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND4AND5L = (1<<4) - 1 , LAL_SIM_INSPIRAL_MODES_CHOICE_ALL = - 1
}
 Enumerator for choosing which modes to include in IMR models. More...