ics.ClusterICs.__init__#

ClusterICs.__init__(basename, num_halos, profiles, center, velocity, num_particles=None, mag_file=None, particle_files=None, r_max=20000.0, r_max_tracer=None)[source]#

Initialize the ics.ClusterICs instance from a set of models.

Parameters:

  • basename (str) – The name used in reference to output files from this instance.

  • num_halos (int) – The number of halos to be included in the initial conditions system.

  • profiles (list of model.ClusterModel) – The cluster models to initialize as part of the simulation ICs.

  • center (unyt.array.unyt_array) – The centers of the profiles.

  • velocity (unyt.array.unyt_array) – The velocities of the clusters in the ICs.

  • num_particles (dict of str: int, optional) – The number of particles to include for each species. Should be a dictionary with keys stars and dm (and gas if running an SPH code) followed by values corresponding to the number of particles to initialize in each case.

  • mag_file (str, optional) – The path to a file containing the magnetic field.

  • particle_files (str, optional) – The path to any files containing pre-generated particle data.

  • r_max (float or int or unyt.array.quantity, optional) – The maximal radius at which to truncate the entire simulation domain.

  • r_max_tracer (float or int or unyt.array.quantity, optional) – The maximal tracer radius.