diff --git a/dune/istl/bcrsmatrix.hh b/dune/istl/bcrsmatrix.hh index c7943726c3177d228440e649d527fa2aff32caf6..a69c916c1ab94599527693ea0b1c360263bc92be 100644 --- a/dune/istl/bcrsmatrix.hh +++ b/dune/istl/bcrsmatrix.hh @@ -775,6 +775,7 @@ namespace Dune { * @param _avg expected average number of entries per row * @param compressionBufferSize fraction of _n*_avg which is expected to be * needed for elements that exceed _avg entries per row. + * \param bm Matrix build mode * */ BCRSMatrix (size_type _n, size_type _m, size_type _avg, double compressionBufferSize, BuildMode bm) @@ -2199,12 +2200,13 @@ namespace Dune { * setup matrix) results in all the structure and data being lost. Please * call deallocate() before calling allocate in this case. * - * @param row The number of rows the matrix should contain. + * @param rows The number of rows the matrix should contain. * @param columns the number of columns the matrix should contain. * @param allocationSize The number of nonzero entries the matrix should hold (if omitted * defaults to 0). - * @param allocateRow Whether we have to allocate the row pointers, too. (Defaults to + * @param allocateRows Whether we have to allocate the row pointers, too. (Defaults to * true) + * \param allocate_data Whether data array needs to be allocated */ void allocate(size_type rows, size_type columns, size_type allocationSize, bool allocateRows, bool allocate_data) { diff --git a/dune/istl/matrix.hh b/dune/istl/matrix.hh index 1d479d5f0d632284942040b181cda553047d8ca2..75d859afa52e765d7c9d2dadbff28e775e795af4 100644 --- a/dune/istl/matrix.hh +++ b/dune/istl/matrix.hh @@ -89,8 +89,8 @@ namespace MatrixImp /** make vector with given number of blocks each having a constant size, object is fully usable then. - \param _nblocks Number of blocks - \param m Number of elements in each block + * \param rows Number of rows + * \param columns Number of columns */ DenseMatrixBase (size_type rows, size_type columns) : Imp::block_vector_unmanaged<B,A>() { diff --git a/dune/istl/matrixmarket.hh b/dune/istl/matrixmarket.hh index e07e26e8244e851ee05b3a5c9aa166f93f1938ab..5c2d7825515880fd4841e8c74c1364bfab6cadea 100644 --- a/dune/istl/matrixmarket.hh +++ b/dune/istl/matrixmarket.hh @@ -677,7 +677,7 @@ namespace Dune { /** * @brief Sets the matrix values. - * @param row The row data as read from file. + * @param rows The row data as read from file. * @param matrix The matrix whose data we set. */ template<typename T> @@ -695,7 +695,7 @@ namespace Dune /** * @brief Sets the matrix values. - * @param row The row data as read from file. + * @param rows The row data as read from file. * @param matrix The matrix whose data we set. */ template<typename T> diff --git a/dune/istl/novlpschwarz.hh b/dune/istl/novlpschwarz.hh index a0c74f8afc7dd03575f1994909c1c344a10ad999..bf2f2ce2d235e99f7ec3fd11c7b0bdd6d5e8fa4c 100644 --- a/dune/istl/novlpschwarz.hh +++ b/dune/istl/novlpschwarz.hh @@ -285,13 +285,6 @@ namespace Dune { //! \brief The type of the communication object. typedef C communication_type; - /*! \brief Constructor. - - constructor gets all parameters to operate the prec. - \param prec The sequential preconditioner. - \param c The communication object for syncing owner and copy - data points. (E.~g. OwnerOverlapCommunication ) - */ /*! \brief Constructor. constructor gets all parameters to operate the prec. diff --git a/dune/istl/paamg/parameters.hh b/dune/istl/paamg/parameters.hh index 8552904c10c1e4ae2ba2a85e074d79107d89e3c5..77886ffe4bb9c7e0418bf51b0d201669e8b5374b 100644 --- a/dune/istl/paamg/parameters.hh +++ b/dune/istl/paamg/parameters.hh @@ -183,7 +183,6 @@ namespace Dune * @brief Set the minimum number of nodes a aggregate has to consist of. * * the default value is 4. - * @return The minimum number of nodes. */ void setMinAggregateSize(std::size_t size){ minAggregateSize_=size;} diff --git a/dune/istl/paamg/twolevelmethod.hh b/dune/istl/paamg/twolevelmethod.hh index a5b518ea73359a543d8fb0f0ca5f3a9358a296fd..dc31fa3443ae2e080d8448765dbc300e7c4d007a 100644 --- a/dune/istl/paamg/twolevelmethod.hh +++ b/dune/istl/paamg/twolevelmethod.hh @@ -92,10 +92,10 @@ public: * @brief Transfers the data to the coarse level. * * Restricts the residual to the right hand side of the - * coarse level system and initialies the left hand side + * coarse level system and initializes the left hand side * of the coarse level system. These can afterwards be accessed - * usinf getCoarseLevelRhs() and getCoarseLevelLhs(). - * @param fineDefect The current residual of the fine level system. + * using getCoarseLevelRhs() and getCoarseLevelLhs(). + * @param fineRhs The current right hand side of the fine level system. */ virtual void moveToCoarseLevel(const FineRangeType& fineRhs)=0; /** @@ -398,7 +398,7 @@ public: * @param coarsePolicy The policy for constructing the coarse level solver. * @param preSteps The number of smoothing steps to apply before the coarse * level correction. - * @param preSteps The number of smoothing steps to apply after the coarse + * @param postSteps The number of smoothing steps to apply after the coarse * level correction. */ TwoLevelMethod(const FineOperatorType& op, diff --git a/dune/istl/preconditioners.hh b/dune/istl/preconditioners.hh index 5620fd1102ebba8ed62c4faa92284c8e7e57b8bf..77a6d57546bc6235c7c40cdaff81a82644a87f74 100644 --- a/dune/istl/preconditioners.hh +++ b/dune/istl/preconditioners.hh @@ -618,7 +618,7 @@ namespace Dune { \brief Constructor. \param A The matrix to operate on. - \param configuration ParameterTree containing preconditioner parameters. + \param config ParameterTree containing preconditioner parameters. ParameterTree Key | Meaning ------------------|------------ @@ -750,7 +750,7 @@ namespace Dune { \brief Constructor. \param A The matrix to operate on. - \param configuration ParameterTree containing preconditioner parameters. + \param config ParameterTree containing preconditioner parameters. ParameterTree Key | Meaning ------------------|------------ @@ -1007,7 +1007,7 @@ namespace Dune { \brief Constructor. \param A The matrix to operate on. - \param configuration ParameterTree containing preconditioner parameters. + \param config ParameterTree containing preconditioner parameters. ParameterTree Key | Meaning ------------------|------------ diff --git a/dune/istl/spqr.hh b/dune/istl/spqr.hh index d0151ad647e5e1b90e3fb38d23d869bd12351975..daaf0ba42c36e7df20cef412df30e9b5bc7455af 100644 --- a/dune/istl/spqr.hh +++ b/dune/istl/spqr.hh @@ -90,7 +90,7 @@ namespace Dune { * (and use a lot of memory). * * @param matrix the matrix to solve for - * @param verbose, 0 or 1, set the verbosity level, defaults to 0 + * @param verbose 0 or 1, set the verbosity level, defaults to 0 */ SPQR(const Matrix& matrix, int verbose=0) : matrixIsLoaded_(false), verbose_(verbose) { @@ -108,7 +108,7 @@ namespace Dune { * (and use a lot of memory). * * @param matrix the matrix to solve for - * @param verbose, 0 or 1, set the verbosity level, defaults to 0 + * @param verbose 0 or 1, set the verbosity level, defaults to 0 */ SPQR(const Matrix& matrix, int verbose, bool) : matrixIsLoaded_(false), verbose_(verbose) { diff --git a/dune/istl/superlu.hh b/dune/istl/superlu.hh index f8035e119dc87cb34e738c6aa48a24dd8bf0fd78..498fcd45163c638ff1547b43bbe717ff94692f47 100644 --- a/dune/istl/superlu.hh +++ b/dune/istl/superlu.hh @@ -309,7 +309,7 @@ namespace Dune /** @brief Constructs the SuperLU solver. * - * @param matrix The matrix of the system to solve. + * @param mat The matrix of the system to solve. * @param config ParameterTree containing solver parameters. * * ParameterTree Key | Meaning diff --git a/dune/istl/umfpack.hh b/dune/istl/umfpack.hh index 63fa05dcd353da99f39b8a46c61a479840e2b647..47e901c9f7599ca92b8aa7cd1521e08fd0613890 100644 --- a/dune/istl/umfpack.hh +++ b/dune/istl/umfpack.hh @@ -305,7 +305,7 @@ namespace Dune { /** @brief Construct a solver object from a matrix * - * @param matrix the matrix to solve for + * @param mat_ the matrix to solve for * @param config ParameterTree containing solver parameters. * * ParameterTree Key | Meaning