Skip to content

Commit 5c23f58

Browse files
committed
Add documentation
1 parent 58562f6 commit 5c23f58

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

pytential/symbolic/execution.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1038,9 +1038,15 @@ def bind(places, expr, auto_where=None):
10381038

10391039

10401040
def bind_distributed(comm, places, expr, auto_where=None):
1041-
"""
1042-
:arg places: root rank contains the actual places, while worker ranks should pass
1043-
`None`.
1041+
"""Distributed version of `bind`.
1042+
1043+
Overall, this function accepts the same argument as the non-distributed version
1044+
on the root rank, with the addition of a MPI communicator. On the worker rank,
1045+
only the `comm` argument is significant.
1046+
1047+
:arg comm: MPI communicator.
1048+
:arg places: a :class:`pytential.collection.GeometryCollection`. Only significant
1049+
on the root rank. Worker ranks could simply pass `None`.
10441050
"""
10451051
if comm.Get_rank() == 0:
10461052
from pytential import GeometryCollection

0 commit comments

Comments
 (0)