Source code for 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``.
"""

# typing
from types import NoneType
from typing import NamedTuple, Union

# astronomix constants
from astronomix.option_classes.simulation_config import STATE_TYPE




class StateStruct(NamedTuple):
    """
    Struct bundling the fluid state with any extra simulation quantities.
    """

    #: The fluid (primitive) state.
    primitive_state: Union[STATE_TYPE, NoneType] = None


    # Further fields (for example the positions of star particles) can be added
    # here as the simulation grows to follow additional quantities.