From 1592001c7ecbf5cd842585654f7ddf41e399a464 Mon Sep 17 00:00:00 2001 From: Daniel Arndt Date: Wed, 25 Sep 2019 21:05:37 -0400 Subject: [PATCH] Document direction parameter for periodic constraints --- include/deal.II/dofs/dof_tools.h | 6 ++++-- include/deal.II/grid/grid_tools.h | 4 +++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/include/deal.II/dofs/dof_tools.h b/include/deal.II/dofs/dof_tools.h index fd8c77abbf..772a23c44b 100644 --- a/include/deal.II/dofs/dof_tools.h +++ b/include/deal.II/dofs/dof_tools.h @@ -1218,7 +1218,8 @@ namespace DoFTools * * This function tries to match all faces belonging to the first boundary * with faces belonging to the second boundary with the help of - * orthogonal_equality(). + * orthogonal_equality(). More precisely, faces with coordinates only + * differing in the @p direction component are identified. * * If this matching is successful it constrains all DoFs associated with the * 'first' boundary to the respective DoFs of the 'second' boundary @@ -1256,7 +1257,8 @@ namespace DoFTools * boundary_ids this function defines a 'left' boundary as all faces with * local face index 2*dimension and boundary indicator @p b_id * and, similarly, a 'right' boundary consisting of all face with local face - * index 2*dimension+1 and boundary indicator @p b_id. + * index 2*dimension+1 and boundary indicator @p b_id. Faces with + * coordinates only differing in the @p direction component are identified. * * @note This version of make_periodicity_constraints will not work on * meshes with cells not in diff --git a/include/deal.II/grid/grid_tools.h b/include/deal.II/grid/grid_tools.h index fb287ace42..23cba652cc 100644 --- a/include/deal.II/grid/grid_tools.h +++ b/include/deal.II/grid/grid_tools.h @@ -2571,7 +2571,9 @@ namespace GridTools * boundary_ids this function defines a 'left' boundary as all faces with * local face index 2*dimension and boundary indicator @p b_id * and, similarly, a 'right' boundary consisting of all face with local face - * index 2*dimension+1 and boundary indicator @p b_id. + * index 2*dimension+1 and boundary indicator @p b_id. Faces + * with coordinates only differing in the @p direction component are + * identified. * * This function will collect periodic face pairs on the coarsest mesh level * and add them to @p matched_pairs leaving the original contents intact. -- 2.39.5