Skip to content

Commit 96d06fa

Browse files
committed
Clarify documentation
1 parent 73a77fc commit 96d06fa

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

grudge/discretization.py

Lines changed: 8 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`,
@@ -654,7 +655,9 @@ def set_up_distributed_communication(
654655
array_context: ArrayContext, mesh: Mesh,
655656
volume_discr,
656657
discr_tag_to_group_factory, comm=None) -> dict:
657-
"""
658+
"""Constructs a mapping from parallel boundary partition and the relevant
659+
discretization connections to that boundary. Used for distributed runs.
660+
658661
:arg volume_discr: A :class:`meshmode.discretization.Discretization`
659662
object for the base (:class:`grudge.dof_desc.DISCR_TAG_BASE`)
660663
volume discretization.
@@ -707,6 +710,9 @@ def set_up_distributed_communication(
707710

708711

709712
def _generate_modal_group_factory(nodal_group_factory):
713+
"""Returns the relevant modal element group factory for a
714+
given nodal group factory *nodal_group_factory*.
715+
"""
710716
from meshmode.discretization.poly_element import (
711717
ModalSimplexGroupFactory,
712718
ModalTensorProductGroupFactory

0 commit comments

Comments
 (0)