lalsimulation.tilts_at_infinity.tilts_at_infinity_utils Namespace Reference

Data Structures
class	Error
	Base class for exceptions in this module. More...
class	NonprecessingError
	Exception raised when the evolution finds that the system is nonprecessing to numerical accuracy. More...
class	ValueWarning
	Warning raised when an input is dubious. More...
class	Warn
	Base class for warnings in this module. More...

Functions
def	warning_formatter (message, category, filename, lineno, file=None, line=None)
def	format_error (err)
def	check_masses (m1, m2)
def	eq_mass_check (m1, m2, Lf)
def	check_spin_mags (chi1, chi2)
def	check_tilts (tilt1, tilt2)
def	check_fref (fref, m1, m2, evol_type)
def	package_tilts (tilt1, tilt2, Lf, swap)
	Package tilts to be returned by prec_avg_tilt_comp_vec_inputs() or prec_avg_tilt_comp() depending on whether Lf is None or not. More...
def	evolution_error_handling (failure_mode, failure_message, failure_output, failure_output_string, Lf, swap, hybrid_evol=False)
	Take care of the error message or warning and returning something for the tilts when the precession-averaged evolution fails. More...

Variables
int	kg_to_m = G_SI/C_SI**2
int	kg_to_s = G_SI/C_SI**3
	formatwarning

Function Documentation

warning_formatter()

def lalsimulation.tilts_at_infinity.tilts_at_infinity_utils.warning_formatter	(		message,
			category,
			filename,
			lineno,
			file = None,
			line = None
	)

Definition at line 45 of file tilts_at_infinity_utils.py.

format_error()

def lalsimulation.tilts_at_infinity.tilts_at_infinity_utils.format_error

(

err

)

Definition at line 53 of file tilts_at_infinity_utils.py.

check_masses()

def lalsimulation.tilts_at_infinity.tilts_at_infinity_utils.check_masses	(		m1,
			m2
	)

Definition at line 57 of file tilts_at_infinity_utils.py.

eq_mass_check()

def lalsimulation.tilts_at_infinity.tilts_at_infinity_utils.eq_mass_check	(		m1,
			m2,
			Lf
	)

Definition at line 67 of file tilts_at_infinity_utils.py.

check_spin_mags()

def lalsimulation.tilts_at_infinity.tilts_at_infinity_utils.check_spin_mags	(		chi1,
			chi2
	)

Definition at line 79 of file tilts_at_infinity_utils.py.

check_tilts()

def lalsimulation.tilts_at_infinity.tilts_at_infinity_utils.check_tilts	(		tilt1,
			tilt2
	)

Definition at line 85 of file tilts_at_infinity_utils.py.

check_fref()

def lalsimulation.tilts_at_infinity.tilts_at_infinity_utils.check_fref	(		fref,
			m1,
			m2,
			evol_type
	)

Definition at line 91 of file tilts_at_infinity_utils.py.

package_tilts()

def lalsimulation.tilts_at_infinity.tilts_at_infinity_utils.package_tilts	(		tilt1,
			tilt2,
			Lf,
			swap
	)

Package tilts to be returned by prec_avg_tilt_comp_vec_inputs() or prec_avg_tilt_comp() depending on whether Lf is None or not.

Also swaps the tilts if necessary. Only works in the case when Lf is not None when the min, max, and average values are all the same.

Inputs:

tilt1, tilt2: Tilts Lf: Final orbital angular momentum (here just acts as a switch depending on whether it is None or not) swap: Whether to swap tilt1 and tilt2 before returning (True) or not (False)

Output: dictionary with entries 'tilt1_inf', 'tilt2_inf' for evolution to infinity–Lf is None–and entries 'tilt1_sep_min', 'tilt1_sep_max', 'tilt1_sep_avg', 'tilt2_sep_min', 'tilt2_sep_max', 'tilt2_sep_avg' for evolution to a finite separation (i.e., a finite orbital angular momentum), when Lf is not None

Definition at line 119 of file tilts_at_infinity_utils.py.

evolution_error_handling()

def lalsimulation.tilts_at_infinity.tilts_at_infinity_utils.evolution_error_handling	(		failure_mode,
			failure_message,
			failure_output,
			failure_output_string,
			Lf,
			swap,
			hybrid_evol = False
	)

Take care of the error message or warning and returning something for the tilts when the precession-averaged evolution fails.

Append entries for tilts at transition in the case where hybrid evolution fails.

Inputs: failure_mode: The failure mode (either "Error", "NAN", or "None") failure_message: The message to print in the error or warning failure output: What to output for the tilts in the event of a failure failure_output_string: The string associated with the failure output Lf: Final orbital angular momentum (here just acts as a switch depending on whether it is None or not) swap: Whether to swap tilt1 and tilt2 before returning (True) or not (False) hybrid_evol: Flag to invoke error handling in the hybrid evolution code. Default: False

Output: dictionary with entries 'tilt1_inf', 'tilt2_inf' for evolution to infinity–Lf is None–and entries 'tilt1_sep_min', 'tilt1_sep_max', 'tilt1_sep_avg', 'tilt2_sep_min', 'tilt2_sep_max', 'tilt2_sep_avg' for evolution to a finite separation (i.e., a finite orbital angular momentum), when Lf is not None. The entries of the dictionary are failure_output If hybrid_evol is set to True, entries 'tilt1_transition', 'tilt2_transition', 'phi12_transition', and 'f_transition' set as failure_output are appended to match the output of the hybrid evolution code.

Definition at line 150 of file tilts_at_infinity_utils.py.

Variable Documentation

kg_to_m

int lalsimulation.tilts_at_infinity.tilts_at_infinity_utils.kg_to_m = G_SI/C_SI**2

Definition at line 17 of file tilts_at_infinity_utils.py.

kg_to_s

int lalsimulation.tilts_at_infinity.tilts_at_infinity_utils.kg_to_s = G_SI/C_SI**3

Definition at line 19 of file tilts_at_infinity_utils.py.

formatwarning

lalsimulation.tilts_at_infinity.tilts_at_infinity_utils.formatwarning

Definition at line 48 of file tilts_at_infinity_utils.py.