astronomix.data_classes.simulation_state_struct

astronomix.data_classes.simulation_state_struct#

Container for an extended simulation state.

Wraps the primitive fluid state in a small struct so simulations that follow additional quantities (e.g. star-particle positions) can carry them alongside the fluid. Selected via config.state_struct.

Module Contents#

Classes#

StateStruct

Struct bundling the fluid state with any extra simulation quantities.

API#

class astronomix.data_classes.simulation_state_struct.StateStruct[source]#

Bases: typing.NamedTuple

Struct bundling the fluid state with any extra simulation quantities.

primitive_state: Union[astronomix.option_classes.simulation_config.STATE_TYPE, types.NoneType] = None#