emulsim.actors package

Provides actors that determine the dynamics of the simulation by modifying the state of elements during each time step. Actors are separated into several categories, which we describe separately below.

General actors are classes that provide basic infrastructure to implement custom implementations:

ActorBase	Base class of a single actor that affects one or more elements.
FunctionActor	Actor that uses a python function to evolve elements.
NumbaFunctionActor	Actor that uses a compiled function to evolve the data of elements.

Autonomous actors only affect a single element and thus describe the autonomous dynamics of this element when it is not coupled to other elements.

ActiveParticleActor	Actor moving arrows according to their direction.
BoxActor	Actor containing particles in a box.
BrownianMotionActor	Actor moving objects according to Brownian motion.
CoalescenceDropletActor	Actor merging overlapping droplets.
EmittersActor	Actor emitting mass into a field at defined positions.
LocalReactionsActor	Actor simulating a local chemical reactions in a field.
ScalarPDEActor	Actor evolving a field according to a PDE.
DiffusionActor	Actor evolving a field according to a simple diffusion equation.
ReactionDiffusionActor	Actor evolving a field according to a reaction-diffusion equation.
CollectionPDEActor	Actor evolving a field collection according to a PDE.

Coupling actors affect several elements and thus describe a coupling between these elements.

DropletNucleationActor	Actor nucleating droplets from a field.
FieldCouplingActor	Actor coupling multiple fields by local interactions.
FieldExchangeActor	Actor exchanging material between two fields on the same grid.
FieldBoundaryExchangeActor	Actor exchanging material between a field and its boundary.
PointDropletActor	Actor coupling point-like droplets to a field.
SphericalDropletActor	Actor coupling spherical droplets to a field.
MulticomponentDropletActor	Actor coupling point-like multicomponent droplets to multiple field.

Use find_actors() to discover actors that are compatible with a given list of elements.

Subpackages:

• emulsim.actors.autonomous package
  • emulsim.actors.autonomous.active_particles module
  • emulsim.actors.autonomous.box module
  • emulsim.actors.autonomous.brownian_motion module
  • emulsim.actors.autonomous.coalescence module
  • emulsim.actors.autonomous.emitters module
  • emulsim.actors.autonomous.fields module
• emulsim.actors.coupling package
  • emulsim.actors.coupling.fields module
  • emulsim.actors.coupling.multicomponent_droplet module
  • emulsim.actors.coupling.nucleation module
  • emulsim.actors.coupling.point_droplet module
  • emulsim.actors.coupling.spherical_droplet module

• emulsim.actors.base module
• emulsim.actors.function module