States

machwave.states

State

Bases: ABC

The State class: - Stores simulation data - Iterates a simulation loop - Presents simulation data

Source code in machwave/states/base.py

class State(ABC):
    """
    The State class:
    - Stores simulation data
    - Iterates a simulation loop
    - Presents simulation data
    """

    @abstractmethod
    def __init__(self) -> None:
        """
        Initializes the operation, receiving arguments such as initial
        conditions or boundary conditions.
        """
        pass

    @abstractmethod
    def run_timestep(self, *args, **kwargs):
        """
        Runs on every iteration of a simulation loop, incrementing results
        and storing them in the State instance (self).
        """
        pass

    @abstractmethod
    def print_results(self, *args, **kwargs):
        """
        Prints some key values and metrics obtained from the operation.
        """
        pass

__init__() abstractmethod

Initializes the operation, receiving arguments such as initial conditions or boundary conditions.

Source code in machwave/states/base.py

@abstractmethod
def __init__(self) -> None:
    """
    Initializes the operation, receiving arguments such as initial
    conditions or boundary conditions.
    """
    pass

print_results(*args, **kwargs) abstractmethod

Prints some key values and metrics obtained from the operation.

Source code in machwave/states/base.py

@abstractmethod
def print_results(self, *args, **kwargs):
    """
    Prints some key values and metrics obtained from the operation.
    """
    pass

run_timestep(*args, **kwargs) abstractmethod

Runs on every iteration of a simulation loop, incrementing results and storing them in the State instance (self).

Source code in machwave/states/base.py

@abstractmethod
def run_timestep(self, *args, **kwargs):
    """
    Runs on every iteration of a simulation loop, incrementing results
    and storing them in the State instance (self).
    """
    pass