particles.ClusterParticles.add_black_hole#

ClusterParticles.add_black_hole(bh_mass, pos=None, vel=None, use_pot_min=False)[source]#

Add a black hole particle to the set of cluster particles.

Parameters:

  • bh_mass (float) – The mass of the black hole particle in solar masses.

  • pos (array-like, optional) – The position of the particle, assumed to be in units of kpc if units are not given. If use_pot_min=True this argument is ignored. Default: None, in which case the particle position is [0.0, 0.0, 0.0] kpc.

  • vel (array-like, optional) – The velocity of the particle, assumed to be in units of kpc/Myr if units are not given. If use_pot_min=True this argument is ignored. Default: None, in which case the particle velocity is [0.0, 0.0, 0.0] kpc/Myr.

  • use_pot_min (boolean, optional) – If True, use the dark matter particle with the minimum value of the gravitational potential to determine the position and velocity of the black hole particle. Default: False