From f7e10e2ce42487fdf8c8913313b1d26a937bd89a Mon Sep 17 00:00:00 2001
From: Christian Engwer <christi@dune-project.org>
Date: Wed, 8 Aug 2007 09:57:08 +0000
Subject: [PATCH] improved documentation of MPIHelper & CollectiveCommunication
[[Imported from SVN: r4968]]
---
common/collectivecommunication.hh | 17 ++++++++++++++++-
common/mpicollectivecommunication.hh | 3 +--
common/mpihelper.hh | 7 ++++++-
3 files changed, 23 insertions(+), 4 deletions(-)
diff --git a/common/collectivecommunication.hh b/common/collectivecommunication.hh
index b686a0a71..a9acd95c6 100644
--- a/common/collectivecommunication.hh
+++ b/common/collectivecommunication.hh
@@ -9,10 +9,25 @@
#include "exceptions.hh"
+/*! \defgroup ParallelCommunication Parallel Communication
+ \ingroup Common
+
+ Dune offers an abstraction to the basic methods of parallel
+ communication. It allows to switch parallel features on and of,
+ without changing the code.
+
+ */
+
namespace Dune
{
/*! @brief Collective communication interface and sequential default implementation
+ CollectiveCommunication offers an abstraction to the basic methods
+ of parallel communication, following the message-passing
+ paradigm. It allows to switch parallel features on and of, without
+ changing the code. Currently only MPI and sequential code are
+ supported.
+
A CollectiveCommunication object is returned by all grids (also
the sequential ones) in order to allow code to be written in
a transparent way for sequential and parallel grids.
@@ -29,7 +44,7 @@ namespace Dune
is not visible in the interface, i.e. Dune grid implementations
are not restricted to MPI.
- \ingroup GICollectiveCommunication
+ \ingroup ParallelCommunication
*/
template<typename C>
class CollectiveCommunication
diff --git a/common/mpicollectivecommunication.hh b/common/mpicollectivecommunication.hh
index 4bb2f174e..59912dacd 100644
--- a/common/mpicollectivecommunication.hh
+++ b/common/mpicollectivecommunication.hh
@@ -16,7 +16,6 @@
// MPI header
#include <mpi.h>
-
namespace Dune
{
//=======================================================
@@ -183,7 +182,7 @@ namespace Dune
//=======================================================
/*! \brief Specialization of CollectiveCommunication for MPI
- \ingroup GICollectiveCommunication
+ \ingroup ParallelCommunication
*/
template<>
class CollectiveCommunication<MPI_Comm>
diff --git a/common/mpihelper.hh b/common/mpihelper.hh
index 145a5e760..5f5ef5b7e 100644
--- a/common/mpihelper.hh
+++ b/common/mpihelper.hh
@@ -16,6 +16,7 @@ namespace Dune
/**
* @file
* @brief This file contains helpers for dealing with MPI.
+ * @ingroup ParallelCommunication
*
* Basically there are two helpers available:
* <dl>
@@ -126,6 +127,7 @@ namespace Dune
#if HAVE_MPI
/**
* @brief A real mpi helper.
+ * @ingroup ParallelCommunication
*
* This helper should be used for parallel programs.
*/
@@ -215,7 +217,10 @@ namespace Dune
#else
// We do not have MPI therefore FakeMPIHelper
// is the MPIHelper
- /** @brief If no MPI is available FakeMPIHelper becomes the MPIHelper */
+ /**
+ * @brief If no MPI is available FakeMPIHelper becomes the MPIHelper
+ * @ingroup ParallelCommunication
+ */
typedef FakeMPIHelper MPIHelper;
#endif
--
GitLab