Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion emulsim/actors/autonomous/active_particles.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
"""
"""Provides an actor for simulating active particles moving according to their direction.

.. autosummary::
:nosignatures:

~ActiveParticleActor

.. codeauthor:: David Zwicker <david.zwicker@ds.mpg.de>
"""

Expand Down
8 changes: 7 additions & 1 deletion emulsim/actors/autonomous/box.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
"""
"""Provides an actor that confines particles inside a box.

.. autosummary::
:nosignatures:

~BoxActor

.. codeauthor:: David Zwicker <david.zwicker@ds.mpg.de>
"""

Expand Down
8 changes: 7 additions & 1 deletion emulsim/actors/autonomous/brownian_motion.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
"""
"""Provides an actor for simulating Brownian motion.

.. autosummary::
:nosignatures:

~BrownianMotionActor

.. codeauthor:: David Zwicker <david.zwicker@ds.mpg.de>
"""

Expand Down
8 changes: 7 additions & 1 deletion emulsim/actors/autonomous/coalescence.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
"""
"""Provides an actor for simulating droplet coalescence.

.. autosummary::
:nosignatures:

~CoalescenceDropletActor

.. codeauthor:: David Zwicker <david.zwicker@ds.mpg.de>
"""

Expand Down
7 changes: 6 additions & 1 deletion emulsim/actors/autonomous/emitters.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
"""Provides a simple actor that emit mass into a field a predefined positions.
"""Provides a simple actor that emits mass into a field at predefined positions.

.. autosummary::
:nosignatures:

~EmittersActor

.. codeauthor:: David Zwicker <david.zwicker@ds.mpg.de>
"""
Expand Down
6 changes: 6 additions & 0 deletions emulsim/actors/base.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
"""Supplies the base class for actors.

.. autosummary::
:nosignatures:

~ActorBase
~find_actors

.. codeauthor:: David Zwicker <david.zwicker@ds.mpg.de>
"""

Expand Down
7 changes: 7 additions & 0 deletions emulsim/actors/coupling/fields.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
"""Provides an actor coupling two or more fields.

.. autosummary::
:nosignatures:

~FieldCouplingActor
~FieldExchangeActor
~FieldBoundaryExchangeActor

.. codeauthor:: David Zwicker <david.zwicker@ds.mpg.de>
"""

Expand Down
1 change: 1 addition & 0 deletions emulsim/actors/coupling/spherical_droplet.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
.. autosummary::
:nosignatures:

~PointsOnSphere
~ShellSectors
~ShellCollection
~SphericalDropletActor
Expand Down
1 change: 1 addition & 0 deletions emulsim/elements/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
ArrayElementBase
ArrayCollectionElementBase
ObjectElementBase
DictElementBase

The inheritance diagram reads

Expand Down
8 changes: 7 additions & 1 deletion emulsim/elements/multicomponent_droplets.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
"""Provides a simulation element representing spherical droplets.
"""Provides a simulation element representing multicomponent droplets.

.. autosummary::
:nosignatures:

~MulticomponentDroplet
~MulticomponentDropletsElement

.. codeauthor:: David Zwicker <david.zwicker@ds.mpg.de>
"""
Expand Down
6 changes: 6 additions & 0 deletions emulsim/elements/points.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
"""Provides an element that represents a collection of points.

.. autosummary::
:nosignatures:

~PointsElement
~ArrowsElement

.. codeauthor:: David Zwicker <david.zwicker@ds.mpg.de>
"""

Expand Down
5 changes: 5 additions & 0 deletions emulsim/elements/spherical_droplets.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
"""Provides a simulation element representing spherical droplets.

.. autosummary::
:nosignatures:

~SphericalDropletsElement

.. codeauthor:: David Zwicker <david.zwicker@ds.mpg.de>
"""

Expand Down
5 changes: 5 additions & 0 deletions emulsim/state.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
"""Provides a class representing the full system state of multiple elements.

.. autosummary::
:nosignatures:

~State

.. inheritance-diagram:: State
:parts: 1

Expand Down
Loading