From 6bc24e951e6e1bf5e5d7705a92b76d2b661ed037 Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Tue, 10 Jun 2025 17:20:40 -0400 Subject: [PATCH] document RemotePointEvaluation --- include/deal.II/base/mpi_remote_point_evaluation.h | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/include/deal.II/base/mpi_remote_point_evaluation.h b/include/deal.II/base/mpi_remote_point_evaluation.h index 4c81ce5e76..c23f1bc3ad 100644 --- a/include/deal.II/base/mpi_remote_point_evaluation.h +++ b/include/deal.II/base/mpi_remote_point_evaluation.h @@ -45,7 +45,19 @@ namespace Utilities namespace MPI { /** - * Helper class to access values on non-matching grids. + * @brief Communicate values between a mesh and arbitrary points + * + * This class enables evaluation of finite element functions defined + * on a Triangulation at arbitrary points inside the mesh. The underlying + * finite element mesh can be distributed among processes, which makes + * the operations more involved due to communication. + * + * The following helper functions for this class exist: + * VectorTools::point_values, VectorTools::point_gradients (the + * overloads taking an instance of RemotePointEvaluation). * + * + * @note Usage and implementation details of this class and the + * helper functions above are explained in detail in step-87. * * @note The name of the fields are chosen with the method * evaluate_and_process() in mind. Here, quantities are -- 2.39.5