FvParticles

class tfv.particles.FvParticles

Low-level particle processing functionality

grid_timestep(x: ndarray | dask.array.Array, y: ndarray | dask.array.Array, z: ndarray | dask.array.Array, values: ndarray | dask.array.Array | None = None, xedges: ndarray = None, yedges: ndarray = None, zedges: ndarray = None, agg: str = 'mean') → dask.array.Array

Grid a single timestep of particle data with Dask support

Parameters:

• x – Particle coordinates (numpy or dask arrays)

• y – Particle coordinates (numpy or dask arrays)

• z – Particle coordinates (numpy or dask arrays)

• values – Values to grid (optional)

• xedges – Grid edges

• yedges – Grid edges

• zedges – Grid edges

• agg – Aggregation method

Returns:

Gridded data with shape (nz, ny, nx)

Return type:

da.Array