jf1uids.data_classes.simulation_state_struct module

jf1uids.data_classes.simulation_state_struct module#

class jf1uids.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 for the simulation state.

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 state.