From f0d6b30190ca80c206d17b639f57a94922543a75 Mon Sep 17 00:00:00 2001 From: Carsten Burstedde Date: Wed, 6 Mar 2024 14:54:31 +0100 Subject: [PATCH] Feature gmt: white space --- example/gmt/gmt_models.c | 11 ++++++----- example/gmt/gmt_models.h | 8 ++++---- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/example/gmt/gmt_models.c b/example/gmt/gmt_models.c index e7bde636e..7167672fa 100644 --- a/example/gmt/gmt_models.c +++ b/example/gmt/gmt_models.c @@ -1036,11 +1036,12 @@ p4est_gmt_communicate_points (sc_MPI_Comm mpicomm, { int mpiret; int num_procs; - /** Communication data */ - p4est_gmt_comm_t *own = &model->own; /* not responsible */ - p4est_gmt_comm_t *resp = &model->resp; /* responsible */ - sc_MPI_Request *send_req; /* requests for sending to receivers */ - sc_MPI_Request *recv_req; /* requests for receiving from senders */ + + /* Communication data */ + p4est_gmt_comm_t *own = &model->own; /**< not responsible */ + p4est_gmt_comm_t *resp = &model->resp; /**< responsible */ + sc_MPI_Request *send_req; /**< requests for sending to receivers */ + sc_MPI_Request *recv_req; /**< requests for receiving from senders */ /* get total process count */ mpiret = sc_MPI_Comm_size (mpicomm, &num_procs); diff --git a/example/gmt/gmt_models.h b/example/gmt/gmt_models.h index 80646150d..7060cdcd8 100644 --- a/example/gmt/gmt_models.h +++ b/example/gmt/gmt_models.h @@ -163,7 +163,7 @@ void p4est_gmt_model_destroy (p4est_gmt_model_t * model); * Used in distributed mode so that points are moved to the appropriate * processes before refinement. This function also handles updating the field * model->M, as well as internal communication metadata for subsequent - * iterations. + * iterations. This function is collective over the communicator. * * To support distributed mode a model should (in setup) load a distinct * subset of points on each process. Each process must set model->M as the @@ -173,9 +173,9 @@ void p4est_gmt_model_destroy (p4est_gmt_model_t * model); * intersection function model->intersect should be written so that an input * of m refers to the mth point stored in model->points. * - * \param[in] mpicomm MPI communicator - * \param[in] p4est The forest - * \param[in] model the model + * \param[in] mpicomm MPI communicator (collective function). + * \param[in] p4est The forest is not modified. + * \param[in,out] model The model whose M and points variables change. */ void p4est_gmt_communicate_points (sc_MPI_Comm mpicomm,