openPMD-api
Public Member Functions | Public Attributes | List of all members
openpmd_api.pipe.__main__.Chunk Class Reference

Public Member Functions

def __init__ (self, offset, extent)
 
def __len__ (self)
 
def slice1D (self, mpi_rank, mpi_size, dimension=None)
 

Public Attributes

 offset
 
 extent
 

Detailed Description

A Chunk is an n-dimensional hypercube, defined by an offset and an extent.
Offset and extent must be of the same dimensionality (Chunk.__len__).

Member Function Documentation

◆ slice1D()

def openpmd_api.pipe.__main__.Chunk.slice1D (   self,
  mpi_rank,
  mpi_size,
  dimension = None 
)
Slice this chunk into mpi_size hypercubes along one of its
n dimensions. The dimension is given through the 'dimension'
parameter. If None, the dimension with the largest extent on
this hypercube is automatically picked.
Returns the mpi_rank'th of the sliced chunks.

The documentation for this class was generated from the following file: