model.HydrostaticEquilibrium.create_dataset#

HydrostaticEquilibrium.create_dataset(domain_dimensions, box_size=None, left_edge=None, velocity=None, **kwargs)#

Warning

This method can be memory intensive. We suggest being conservative in your choice of domain size to begin in order to avoid OOM issues. For reference, a domain dimension of [500,500,500] will take appox. 3Gb / field.

Create an in-memory, uniformly gridded dataset in 3D using yt by placing the cluster into a box.

Parameters:

  • domain_dimensions (3-tuple of ints) – The number of cells on a side for the domain.

  • box_size (float, optional) – The size of the box in kpc. If not specified, will default to the size of the cluster.

  • left_edge (array_like, optional) – The minimum coordinate of the box in all three dimensions, in kpc. Default: None, which means the left edge will be [-r,-r,-r].

  • velocity (unyt_array, optional) – The velocity of the cluster relative to the frame of the box. Default is 0. If specified, must be a 1X3 array.