emulsim.actors.base module

Supplies the base class for actors.

ActorBase	Base class of a single actor that affects one or more elements.
find_actors	Finds actors compatible with the given elements.

class ActorBase(parameters: dict[str, Any] | None = None)

Bases: Parameterized

Base class of a single actor that affects one or more elements.

Parameters:

parameters (dict) – Parameters defining the behavior of the actor. Call show_parameters() for details.

copy() → ActorBase

Returns a copy the actor.

diagnostics: dict[str, Any]

element_classes: tuple[type[_ElementBase] | tuple[type[_ElementBase], ...], ...] | EllipsisType = ()

defines the elements this actor handles and in what order they need to be supplied. An ellipsis (…) indicates that all elements and lists of elements are accepted. Setting this attribute allows internal consistency checks.

Type:

tuple

estimate_dt(elements: tuple[_ElementBase, ...]) → float

Estimate the maximal time step for simulating this actor.

Parameters:

elements (tuple of _ElementBase) – The elements that this actor affects

Returns:

the maximal time step

Return type:

float

abstractmethod evolve(elements: tuple[_ElementBase, ...], t: float, dt: float)

Evolve the state from time t to t + dt

Parameters:

• elements (tuple of _ElementBase) – The elements that this actor affects

• t (float) – The current time point

• dt (float) – The time step

property info: dict[str, Any]

information about the actor

Type:

dict

make_evolver_numba(elements: tuple[_ElementBase, ...]) → Callable[[tuple[ndarray, ...], float, float], None]

Return a function evolve the state from time t to t + dt

Parameters:

elements (tuple of _ElementBase) – The elements that this actor affects

Returns:

A function with signature

(state_data: ndarray, t: float, dt: float), evolving state_data

Return type:

callable

property num_elements: int | EllipsisType

the number of elements this actor affects. This value is determined from the element_classes attribute

Type:

int

classmethod supports_elements(*elements: _ElementBase | type[_ElementBase], silent: bool = False) → bool

Determines whether this actor supports the given elements.

Parameters:

• elements (_ElementBase) – Various elements or element classes.

• silent (bool) – Determines whether the function returns silently or whether an exception is raised when an element is not supported.

Returns:

Whether the current actor supports the elements in the given order

Return type:

bool

find_actors(*elements: _ElementBase | type[_ElementBase], unordered: bool = False) → list[type[ActorBase]]

Finds actors compatible with the given elements.

Parameters:

• elements (_ElementBase) – Element classes or instances that shall serve as input for the actors

• unordered (bool) – Determines whether also actors are returned that only accept a reordered arrangement of the elements.

Returns:

A list of all compatible actor classes

Return type:

list of ActorBase