jf1uids.data_classes.simulation_helper_data

jf1uids.data_classes.simulation_helper_data#

Module Contents#

Classes#

HelperData

Helper data used throughout the simulation.

Functions#

get_helper_data

Generate the helper data for the simulation from the configuration.

API#

class jf1uids.data_classes.simulation_helper_data.HelperData#

Bases: typing.NamedTuple

Helper data used throughout the simulation.

geometric_centers: jax.numpy.ndarray = None#
volumetric_centers: jax.numpy.ndarray = None#
r: jax.numpy.ndarray = None#
r_hat_alpha: jax.numpy.ndarray = None#
cell_volumes: jax.numpy.ndarray = None#
inner_cell_boundaries: jax.numpy.ndarray = None#
outer_cell_boundaries: jax.numpy.ndarray = None#
jf1uids.data_classes.simulation_helper_data.get_helper_data(config: jf1uids.option_classes.simulation_config.SimulationConfig, sharding: Union[types.NoneType, jax.NamedSharding] = None, padded: bool = False) → jf1uids.data_classes.simulation_helper_data.HelperData#

Generate the helper data for the simulation from the configuration.

Contents