API for the jaxqualin.qnmode module

mode

Bases: mode_free

A class representing a frequency-fixed mode of a black hole.

Attributes:

Name	Type	Description
M	float	The mass of the black hole.
a	float	The spin parameter of the black hole.
retro_def_orbit	bool	Whether define retrograde modes with respect to the orbital frame (True) or remnant black hole frame (False). See the methods paper for details.

mode_free

A class representing a mode of a black hole.

Attributes:

Name	Type	Description
lmnx	Union[List[List[int]], str]	A list of lists of integers representing the mode numbers, or a string equal to constant. Each list of integers represents a constituent linear mode, and the list of lists represents a nonlinear mode if len(lmnx) > 1. For example, [[2, 2, 0], [3, 3, 0]] represents the 2,2,0x3,3,0 quadratic mode.
spinseq_list	List[KerrSpinSeq]	A list of qnm.spinsequence.KerrSpinSeq objects of the qnm package that maps the spin parameter a of the black hole into the QNM frequencies.
spinseq_list_neg_a	List[KerrSpinSeq]	Same as spinseq_list but for the retrograde branch of the QNM solution.
omegar	float	The real part of the QNM , if fixed. jaxlib.xla_extension.ArrayImpl of a single jnp.float64.
omegai	float	The imaginary part of the QNM frequency, if fixed. jaxlib.xla_extension.ArrayImpl of a single jnp.float64.
omega	complex	The complex QNM frequency, if fixed. jaxlib.xla_extension.ArrayImpl of a single jnp.complex128.
M	float	The mass of the black hole, if fixed.
a	float	The spin parameter of the black hole, if fixed.

Methods:

Name	Description
__init__	Initializes a mode_free object.
fix_mode	Fixes the complex frequency of the mode.

__init__(lmnx, s=-2)

Initializes a mode_free object.

Parameters:

Name	Type	Description	Default
lmnx	Union[List[List[int]], str]	A list of lists of integers representing the mode numbers, or a string equal to constant. Each list of integers represents a constituent linear mode, and the list of lists represents a nonlinear mode if len(lmnx) > 1. For example, [[2, 2, 0], [3, 3, 0]] represents the 2,2,0x3,3,0 quadratic mode.	required
s	int	The spin weight of the mode. Defaults to -2.	-2

fix_mode(M, a, retro_def_orbit=True)

Fixes the complex frequency of the mode.

Parameters:

Name	Type	Description	Default
M	float	The mass of the black hole.	required
a	float	The spin parameter of the black hole.	required
retro_def_orbit	bool	Whether to define retrograde modes with respect to the orbital frame (True) or remnant black hole frame (False). See the methods paper for details. Defaults to True.	True

is_overtone()

Determines whether the mode is an overtone.

Returns:

Type	Description
bool	Whether the mode is an overtone.

string()

Returns a string representation of the mode numbers.

Returns:

Type	Description
str	A string representation of the mode numbers.

sum_lm()

Returns the sum of the mode quantum numbers of constituent linear modes.

Returns:

Type	Description
Tuple[int, int]	The sum of the mode quantum numbers of constituent linear modes.

tex_string()

Returns a TeX string representation of the mode numbers.

Returns:

Type	Description
str	A TeX string representation of the mode numbers.