Skip to content

Commit 0f4a6e5

Browse files
committed
Clarify documentation
1 parent 8e2ea22 commit 0f4a6e5

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

grudge/discretization.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -573,7 +573,8 @@ def make_discretization_collection(
573573
order=None,
574574
discr_tag_to_group_factory=None,
575575
mpi_communicator=None) -> DiscretizationCollection:
576-
"""Construct a discretization collection.
576+
"""Construct a discretization collection given an array context *array_context*,
577+
mesh *mesh*, and user-provided discretization parameters.
577578
578579
:arg discr_tag_to_group_factory: A mapping from discretization tags
579580
(typically one of: :class:`grudge.dof_desc.DISCR_TAG_BASE`,
@@ -584,6 +585,7 @@ def make_discretization_collection(
584585
to be carried out, or *None* to indicate that operations with this
585586
discretization tag should be carried out with the standard volume
586587
discretization.
588+
:arg mpi_communicator: An (optional) MPI communicator.
587589
:returns: A :class:`DiscretizationCollection`.
588590
"""
589591
from meshmode.discretization.poly_element import \
@@ -654,7 +656,9 @@ def set_up_distributed_communication(
654656
array_context: ArrayContext, mesh: Mesh,
655657
volume_discr,
656658
discr_tag_to_group_factory, comm=None) -> dict:
657-
"""
659+
"""Constructs a mapping from parallel boundary partition and the relevant
660+
discretization connections to that boundary. Used for distributed runs.
661+
658662
:arg volume_discr: A :class:`meshmode.discretization.Discretization`
659663
object for the base (:class:`grudge.dof_desc.DISCR_TAG_BASE`)
660664
volume discretization.
@@ -707,6 +711,9 @@ def set_up_distributed_communication(
707711

708712

709713
def _generate_modal_group_factory(nodal_group_factory):
714+
"""Returns the relevant modal element group factory for a
715+
given nodal group factory *nodal_group_factory*.
716+
"""
710717
from meshmode.discretization.poly_element import (
711718
ModalSimplexGroupFactory,
712719
ModalTensorProductGroupFactory

0 commit comments

Comments
 (0)