jf1uids.data_classes.simulation_helper_data module

class jf1uids.data_classes.simulation_helper_data.HelperData(geometric_centers: Array | None = None, volumetric_centers: Array | None = None, r: Array | None = None, r_hat_alpha: Array | None = None, cell_volumes: Array | None = None, inner_cell_boundaries: Array | None = None, outer_cell_boundaries: Array | None = None)

Bases: NamedTuple

Helper data used throughout the simulation.

cell_volumes: Array

The cell volumes.

geometric_centers: Array

The geometric centers of the cells.

inner_cell_boundaries: Array

Coordinates of the inner cell boundaries.

outer_cell_boundaries: Array

Coordinates of the outer cell boundaries.

r: Array

cell center to box center distances only for config.dimensionality > 1

r_hat_alpha: Array

A helper variable, defined as hat{r}^alpha = V_j / (2 * alpha * pi * Delta r) with V_j the volume of cell j, alpha the geometry factor and Delta r the cell width.

volumetric_centers: Array

The volumetric centers of the cells. Same as the geometric centers for Cartesian geometry.

jf1uids.data_classes.simulation_helper_data.get_helper_data(config: SimulationConfig) → HelperData

Generate the helper data for the simulation from the configuration.