State

Field states.

class immunowave.state.State

Bases: Module, ABC

Field variables. Subclass this to implement your state, adding fields for the different components of the system.

map(fn)

Apply a function to each field.

Parameters:

fn (Any)

Return type:

Self

plot(time_idx=None, axes=None, **kwargs)

Plot the state.

Parameters:

• time_idx (int | None) – If self is the ys attribute of a diffrax.Solution with a series of time points, this index specifies which time index to plot

• axes (ndarray[tuple[Any, ...], dtype[Axes]] | None) – Axes on which to plot. If None, a new figure is created.

• kwargs (Any) – Keyword arguments passed to immunowave.spatial.ScalarField.plot().

Return type:

ndarray[tuple[Any, …], dtype[Axes]]