mayawaves.compactobject module

class mayawaves.compactobject.CompactObject(data_array: Dataset, header_list: list, identifier: int, object_type: str, initial_irreducible_mass: float, initial_horizon_mass: float, initial_dimensionless_spin: ndarray, initial_dimensional_spin: ndarray)

Class containing all information pertaining to a compact object that is part of a coalescence.

class Column(value): Enum for easily referencing columns of desired data.

property apparent_horizon_area: tuple: The time and the area of the apparent horizon over time.

property apparent_horizon_areal_radius: tuple: The time and areal radius of the apparent horizon over time.

property apparent_horizon_circumferences: tuple: The time and apparent horizon circumferences in the XY, XZ, and YZ planes respectively over time.

property apparent_horizon_expansion_theta_l: tuple: The time and the expansion Theta_(l) over time.

property apparent_horizon_inner_expansion_theta_n: tuple: The time and the inner expansion Theta_(n) on the apparent horizon over time.

property apparent_horizon_maximum_radius: tuple: The time and maximum apparent horizon radius over time.

property apparent_horizon_mean_curvature: tuple: The time and mean curvature of the apparent horizon over time.

property apparent_horizon_mean_radius: tuple: The time and mean apparent horizon radius over time.

property apparent_horizon_minimum_radius: tuple: The time and apparent horizon minimum radius over time.

property apparent_horizon_quadrupoles: tuple

The time and apparent horizon quadrupoles over time.

Returns a tuple including the time, xx quadrupole, xy quadrupole, xz quadrupole, yy quadrupole, yz quadrupole, zz quadrupole.

property available_data_columns: list: All the Columns included for this compact object.

property data_array: ndarray: Function to be used internally to return the full data array for this compact object.

dimensional_spin_at_time(desired_time: float) → ndarray

Dimensional spin vector (\(\pmb{S}\) or \(\pmb{J}\)) at a given time.

Parameters:: desired_time (float) – the time at which to return the spin
Returns:: the dimensional spin vector at the desired time
Return type:: np.ndarray

property dimensional_spin_vector: tuple: The time and dimensional spin vector (\(\pmb{S}\) or \(\pmb{J}\)) over time.

dimensionless_spin_at_time(desired_time: float) → ndarray

Dimensionless spin vector (\(\pmb{a}\) or \(\pmb{\chi} = \pmb{J}/M^2\)) at a giventime.

Parameters:: desired_time (float) – the time at which to return the spin
Returns:: the dimensionless spin vector at the desired time
Return type:: np.ndarray

property dimensionless_spin_vector: tuple: The time and dimensionless spin vector (\(\pmb{a}\) or \(\pmb{\chi} = \pmb{J}/M^2\)) over time.

property final_dimensional_spin: ndarray: The last available dimensional spin (\(\pmb{S}\) or \(\pmb{J}\)) data

property final_dimensionless_spin: ndarray: The last available dimensionless spin (\(\pmb{a}\) or \(\pmb{\chi} = \pmb{J}/M^2\)) data

property final_horizon_mass: float: The last available horizon mass data

property final_irreducible_mass: float: The last available irreducible mass data

get_data_from_columns(column_names: list) → ndarray

Get the data in the requested columns (properties).

Given a list of columns, returns the data at iterations where all columns have values.

Parameters:: column_names (list) – list of desired columns, in the form of enums
Returns:: the data at the requested columns
Return type:: np.ndarray

property horizon_mass: tuple: The time and horizon mass over time.

horizon_mass_at_time(desired_time: float) → float

Horizon mass at a given time.

Parameters:: desired_time – the time at which to return the mass
Returns:: the horizon mass at the desired time
Return type:: float

property initial_dimensional_spin: ndarray: The dimensional spin (\(\pmb{S}\) or \(\pmb{J}\)) at the beginning of the simulation.

property initial_dimensionless_spin: ndarray: The dimensionless spin (\(\pmb{a}\) or \(\pmb{\chi} = \pmb{J}/M^2\)) at the beginning of the simulation.

property initial_horizon_mass: float: The horizon mass at the beginning of the simulation.

property initial_irreducible_mass: float: The irreducible mass at the beginning of the simulation.

property irreducible_mass: tuple: The time and irreducible mass over time.

irreducible_mass_at_time(desired_time: float) → float

Irreducible mass at a given time.

Parameters:: desired_time – the time at which to return the mass
Returns:: the irreducible mass at the desired time
Return type:: float

property last_available_spin_data_time: float: The last time at which spin data is available.

property momentum_vector: tuple: The time and momentum vector over time.

property position_vector: tuple: The time and position vector over time.

property velocity_vector: tuple: The time and velocity vector over time.