yt.data_objects.construction_data_containers.YTCoveringGridBase

class yt.data_objects.construction_data_containers.YTCoveringGridBase(level, left_edge, dims, fields=None, ds=None, num_ghost_zones=0, use_pbar=True, field_parameters=None)[source]

A 3D region with all data extracted to a single, specified resolution. Left edge should align with a cell boundary, but defaults to the closest cell boundary.

Parameters:

level : int

The resolution level data to which data will be gridded. Level 0 is the root grid dx for that dataset.

left_edge : array_like

The left edge of the region to be extracted. Specify units by supplying a YTArray, otherwise code length units are assumed.

dims : array_like

Number of cells along each axis of resulting covering_grid

fields : array_like, optional

A list of fields that you’d like pre-generated for your object

Examples

>>> cube = ds.covering_grid(2, left_edge=[0.0, 0.0, 0.0],     ...                          dims=[128, 128, 128])

Attributes

Methods