astronomix.data_classes.simulation_state_struct module

astronomix.data_classes.simulation_state_struct module#

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.

class astronomix.data_classes.simulation_state_struct.StateStruct(primitive_state: Float[Array, 'num_vars num_cells_x'] | Float[Array, 'num_vars num_cells_x num_cells_y'] | Float[Array, 'num_vars num_cells_x num_cells_y num_cells_z'] | None = None)[source]#

Bases: NamedTuple

Struct bundling the fluid state with any extra simulation quantities.

primitive_state: Float[Array, 'num_vars num_cells_x'] | Float[Array, 'num_vars num_cells_x num_cells_y'] | Float[Array, 'num_vars num_cells_x num_cells_y num_cells_z'] | None#

The fluid (primitive) state.

Contents