pisces.extensions.simulation.core.initial_conditions.InitialConditions.get_particle_fields#

InitialConditions.get_particle_fields(model_name: str) dict[str, list[tuple[str, tuple[int, ...]]]][source]#

Inspect the available fields for each particle species in a model.

This is a wrapper around inspect_fields().

Parameters:

model_name (str) – The name/identifier of the model whose particle fields should be inspected.

Returns:

Mapping of particle species names to lists of (field_name, element_shape) tuples.

Return type:

dict

Raises:
  • KeyError – If the model name is not found in the initial conditions.

  • FileNotFoundError – If the referenced particle file does not exist.