Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gaohao95 committed Mar 25, 2024
1 parent 58562f6 commit 5c23f58
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions pytential/symbolic/execution.py
Original file line number Diff line number Diff line change
Expand Up @@ -1038,9 +1038,15 @@ def bind(places, expr, auto_where=None):


def bind_distributed(comm, places, expr, auto_where=None):
"""
:arg places: root rank contains the actual places, while worker ranks should pass
`None`.
"""Distributed version of `bind`.
Overall, this function accepts the same argument as the non-distributed version
on the root rank, with the addition of a MPI communicator. On the worker rank,
only the `comm` argument is significant.
:arg comm: MPI communicator.
:arg places: a :class:`pytential.collection.GeometryCollection`. Only significant
on the root rank. Worker ranks could simply pass `None`.
"""
if comm.Get_rank() == 0:
from pytential import GeometryCollection
Expand Down

0 comments on commit 5c23f58

Please sign in to comment.