Commit 25af88f4 authored by Jean-Noël Grad's avatar Jean-Noël Grad
Browse files

Fix 756 Doxygen warnings

Delete Doxygen blocks duplicated in both .h and .cpp files.
Fix incorrect argument names in \param blocks. Fix filenames
in \file blocks. Fix broken Doxygen syntax (broken numerated
lists containing more than 9 items, invalid HTML tags, broken
links in \ref and malformed math equations). Wrap code blocks
inside \code ... \endcode.
parent 26462f8e
...@@ -52,7 +52,7 @@ private: ...@@ -52,7 +52,7 @@ private:
* Every boundary class must be derived from this class and implement the following concept/member functions (for some * Every boundary class must be derived from this class and implement the following concept/member functions (for some
* exemplary implementations look at classes NoSlip, FreeSlip, UBB, or SimpleUBB in module lbm/boundary): * exemplary implementations look at classes NoSlip, FreeSlip, UBB, or SimpleUBB in module lbm/boundary):
* *
* 1. "static shared_ptr<BoundaryConfiguration> createConfiguration( const Config::BlockHandle & config )" * 1. "static shared_ptr<BoundaryConfiguration> createConfiguration( const Config::BlockHandle & config )"
* This function is used to extract parameters from a configuration file and pass them to the boundary condition. * This function is used to extract parameters from a configuration file and pass them to the boundary condition.
* Meaning: This function defines how the parameter specification for this boundary condition must look like in the * Meaning: This function defines how the parameter specification for this boundary condition must look like in the
* configuration file. * configuration file.
...@@ -60,35 +60,35 @@ private: ...@@ -60,35 +60,35 @@ private:
* "{ return make_shared<BoundaryConfiguration>(); }" * "{ return make_shared<BoundaryConfiguration>(); }"
* If you do need to pass parameters, these parameters must be implemented in terms of a derived class of * If you do need to pass parameters, these parameters must be implemented in terms of a derived class of
* "BoundaryConfiguration" (as an example, see class "UBB"). * "BoundaryConfiguration" (as an example, see class "UBB").
* 2. "void pushFlags( std::vector< FlagUID >& uids )" * 2. "void pushFlags( std::vector< FlagUID >& uids )"
* This function receives (by reference) a vector and must insert (using push_back!) all FlagUIDs into this vector * This function receives (by reference) a vector and must insert (using push_back!) all FlagUIDs into this vector
* that mark cells as boundary cells that must be treated by this boundary condition. * that mark cells as boundary cells that must be treated by this boundary condition.
* 3. "void beforeBoundaryTreatment()" * 3. "void beforeBoundaryTreatment()"
* This function is called once before the boundary handler starts the boundary treatment. Of course, this function * This function is called once before the boundary handler starts the boundary treatment. Of course, this function
* is called every time the boundary treatment of the boundary handler is triggered (normally once per time step). * is called every time the boundary treatment of the boundary handler is triggered (normally once per time step).
* 4. "void afterBoundaryTreatment()" * 4. "void afterBoundaryTreatment()"
* Just like "beforeBoundaryTreatment", this function is called once after the boundary handler has finished the * Just like "beforeBoundaryTreatment", this function is called once after the boundary handler has finished the
* boundary treatment. * boundary treatment.
* 5. "template< typename Buffer_T > * 5. "template< typename Buffer_T >
* void packCell( Buffer_T & buffer, const cell_idx_t x, const cell_idx_t y, const cell_idx_t z )" * void packCell( Buffer_T & buffer, const cell_idx_t x, const cell_idx_t y, const cell_idx_t z )"
* This function is called every time a boundary cell that is handled by this boundary class is serialized. If * This function is called every time a boundary cell that is handled by this boundary class is serialized. If
* the boundary condition stores additional parameters for the boundary cell (x,y,z) these parameters must be * the boundary condition stores additional parameters for the boundary cell (x,y,z) these parameters must be
* serialized and stored in the buffer "buffer". [5) serializes and 6) deserializes, both functions must match] * serialized and stored in the buffer "buffer". [5) serializes and 6) deserializes, both functions must match]
* 6. "template< typename Buffer_T > * 6. "template< typename Buffer_T >
* void registerCell( Buffer_T & buffer, * void registerCell( Buffer_T & buffer,
* const flag_t flag, const cell_idx_t x, const cell_idx_t y, const cell_idx_t z )" * const flag_t flag, const cell_idx_t x, const cell_idx_t y, const cell_idx_t z )"
* This function is called every time a boundary cell that is handled by this boundary class is deserialized. The * This function is called every time a boundary cell that is handled by this boundary class is deserialized. The
* flag which was set (must be part of this->mask_!), the cell (x,y,z), and a buffer that potentially stores * flag which was set (must be part of this->mask_!), the cell (x,y,z), and a buffer that potentially stores
* parameters are passed. [5) serializes and 6) deserializes, both functions must match] * parameters are passed. [5) serializes and 6) deserializes, both functions must match]
* 7. "void registerCell( const flag_t flag, const cell_idx_t x, const cell_idx_t y, const cell_idx_t z, * 7. "void registerCell( const flag_t flag, const cell_idx_t x, const cell_idx_t y, const cell_idx_t z,
* const BoundaryConfiguration & parameter )" * const BoundaryConfiguration & parameter )"
* This function is called every time a boundary that is handled by this boundary class is set at the boundary * This function is called every time a boundary that is handled by this boundary class is set at the boundary
* handler. The flag which was set (must be part of this->mask_!), the cell (x,y,z), and a corresponding parameter * handler. The flag which was set (must be part of this->mask_!), the cell (x,y,z), and a corresponding parameter
* are passed. * are passed.
* 8. "void registerCells( const flag_t flag, const CellInterval & cells, const BoundaryConfiguration & parameter )" * 8. "void registerCells( const flag_t flag, const CellInterval & cells, const BoundaryConfiguration & parameter )"
* Just like "registerCell", only this function is called if a boundary that is handled by this boundary class is * Just like "registerCell", only this function is called if a boundary that is handled by this boundary class is
* set for each cell in a specific cell interval (-> "cells"). * set for each cell in a specific cell interval (-> "cells").
* 9. "template< typename CellIterator > * 9. "template< typename CellIterator >
* void registerCells( const flag_t flag, const CellIterator & begin, const CellIterator & end, * void registerCells( const flag_t flag, const CellIterator & begin, const CellIterator & end,
* const BoundaryConfiguration & parameter )" * const BoundaryConfiguration & parameter )"
* Just like the previous two functions, only this function is called if multiple boundary cells that are handled * Just like the previous two functions, only this function is called if multiple boundary cells that are handled
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
// You should have received a copy of the GNU General Public License along // You should have received a copy of the GNU General Public License along
// with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>. // with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
// //
//! \file Format.h //! \file Format.hpp
//! \ingroup core //! \ingroup core
//! \author Dominik Thoennes <dominik.thoennes@fau.de> //! \author Dominik Thoennes <dominik.thoennes@fau.de>
// //
......
...@@ -197,7 +197,7 @@ public: ...@@ -197,7 +197,7 @@ public:
inline Parameter<T> getParameter( std::string key ) const; inline Parameter<T> getParameter( std::string key ) const;
template< typename T > template< typename T >
inline Parameter<T> getParameter( const std::string & key, const T & defaultValue ) const; inline Parameter<T> getParameter( const std::string & key, const T & def ) const;
inline bool setParameter( const std::string & key, const std::string & value ); inline bool setParameter( const std::string & key, const std::string & value );
...@@ -278,7 +278,7 @@ public: ...@@ -278,7 +278,7 @@ public:
inline Parameter<T> getParameter( const std::string & key ) const; inline Parameter<T> getParameter( const std::string & key ) const;
template< typename T > template< typename T >
inline Parameter<T> getParameter( const std::string & key, const T& defaultValue ) const; inline Parameter<T> getParameter( const std::string & key, const T& def ) const;
bool isValid() const { return block_ != nullptr; } bool isValid() const { return block_ != nullptr; }
operator bool() const { return isValid(); } operator bool() const { return isValid(); }
...@@ -346,7 +346,7 @@ public: ...@@ -346,7 +346,7 @@ public:
inline Parameter<T> getParameter( const std::string& key ) const; inline Parameter<T> getParameter( const std::string& key ) const;
template< typename T > template< typename T >
inline Parameter<T> getParameter( const std::string& key, const T & defaultValue ) const; inline Parameter<T> getParameter( const std::string& key, const T & def ) const;
inline iterator begin(); inline iterator begin();
...@@ -514,7 +514,7 @@ inline Config::Parameter<Type> Config::getParameter( const std::string & key ) c ...@@ -514,7 +514,7 @@ inline Config::Parameter<Type> Config::getParameter( const std::string & key ) c
//********************************************************************************************************************** //**********************************************************************************************************************
/*!\fn Config::Parameter<T> Config::getParameter( const std::string& key, const T& ) const /*!\fn Config::Parameter<T> Config::getParameter( const std::string& key, const T& def ) const
// \brief Returns an extracted parameter. // \brief Returns an extracted parameter.
// //
// \param key The key of the extracted parameter. // \param key The key of the extracted parameter.
...@@ -1093,6 +1093,7 @@ inline const std::string& Config::BlockHandle::getKey() const ...@@ -1093,6 +1093,7 @@ inline const std::string& Config::BlockHandle::getKey() const
/*!\fn bool Config::BlockHandle::isDefined( std::string key ) const /*!\fn bool Config::BlockHandle::isDefined( std::string key ) const
// \brief Checks if a parameter was defined in the parameter file. // \brief Checks if a parameter was defined in the parameter file.
// //
// \param key The parameter key to be checked.
// \return \a true if the parameter was defined, \a false if the parameter wasn't defined. // \return \a true if the parameter was defined, \a false if the parameter wasn't defined.
*/ */
inline bool Config::BlockHandle::isDefined( std::string key ) const inline bool Config::BlockHandle::isDefined( std::string key ) const
...@@ -1118,7 +1119,7 @@ inline Config::Parameter<Type> Config::BlockHandle::getParameter( const std::str ...@@ -1118,7 +1119,7 @@ inline Config::Parameter<Type> Config::BlockHandle::getParameter( const std::str
//********************************************************************************************************************** //**********************************************************************************************************************
//********************************************************************************************************************** //**********************************************************************************************************************
/*!\fn Config::Parameter<T> Config::BlockHandle::getParameter( const std::string& key, const T & ) const /*!\fn Config::Parameter<T> Config::BlockHandle::getParameter( const std::string& key, const T & def ) const
// \brief Returns an extracted parameter. // \brief Returns an extracted parameter.
// //
// \param key The key of the extracted parameter. // \param key The key of the extracted parameter.
......
//====================================================================================================================== //======================================================================================================================
/*! /*!
* \file CMakeDefs.h * \file CMakeDefs.in.h
* \brief Definitions for core/logging configured by cmake * \brief Definitions for core/logging configured by cmake
*/ */
//====================================================================================================================== //======================================================================================================================
......
...@@ -73,7 +73,7 @@ static void parseIgnoreBlocks( const Config::Blocks & ignoreBlocks, std::vector< ...@@ -73,7 +73,7 @@ static void parseIgnoreBlocks( const Config::Blocks & ignoreBlocks, std::vector<
* This initialization function reads data stored in a configuration file and uses thi data to configure the logging * This initialization function reads data stored in a configuration file and uses thi data to configure the logging
* singleton. * singleton.
* The structure of the configuration file which is recognized by this function must look like as follows: * The structure of the configuration file which is recognized by this function must look like as follows:
* \code * \code{.unparsed}
* Logging { // the whole 'Logging' block is optional * Logging { // the whole 'Logging' block is optional
* *
* logLevel warning|info|progress|detail|tracing; // optional, default=info * logLevel warning|info|progress|detail|tracing; // optional, default=info
...@@ -102,7 +102,7 @@ static void parseIgnoreBlocks( const Config::Blocks & ignoreBlocks, std::vector< ...@@ -102,7 +102,7 @@ static void parseIgnoreBlocks( const Config::Blocks & ignoreBlocks, std::vector<
* *
* Log messages can be ignored by specifying a regular expression on the filename and line number of the source * Log messages can be ignored by specifying a regular expression on the filename and line number of the source
* file the log message originates from. The regex has to be specified in an ignore block as the parameter * file the log message originates from. The regex has to be specified in an ignore block as the parameter
* callerPathPattern. If the regular expression is found somewhere in the string <filename>:<line number>, * callerPathPattern. If the regular expression is found somewhere in the string `<filename>:<line number>`,
* the log message is ignored. To divide components of your path always uses slashes! * the log message is ignored. To divide components of your path always uses slashes!
* They will automatically be converted to the regex (/|\\), matching slashes and back-slashes. For fancy regexes * They will automatically be converted to the regex (/|\\), matching slashes and back-slashes. For fancy regexes
* you can use perl regex syntax. * you can use perl regex syntax.
...@@ -110,11 +110,13 @@ static void parseIgnoreBlocks( const Config::Blocks & ignoreBlocks, std::vector< ...@@ -110,11 +110,13 @@ static void parseIgnoreBlocks( const Config::Blocks & ignoreBlocks, std::vector<
* Note that you cannot ignore Errors since they abort your program! * Note that you cannot ignore Errors since they abort your program!
* *
* Examples: * Examples:
* \code{.unparsed}
* ignore { callerPathPattern /src/core/; } // ignores log messages from core * ignore { callerPathPattern /src/core/; } // ignores log messages from core
* ignore { callerPathPattern /src/vtk/; } // ignores log messages from vtk * ignore { callerPathPattern /src/vtk/; } // ignores log messages from vtk
* ignore { callerPathPattern (/src/core/|/src/vtk/); } // ignores log messages from core & vtk * ignore { callerPathPattern (/src/core/|/src/vtk/); } // ignores log messages from core & vtk
* ignore { callerPathPattern /src/core/FILENAME.h:416; } // ignores a specific log message * ignore { callerPathPattern /src/core/FILENAME.h:416; } // ignores a specific log message
* ignoreWarning { callerPathPattern /src/core/FILENAME.h:212; } // ignores a specific warning * ignoreWarning { callerPathPattern /src/core/FILENAME.h:212; } // ignores a specific warning
* \endcode{.unparsed}
* *
* \param config The configuration * \param config The configuration
*/ */
......
//====================================================================================================================== //======================================================================================================================
/*! /*!
* \file CMakeDefs.h * \file CMakeDefs.in.h
* \brief Definitions for core/math configured by cmake * \brief Definitions for core/math configured by cmake
*/ */
//====================================================================================================================== //======================================================================================================================
......
...@@ -132,9 +132,9 @@ public: ...@@ -132,9 +132,9 @@ public:
inline value_type intersectionVolume( const GenericAABB & other ) const; inline value_type intersectionVolume( const GenericAABB & other ) const;
inline GenericAABB getIntersection( const GenericAABB & other ) const; inline GenericAABB getIntersection( const GenericAABB & other ) const;
inline bool isIdentical( const GenericAABB & rhs ) const; inline bool isIdentical( const GenericAABB & other ) const;
inline bool isEqual( const GenericAABB & rhs ) const; inline bool isEqual( const GenericAABB & other ) const;
inline value_type sqDistance( const vector_type & point ) const; inline value_type sqDistance( const vector_type & point ) const;
inline value_type sqSignedDistance( const vector_type & point ) const; inline value_type sqSignedDistance( const vector_type & point ) const;
......
...@@ -230,8 +230,8 @@ GenericAABB< T >::GenericAABB( const value_type minX, const value_type minY, con ...@@ -230,8 +230,8 @@ GenericAABB< T >::GenericAABB( const value_type minX, const value_type minY, con
/** /**
* \brief Builds a GenericAABB from a min- and a maxCorner * \brief Builds a GenericAABB from a min- and a maxCorner
* *
* \param minCorner corner with minimal values * \param theMinCorner corner with minimal values
* \param maxCorner corner with maximal values * \param theMaxCorner corner with maximal values
* *
* \pre minCorner.x <= maxCorner.x && minCorner.y <= maxCorner.y && minCorner.z <= maxCorner.z * \pre minCorner.x <= maxCorner.x && minCorner.y <= maxCorner.y && minCorner.z <= maxCorner.z
*/ */
...@@ -751,8 +751,8 @@ GenericAABB< T > GenericAABB< T >::getScaled( const value_type factor ) const ...@@ -751,8 +751,8 @@ GenericAABB< T > GenericAABB< T >::getScaled( const value_type factor ) const
/** /**
* \brief Creates a new GenericAABB by scaling this one * \brief Creates a new GenericAABB by scaling this one
* *
* \param factor Vector of scaling factors by which the bounding box gets scaled on the * \param factors Vector of scaling factors by which the bounding box gets scaled on the
* respective axises. * respective axises.
* *
* \returns The scaled GenericAABB * \returns The scaled GenericAABB
*/ */
...@@ -1450,10 +1450,14 @@ void GenericAABB< T >::init( InputIterator first, InputIterator last ) ...@@ -1450,10 +1450,14 @@ void GenericAABB< T >::init( InputIterator first, InputIterator last )
/** /**
* \brief Reinitializes this GenericAABB from a min- and a maxCorner * \brief Reinitializes this GenericAABB from a min- and a maxCorner
* *
* \param minCorner corner with minimal values * \param minX x-coordinate of the minCorner
* \param maxCorner corner with maximal values * \param minY y-coordinate of the minCorner
* \param minZ z-coordinate of the minCorner
* \param maxX x-coordinate of the maxCorner
* \param maxY y-coordinate of the maxCorner
* \param maxZ z-coordinate of the maxCorner
* *
* \pre minCorner.x <= maxCorner.x && minCorner.y <= maxCorner.y && minCorner.z <= maxCorner.z * \pre minX <= maxX && minY <= maxY && minZ <= maxZ
*/ */
template< typename T > template< typename T >
void GenericAABB< T >::initMinMaxCorner( const value_type minX, const value_type minY, const value_type minZ, void GenericAABB< T >::initMinMaxCorner( const value_type minX, const value_type minY, const value_type minZ,
...@@ -1475,14 +1479,10 @@ void GenericAABB< T >::initMinMaxCorner( const value_type minX, const value_type ...@@ -1475,14 +1479,10 @@ void GenericAABB< T >::initMinMaxCorner( const value_type minX, const value_type
/** /**
* \brief Reinitializes this GenericAABB from a min- and a maxCorner * \brief Reinitializes this GenericAABB from a min- and a maxCorner
* *
* \param minX x-coordinate of the minCorner * \param theMinCorner corner with minimal values
* \param minY y-coordinate of the minCorner * \param theMaxCorner corner with maximal values
* \param minZ z-coordinate of the minCorner
* \param maxX x-coordinate of the maxCorner
* \param maxY y-coordinate of the maxCorner
* \param maxZ z-coordinate of the maxCorner
* *
* \pre x0 <= x1 && y0 <= y1 && z0 <= z1 * \pre theMinCorner.x <= theMaxCorner.x && theMinCorner.y <= theMaxCorner.y && theMinCorner.z <= theMaxCorner.z
*/ */
template< typename T > template< typename T >
void GenericAABB< T >::initMinMaxCorner( const vector_type & theMinCorner, const vector_type & theMaxCorner ) void GenericAABB< T >::initMinMaxCorner( const vector_type & theMinCorner, const vector_type & theMaxCorner )
...@@ -1498,7 +1498,7 @@ void GenericAABB< T >::initMinMaxCorner( const vector_type & theMinCorner, const ...@@ -1498,7 +1498,7 @@ void GenericAABB< T >::initMinMaxCorner( const vector_type & theMinCorner, const
* \brief Sets the minimum and maximum for one axis * \brief Sets the minimum and maximum for one axis
* *
* \param index 0 for x, 1 for y, 2 for z axis * \param index 0 for x, 1 for y, 2 for z axis
* \param value* the smaller of the two values is taken as minimum, the other as maximum * \param value1,value2 the smaller of the two values is taken as minimum, the other as maximum
*/ */
template< typename T > template< typename T >
void GenericAABB< T >::setAxisBounds( const uint_t index, const value_type value1, const value_type value2 ) void GenericAABB< T >::setAxisBounds( const uint_t index, const value_type value1, const value_type value2 )
...@@ -1567,7 +1567,7 @@ void GenericAABB< T >::extend( const vector_type & eps ) ...@@ -1567,7 +1567,7 @@ void GenericAABB< T >::extend( const vector_type & eps )
* *
* AABB gets translated such that its center matches the given center. * AABB gets translated such that its center matches the given center.
* *
* \param new center location * \param center new center location
*/ */
template< typename T > template< typename T >
void GenericAABB< T >::setCenter( const vector_type & center ) void GenericAABB< T >::setCenter( const vector_type & center )
...@@ -1616,8 +1616,8 @@ void GenericAABB< T >::scale( const value_type factor ) ...@@ -1616,8 +1616,8 @@ void GenericAABB< T >::scale( const value_type factor )
/** /**
* \brief Scales this GenericAABB * \brief Scales this GenericAABB
* *
* \param factor Vector of scaling factors by which the bounding box gets scaled on the * \param factors Vector of scaling factors by which the bounding box gets scaled on the
* respective axises. * respective axises.
*/ */
template< typename T > template< typename T >
void GenericAABB< T >::scale( const vector_type & factors ) void GenericAABB< T >::scale( const vector_type & factors )
......
...@@ -115,7 +115,7 @@ real_t Sample::median() const ...@@ -115,7 +115,7 @@ real_t Sample::median() const
* The variance calculated here is the _uncorrected_ variance. * The variance calculated here is the _uncorrected_ variance.
* See: http://en.wikipedia.org/w/index.php?title=Bessel%27s_correction&oldid=526066331 * See: http://en.wikipedia.org/w/index.php?title=Bessel%27s_correction&oldid=526066331
* *
* \param mean the mean() * \param theMean the mean()
* *
* \returns The uncorrected variance. * \returns The uncorrected variance.
**********************************************************************************************************************/ **********************************************************************************************************************/
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
// You should have received a copy of the GNU General Public License along // You should have received a copy of the GNU General Public License along
// with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>. // with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
// //
//! \file GenericBufferSystem.cpp //! \file BufferSystem.impl.h
//! \ingroup core //! \ingroup core
//! \author Martin Bauer <martin.bauer@fau.de> //! \author Martin Bauer <martin.bauer@fau.de>
// //
......
...@@ -83,7 +83,7 @@ namespace internal { ...@@ -83,7 +83,7 @@ namespace internal {
/*************************************************************************************************************//** /*************************************************************************************************************//**
* Waits for the next receive to complete and returns. * Waits for the next receive to complete and returns.
* *
* \param recvInfo the same receive info that was passed to scheduleReceives() * \param recvInfos the same receive info that was passed to scheduleReceives()
* *
* \return The rank where the data was received -> recvInfos[rank] is now valid * \return The rank where the data was received -> recvInfos[rank] is now valid
* INVALID_RANK if all messages were received. * INVALID_RANK if all messages were received.
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
// You should have received a copy of the GNU General Public License along // You should have received a copy of the GNU General Public License along
// with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>. // with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
// //
//! \file BufferSystemHelper.cpp //! \file BufferSystemHelper.impl.h
//! \ingroup core //! \ingroup core
//! \author Martin Bauer <martin.bauer@fau.de> //! \author Martin Bauer <martin.bauer@fau.de>
// //
......
...@@ -198,11 +198,11 @@ std::vector< std::string > allGatherv( const std::vector< std::string > & values ...@@ -198,11 +198,11 @@ std::vector< std::string > allGatherv( const std::vector< std::string > & values
* - the buffer contents are gathered on process with targetRank * - the buffer contents are gathered on process with targetRank
* - buffer contents are sorted by rank and stored consecutively in a mpi::RecvBuffer * - buffer contents are sorted by rank and stored consecutively in a mpi::RecvBuffer
* *
* \param sendBuffer [in] sendBuffer with (possibly) different size on each process * \param[in] sendBuffer sendBuffer with (possibly) different size on each process
* \param recvBuffer [out] recvBuffer which is left unchanged on all processes but targetRank * \param[out] recvBuffer recvBuffer which is left unchanged on all processes but targetRank
* on targetRank recvBuffer holds the gathered result * on targetRank recvBuffer holds the gathered result
* \param targetRank [in] rank of the process where data is gathered * \param[in] targetRank rank of the process where data is gathered
* \param comm [in] mpi communicator to use * \param[in] comm mpi communicator to use
*/ */
//******************************************************************************************************************* //*******************************************************************************************************************
void gathervBuffer( const mpi::SendBuffer & sendBuffer, mpi::RecvBuffer & recvBuffer, int targetRank = 0, MPI_Comm comm = MPI_COMM_WORLD ); void gathervBuffer( const mpi::SendBuffer & sendBuffer, mpi::RecvBuffer & recvBuffer, int targetRank = 0, MPI_Comm comm = MPI_COMM_WORLD );
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
// You should have received a copy of the GNU General Public License along // You should have received a copy of the GNU General Public License along
// with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>. // with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
// //
//! \file MPIIO.cppp //! \file MPIIO.cpp
//! \ingroup core //! \ingroup core
//! \author Florian Schornbaum <florian.schornbaum@fau.de> //! \author Florian Schornbaum <florian.schornbaum@fau.de>
//! \author Martin Bauer <martin.bauer@fau.de> //! \author Martin Bauer <martin.bauer@fau.de>
......
...@@ -40,6 +40,7 @@ namespace mpi ...@@ -40,6 +40,7 @@ namespace mpi
* *
* \param filename The name of the file to be written * \param filename The name of the file to be written
* \param processLocalPart The part of the file belonging to the calling process (size may differ among processes) * \param processLocalPart The part of the file belonging to the calling process (size may differ among processes)
* \param comm The MPI communicator used for communication
*/ */
//====================================================================================================================== //======================================================================================================================
void writeMPITextFile(const std::string& filename, const std::string& processLocalPart, void writeMPITextFile(const std::string& filename, const std::string& processLocalPart,
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
// You should have received a copy of the GNU General Public License along // You should have received a copy of the GNU General Public License along
// with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>. // with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
// //
//! \file OpenMPBufferSystem.cpp //! \file OpenMPBufferSystem.impl.h
//! \ingroup core //! \ingroup core
//! \author Martin Bauer <martin.bauer@fau.de> //! \author Martin Bauer <martin.bauer@fau.de>
// //
......
...@@ -434,10 +434,10 @@ void allReduceInplace( std::vector<T> & values, Operation operation, MPI_Comm co ...@@ -434,10 +434,10 @@ void allReduceInplace( std::vector<T> & values, Operation operation, MPI_Comm co
//====================================================================================================================== //======================================================================================================================
/*! /*!
* \brief Reduces values in a std::vector<bool> over all processes in-place * \brief Reduces values in a std::vector<bool> over all processes in-place
* *
* Specialization of allReduceInplace<T> * Specialization of allReduceInplace<T>
* *
* \param values The boolean values to be reduced * \param bools The boolean values to be reduced
* \param operation The operation to be performed (one of BITWISE_AND, BITWISE_OR or BITWISE_XOR) * \param operation The operation to be performed (one of BITWISE_AND, BITWISE_OR or BITWISE_XOR)
* \param comm The MPI communicator used for communication * \param comm The MPI communicator used for communication
*/ */
......
...@@ -37,7 +37,7 @@ namespace selectable { ...@@ -37,7 +37,7 @@ namespace selectable {
* \brief Implementation of SelectableObject using sets (see "AllSet.h") as selection attributes * \brief Implementation of SelectableObject using sets (see "AllSet.h") as selection attributes
* *
* AllSetSelectableObject is an implementation of SelectableObject that stores objects of type T which are attached * AllSetSelectableObject is an implementation of SelectableObject that stores objects of type T which are attached
* with selection attributes of type AllSet<U>. For information on which objects are selected given a certain set as * with selection attributes of type `AllSet<U>`. For information on which objects are selected given a certain set as
* selection request see the documentation of the function "select". * selection request see the documentation of the function "select".
*/ */
//********************************************************************************************************************** //**********************************************************************************************************************
......
...@@ -38,8 +38,8 @@ namespace selectable { ...@@ -38,8 +38,8 @@ namespace selectable {
* selection attributes, and objects of type Set (see "Set.h") as selector * selection attributes, and objects of type Set (see "Set.h") as selector
* *
* SetSelectableObject is an implementation of SelectableObject that stores objects of type T which are attached with * SetSelectableObject is an implementation of SelectableObject that stores objects of type T which are attached with
* selection attributes of type SetSelectionPair<U>. Every object of type SetSelectionPair<U> contains two sets of * selection attributes of type `SetSelectionPair<U>`. Every object of type `SetSelectionPair<U>` contains two sets of
* type Set<U> - one "include" and one "exclude" set. For information on which objects are selected given a certain * type `Set<U>` - one "include" and one "exclude" set. For information on which objects are selected given a certain
* selection request see the documentation of the function "select". * selection request see the documentation of the function "select".
*/ */
//********************************************************************************************************************** //**********************************************************************************************************************
......
...@@ -204,11 +204,11 @@ inline Timer<TP>::Timer() ...@@ -204,11 +204,11 @@ inline Timer<TP>::Timer()
//********************************************************************************************************************** //**********************************************************************************************************************
/*!\brief Constructor of the Timer class. /*!\brief Constructor of the Timer class.
// Initializes the timer with // Initializes the timer with
// \param counter number of timing measurements already done // \param _counter number of timing measurements already done
// \param min the minimum time of the measurements // \param _min the minimum time of the measurements
// \param max the maximum time of the measurements // \param _max the maximum time of the measurements
// \param total the total time of all measurements // \param _total the total time of all measurements
// \param sumOfSquares each measurement time squared, then summed // \param _sumOfSquares each measurement time squared, then summed
*/ */
template< typename TP> template< typename TP>
inline Timer<TP>::Timer( uint_t _counter, double _min, double _max, inline Timer<TP>::Timer( uint_t _counter, double _min, double _max,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment