Skip to content
Snippets Groups Projects
Commit a4a06b80 authored by Christian Engwer's avatar Christian Engwer
Browse files

small doxygen fixes

[[Imported from SVN: r773]]
parent c9dbdf01
No related branches found
No related tags found
No related merge requests found
......@@ -53,7 +53,8 @@ namespace Dune {
int rowsize(int row) const {return indices_[row].size();}
/** \brief Import all nonzero entries of a sparse matrix into the index set
* \tparam MatrixType Needs to be BCRSMatrix<...>
\param MatrixType Needs to be BCRSMatrix<...>
\param matrix reference to the MatrixType object
*/
template <class MatrixType>
void import(const MatrixType& m, int rowOffset=0, int colOffset=0) {
......@@ -77,7 +78,8 @@ namespace Dune {
/** \brief Initializes a BCRSMatrix with the indices contained
in this MatrixIndexSet
\tparam MatrixType Needs to be BCRSMatrix<...>
\param MatrixType Needs to be BCRSMatrix<...>
\param matrix reference to the MatrixType object
*/
template <class MatrixType>
void exportIdx(MatrixType& matrix) const {
......
......@@ -350,8 +350,10 @@ namespace Dune
* @brief Criterion taking advantage of symmetric matrices.
*
* The two template parameters are:
* <dl>
* <dt>M</dt> <dd>The type of the matrix the amg coarsening works on, e. g. BCRSMatrix</dd>
* <dt>Norm</dt> <dd>The norm to use to determine the strong couplings between the nodes, e.g. FirstDiagonal or RowSum.</dd>
* </dl>
*/
template<class M, class Norm>
class SymmetricCriterion : public AggregationCriterion<SymmetricDependency<M,Norm> >
......@@ -364,8 +366,10 @@ namespace Dune
* Nevertheless the sparsity pattern has to be symmetric.
*
* The two template parameters are:
* <dl>
* <dt>M</dt> <dd>The type of the matrix the amg coarsening works on, e. g. BCRSMatrix</dd>
* <dt>Norm</dt> <dd>The norm to use to determine the strong couplings between the nodes, e.g. FirstDiagonal or RowSum.</dd>
* </dl>
*/
template<class M, class Norm>
class UnSymmetricCriterion : public AggregationCriterion<Dependency<M,Norm> >
......@@ -460,12 +464,11 @@ namespace Dune
* @brief Breadth first search within an aggregate
*
* The template parameters: <br>
* <dl>
* <dt>reset</dt><dd>If true the visited flags of the vertices
* <dl><dt>reset</dt><dd>If true the visited flags of the vertices
* will be reset after
* the search</dd>
* <dt>G</dt><dd>The type of the graph we perform the search on.</dd>
* <td>F</dt><dd>The type of the visitor to operate on the vertices</dd>
* <dt>F</dt><dd>The type of the visitor to operate on the vertices</dd>
* </dl>
* @param start The vertex where the search should start
* from. This does not need to belong to the aggregate.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment