spectre.Pipelines.Bbh.InitialData

Functions

L1_distance(m1, m2, separation)

Distance of the L1 Lagrangian point from m1, in Newtonian gravity

generate_id(mass_a, mass_b, ...[, ...])

Generate initial data for a BBH simulation.

id_parameters(mass_a, mass_b, ...)

Determine initial data parameters from options.
spectre.Pipelines.Bbh.InitialData.L1_distance(m1, m2, separation)

Distance of the L1 Lagrangian point from m1, in Newtonian gravity

spectre.Pipelines.Bbh.InitialData.generate_id(mass_a: float, mass_b: float, dimensionless_spin_a: Sequence[float], dimensionless_spin_b: Sequence[float], separation: float, orbital_angular_velocity: float, radial_expansion_velocity: float, center_of_mass_offset: Sequence[float] = [0.0, 0.0, 0.0], linear_velocity: Sequence[float] = [0.0, 0.0, 0.0], refinement_level: int = 1, polynomial_order: int = 6, id_input_file_template: str | Path = ID_INPUT_FILE_TEMPLATE, control: bool = False, evolve: bool = False, eccentricity_control: bool = False, pipeline_dir: str | Path | None = None, run_dir: str | Path | None = None, segments_dir: str | Path | None = None, out_file_name: str = 'spectre.out', **scheduler_kwargs)

Generate initial data for a BBH simulation.

Parameters for the initial data will be inserted into the ‘id_input_file_template’. The remaining options are forwarded to the ‘schedule’ command. See ‘schedule’ docs for details.

The orbital parameters can be computed with the function ‘initial_orbital_parameters’ in ‘support.Pipelines.EccentricityControl.InitialOrbitalParameters’.

Intrinsic parameters:

mass_a: Mass of the larger black hole. mass_b: Mass of the smaller black hole. dimensionless_spin_a: Dimensionless spin of the larger black hole, chi_A. dimensionless_spin_b: Dimensionless spin of the smaller black hole, chi_B.

Orbital parameters:

separation: Coordinate separation D of the black holes. orbital_angular_velocity: Omega_0. radial_expansion_velocity: adot_0.

Control parameters:
center_of_mass_offset: Offset from the Newtonian center of mass.

(default: [0., 0., 0.])

linear_velocity: Velocity added to the shift boundary condition.

(default: [0., 0., 0.])

Scheduling options:

id_input_file_template: Input file template where parameters are inserted. control: If set to True, a postprocessing control loop will adjust the

input parameters to drive the horizon masses and spins to the specified values. If set to False, the horizon masses and spins in the generated data will differ from the input parameters. (default: False)

evolve: Set to True to evolve the initial data after generation. eccentricity_control: If set to True, an eccentricity reduction script is

run on the initial data to correct the initial orbital parameters.

pipeline_dir: Directory where steps in the pipeline are created. Required

when ‘evolve’ is set to True. The initial data will be created in a subdirectory ‘001_InitialData’.

run_dir: Directory where the initial data is generated. Mutually exclusive

with ‘pipeline_dir’.

segments_dir: Directory where the evolution data is generated. Mutually

exclusive with ‘pipeline_dir’ and ‘run_dir’.

out_file_name: Optional. Name of the log file. (Default: “spectre.out”)

spectre.Pipelines.Bbh.InitialData.id_parameters(mass_a: float, mass_b: float, dimensionless_spin_a: Sequence[float], dimensionless_spin_b: Sequence[float], center_of_mass_offset: Sequence[float], linear_velocity: Sequence[float], separation: float, orbital_angular_velocity: float, radial_expansion_velocity: float, refinement_level: int, polynomial_order: int)

Determine initial data parameters from options.

These parameters fill the ‘ID_INPUT_FILE_TEMPLATE’.

Parameters:

  • mass_a – Mass of the larger black hole.

  • mass_b – Mass of the smaller black hole.

  • dimensionless_spin_a – Dimensionless spin of the larger black hole, chi_A.

  • dimensionless_spin_b – Dimensionless spin of the smaller black hole, chi_B.

  • center_of_mass_offset – Offset from the Newtonian center of mass.

  • linear_velocity – Velocity added to the shift boundary condition.

  • separation – Coordinate separation D of the black holes.

  • orbital_angular_velocity – Omega_0.

  • radial_expansion_velocity – adot_0.

  • refinement_level – h-refinement level.

  • polynomial_order – p-refinement level.