From 9dc1da1cb278d27a1b7b9e4c882bf9860bb39050 Mon Sep 17 00:00:00 2001 From: Guido Kanschat Date: Sun, 13 Jul 2003 09:15:22 +0000 Subject: [PATCH] additional comments for Doxygen git-svn-id: https://svn.dealii.org/trunk@7877 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/lac/include/lac/block_matrix.h | 6 +++++- deal.II/lac/include/lac/block_matrix_array.h | 12 +++++++++++- deal.II/lac/include/lac/block_sparse_matrix.h | 6 +++++- deal.II/lac/include/lac/block_sparse_matrix_ez.h | 7 ++++++- deal.II/lac/include/lac/block_sparsity_pattern.h | 6 +++++- deal.II/lac/include/lac/block_vector.h | 6 +++++- .../lac/include/lac/compressed_sparsity_pattern.h | 6 +++++- deal.II/lac/include/lac/eigen.h | 7 ++++++- deal.II/lac/include/lac/filtered_matrix.h | 6 +++++- deal.II/lac/include/lac/full_matrix.h | 6 +++++- deal.II/lac/include/lac/matrix_lib.h | 7 ++++++- deal.II/lac/include/lac/matrix_out.h | 6 +++++- deal.II/lac/include/lac/pointer_matrix.h | 6 +++++- deal.II/lac/include/lac/precondition.h | 6 +++++- deal.II/lac/include/lac/precondition_block.h | 5 +++++ deal.II/lac/include/lac/precondition_selector.h | 6 +++++- deal.II/lac/include/lac/schur_matrix.h | 7 +++++++ deal.II/lac/include/lac/shifted_matrix.h | 6 +++++- deal.II/lac/include/lac/solver.h | 11 ++++++----- deal.II/lac/include/lac/solver_bicgstab.h | 6 ++++++ deal.II/lac/include/lac/solver_cg.h | 5 ++++- deal.II/lac/include/lac/solver_control.h | 6 +++++- deal.II/lac/include/lac/solver_gmres.h | 7 +++++-- deal.II/lac/include/lac/solver_minres.h | 5 ++++- deal.II/lac/include/lac/solver_qmrs.h | 5 ++++- deal.II/lac/include/lac/solver_richardson.h | 6 +++++- deal.II/lac/include/lac/solver_selector.h | 6 +++++- deal.II/lac/include/lac/sparse_decomposition.h | 9 +++++++-- deal.II/lac/include/lac/sparse_direct.h | 6 +++++- deal.II/lac/include/lac/sparse_ilu.h | 9 +++++++-- deal.II/lac/include/lac/sparse_matrix.h | 6 +++++- deal.II/lac/include/lac/sparse_matrix_ez.h | 6 +++++- deal.II/lac/include/lac/sparse_mic.h | 8 ++++++-- deal.II/lac/include/lac/sparse_vanka.h | 6 +++++- deal.II/lac/include/lac/sparsity_pattern.h | 5 +++++ deal.II/lac/include/lac/swappable_vector.h | 6 +++++- deal.II/lac/include/lac/vector.h | 6 +++++- deal.II/lac/include/lac/vector_memory.h | 6 +++++- 38 files changed, 205 insertions(+), 42 deletions(-) diff --git a/deal.II/lac/include/lac/block_matrix.h b/deal.II/lac/include/lac/block_matrix.h index 9bd5bcecc6..47c43cda79 100644 --- a/deal.II/lac/include/lac/block_matrix.h +++ b/deal.II/lac/include/lac/block_matrix.h @@ -19,6 +19,10 @@ #include #include +/*! @addtogroup Matrix2 + *@{ + */ + /** * A matrix with several copies of the same block on the diagonal. * @@ -69,7 +73,7 @@ class BlockDiagonalMatrix : public Subscriptor SmartPointer matrix; }; - +/*@}*/ //----------------------------------------------------------------------// template diff --git a/deal.II/lac/include/lac/block_matrix_array.h b/deal.II/lac/include/lac/block_matrix_array.h index c51fc9ef07..2383ee10b0 100644 --- a/deal.II/lac/include/lac/block_matrix_array.h +++ b/deal.II/lac/include/lac/block_matrix_array.h @@ -33,6 +33,10 @@ template class BlockVector; template class Vector; +/*! @addtogroup Matrix2 + *@{ + */ + /** * Block matrix composed of different single matrices. @@ -203,6 +207,12 @@ class BlockMatrixArray : public Subscriptor unsigned int block_cols; }; +/*@}*/ + +/*! @addtogroup Preconditioners + *@{ + */ + /** * Inversion of a block-triangular matrix. @@ -318,7 +328,7 @@ class BlockTrianglePrecondition : private BlockMatrixArray bool backward; }; - +/*@}*/ //----------------------------------------------------------------------// template diff --git a/deal.II/lac/include/lac/block_sparse_matrix.h b/deal.II/lac/include/lac/block_sparse_matrix.h index d68db16ec2..af705f8eae 100644 --- a/deal.II/lac/include/lac/block_sparse_matrix.h +++ b/deal.II/lac/include/lac/block_sparse_matrix.h @@ -23,6 +23,10 @@ template class BlockVector; +/*! @addtogroup Matrix1 + *@{ + */ + /** * Blocked sparse matrix. The behaviour of objects of this type is * almost as for the @p{SparseMatrix<...>} objects, with most of the @@ -739,7 +743,7 @@ class BlockSparseMatrix : public Subscriptor - +/*@}*/ /* ------------------------- Template functions ---------------------- */ template diff --git a/deal.II/lac/include/lac/block_sparse_matrix_ez.h b/deal.II/lac/include/lac/block_sparse_matrix_ez.h index 2cff410b17..d2e72be057 100644 --- a/deal.II/lac/include/lac/block_sparse_matrix_ez.h +++ b/deal.II/lac/include/lac/block_sparse_matrix_ez.h @@ -24,6 +24,11 @@ template class BlockVector; +/*! @addtogroup Matrix1 + *@{ + */ + + /** * A block matrix consisting of blocks of type @p{SparseMatrixEZ}. * @@ -292,7 +297,7 @@ class BlockSparseMatrixEZ : public Subscriptor Table<2, SparseMatrixEZ > blocks; }; - +/*@}*/ /*----------------------------------------------------------------------*/ diff --git a/deal.II/lac/include/lac/block_sparsity_pattern.h b/deal.II/lac/include/lac/block_sparsity_pattern.h index 527de59e91..a0a1be0856 100644 --- a/deal.II/lac/include/lac/block_sparsity_pattern.h +++ b/deal.II/lac/include/lac/block_sparsity_pattern.h @@ -28,6 +28,10 @@ template class BlockSparseMatrix; class BlockSparsityPattern; class CompressedBlockSparsityPattern; +/*! @addtogroup Matrix1 + *@{ + */ + /** * This is the base class for block versions of the sparsity pattern @@ -496,7 +500,7 @@ class CompressedBlockSparsityPattern : public BlockSparsityPatternBase class BlockVector; +/*! @addtogroup LAC + *@{ + */ + namespace internal { @@ -1238,7 +1242,7 @@ class BlockVector template friend class BlockVector; }; - +/*@}*/ /*----------------------- Inline functions ----------------------------------*/ diff --git a/deal.II/lac/include/lac/compressed_sparsity_pattern.h b/deal.II/lac/include/lac/compressed_sparsity_pattern.h index e83e986bbb..83ee124b19 100644 --- a/deal.II/lac/include/lac/compressed_sparsity_pattern.h +++ b/deal.II/lac/include/lac/compressed_sparsity_pattern.h @@ -23,6 +23,10 @@ template class SparseMatrix; #include #include +/*! @addtogroup Matrix1 + *@{ + */ + /** * This class acts as an intermediate form of the @@ -352,7 +356,7 @@ class CompressedSparsityPattern : public Subscriptor friend class SparsityPattern; }; - +/*@}*/ /*---------------------- Inline functions -----------------------------------*/ diff --git a/deal.II/lac/include/lac/eigen.h b/deal.II/lac/include/lac/eigen.h index cb979f41ec..49cc34c962 100644 --- a/deal.II/lac/include/lac/eigen.h +++ b/deal.II/lac/include/lac/eigen.h @@ -26,6 +26,10 @@ #include +/*!@addtogroup Solvers */ +/*@{*/ + +//! Power method for eigenvalues. /** * Power method (von Mises). * @@ -105,7 +109,7 @@ class EigenPower : private Solver AdditionalData additional_data; }; - +//! Inverse iteration for eigenvalues. /** * Inverse iteration (Wieland). * @@ -209,6 +213,7 @@ class EigenInverse : private Solver AdditionalData additional_data; }; +/*@}*/ //---------------------------------------------------------------------- diff --git a/deal.II/lac/include/lac/filtered_matrix.h b/deal.II/lac/include/lac/filtered_matrix.h index d14f9f8e3f..548a87d74f 100644 --- a/deal.II/lac/include/lac/filtered_matrix.h +++ b/deal.II/lac/include/lac/filtered_matrix.h @@ -25,6 +25,10 @@ template class Vector; +/*! @addtogroup Matrix2 + *@{ + */ + /** * This class is a wrapper for linear systems of equations with simple @@ -567,7 +571,7 @@ class FilteredMatrix : public Subscriptor const bool matrix_is_symmetric) const; }; - +/*@}*/ /*---------------------- Inline functions -----------------------------------*/ diff --git a/deal.II/lac/include/lac/full_matrix.h b/deal.II/lac/include/lac/full_matrix.h index 1c854d37e1..ad2f93748b 100644 --- a/deal.II/lac/include/lac/full_matrix.h +++ b/deal.II/lac/include/lac/full_matrix.h @@ -26,6 +26,10 @@ template class Vector; +/*! @addtogroup Matrix1 + *@{ + */ + /** * Rectangular/quadratic full matrix. @@ -746,7 +750,7 @@ class FullMatrix : public Table<2,number> << " matrix dimension " << arg1); }; - +/*@}*/ /*-------------------------Inline functions -------------------------------*/ diff --git a/deal.II/lac/include/lac/matrix_lib.h b/deal.II/lac/include/lac/matrix_lib.h index 4aa5d48c10..04d48823c0 100644 --- a/deal.II/lac/include/lac/matrix_lib.h +++ b/deal.II/lac/include/lac/matrix_lib.h @@ -10,6 +10,11 @@ template class Vector; template class BlockVector; +/*! @addtogroup Matrix2 + *@{ + */ + + /** * Poor man's matrix product. Stores two matrices $m_1$ and $m_2$ and * implements matrix-vector multiplications for the product $m_1 m_2$ @@ -152,7 +157,7 @@ class MeanValueFilter : public Subscriptor unsigned int component; }; - +/*@}*/ //----------------------------------------------------------------------// template diff --git a/deal.II/lac/include/lac/matrix_out.h b/deal.II/lac/include/lac/matrix_out.h index c6e686b29c..3f10ce5ee1 100644 --- a/deal.II/lac/include/lac/matrix_out.h +++ b/deal.II/lac/include/lac/matrix_out.h @@ -18,6 +18,10 @@ #include #include +/*! @addtogroup LAC + *@{ + */ + /** * Output a matrix in graphical form using the generic format @@ -301,7 +305,7 @@ class MatrixOut : public DataOutInterface<2,2> }; - +/*@}*/ /* ---------------------- Template and inline functions ------------- */ diff --git a/deal.II/lac/include/lac/pointer_matrix.h b/deal.II/lac/include/lac/pointer_matrix.h index e659c9082c..04a46ef6a0 100644 --- a/deal.II/lac/include/lac/pointer_matrix.h +++ b/deal.II/lac/include/lac/pointer_matrix.h @@ -7,6 +7,10 @@ #include #include +/*! @addtogroup Matrix2 + *@{ + */ + /** * Abstract class for use in iterations. This class provides the * interface required by LAC solver classes. It allows to use @@ -142,7 +146,7 @@ private: SmartPointer m; }; - +/*@}*/ //----------------------------------------------------------------------// template diff --git a/deal.II/lac/include/lac/precondition.h b/deal.II/lac/include/lac/precondition.h index 7259f27fce..23b5170065 100644 --- a/deal.II/lac/include/lac/precondition.h +++ b/deal.II/lac/include/lac/precondition.h @@ -22,6 +22,10 @@ template class Vector; template class SparseMatrix; +/*! @addtogroup Preconditioners + *@{ + */ + /** * No preconditioning. This class helps you, if you want to use a @@ -597,7 +601,7 @@ class PreconditionedMatrix : public Subscriptor - +/*@}*/ /* ---------------------------------- Inline functions ------------------- */ template diff --git a/deal.II/lac/include/lac/precondition_block.h b/deal.II/lac/include/lac/precondition_block.h index 7653360443..86fd63a540 100644 --- a/deal.II/lac/include/lac/precondition_block.h +++ b/deal.II/lac/include/lac/precondition_block.h @@ -24,6 +24,10 @@ template class FullMatrix; template class Vector; +/*! @addtogroup Preconditioners + *@{ + */ + /** * Base class for @p{PreconditionBlockJacobi}, @@ -691,6 +695,7 @@ class PreconditionBlockSSOR : public virtual Subscriptor, void Tvmult (Vector&, const Vector&) const; }; +/*@}*/ //----------------------------------------------------------------------// template diff --git a/deal.II/lac/include/lac/precondition_selector.h b/deal.II/lac/include/lac/precondition_selector.h index 3e301092c7..ad675d6fd5 100644 --- a/deal.II/lac/include/lac/precondition_selector.h +++ b/deal.II/lac/include/lac/precondition_selector.h @@ -22,6 +22,10 @@ template class Vector; template class SparseMatrix; +/*! @addtogroup Preconditioners + *@{ + */ + /** * Selects the preconditioner. The constructor of this class takes * the name of the preconditioning and the damping parameter @@ -152,7 +156,7 @@ class PreconditionSelector : public Subscriptor const typename Vector::value_type omega; }; - +/*@}*/ /* --------------------- Inline and template functions ------------------- */ diff --git a/deal.II/lac/include/lac/schur_matrix.h b/deal.II/lac/include/lac/schur_matrix.h index eca0d80043..06c066690a 100644 --- a/deal.II/lac/include/lac/schur_matrix.h +++ b/deal.II/lac/include/lac/schur_matrix.h @@ -23,6 +23,10 @@ +/*! @addtogroup Matrix2 + *@{ + */ + /** * Schur complement of a block matrix. * @@ -208,6 +212,9 @@ class SchurMatrix : unsigned int debug; }; +/*@}*/ +//----------------------------------------------------------------------// + template SchurMatrix ::SchurMatrix(const MA_inverse& Ainv, diff --git a/deal.II/lac/include/lac/shifted_matrix.h b/deal.II/lac/include/lac/shifted_matrix.h index 4f045ac487..16535b8422 100644 --- a/deal.II/lac/include/lac/shifted_matrix.h +++ b/deal.II/lac/include/lac/shifted_matrix.h @@ -17,6 +17,10 @@ #include #include +/*! @addtogroup Matrix2 + *@{ + */ + /** * Matrix with shifted diagonal values. * @@ -138,7 +142,7 @@ class ShiftedMatrixGeneralized }; - +/*@}*/ //----------------------------------------------------------------------// template diff --git a/deal.II/lac/include/lac/solver.h b/deal.II/lac/include/lac/solver.h index 9a1782175c..71fdba9b18 100644 --- a/deal.II/lac/include/lac/solver.h +++ b/deal.II/lac/include/lac/solver.h @@ -20,12 +20,13 @@ template class Vector; template class VectorMemory; class SolverControl; +/*!@addtogroup Solvers */ +/*@{*/ +//! Base class for iterative solvers. /** - * Base class for iterative solvers. This class defines possible - * return states of linear solvers and provides interfaces to a memory - * pool and the control object. - * + * This class defines possible return states of linear solvers and + * provides interfaces to a memory pool and the control object. * * @sect3{Requirements for template classes} * @@ -174,7 +175,7 @@ class Solver : public Subscriptor VectorMemory &memory; }; - +/*@}*/ /*-------------------------------- Inline functions ------------------------*/ template diff --git a/deal.II/lac/include/lac/solver_bicgstab.h b/deal.II/lac/include/lac/solver_bicgstab.h index 9a646c07a3..c117b202ec 100644 --- a/deal.II/lac/include/lac/solver_bicgstab.h +++ b/deal.II/lac/include/lac/solver_bicgstab.h @@ -20,6 +20,11 @@ #include #include #include + +/*!@addtogroup Solvers */ +/*@{*/ + +//! Iterative solver Bicg-stab. /** * Bicgstab algorithm by van der Vorst. * @@ -226,6 +231,7 @@ class SolverBicgstab : public Solver }; +/*@}*/ /*-------------------------Inline functions -------------------------------*/ template diff --git a/deal.II/lac/include/lac/solver_cg.h b/deal.II/lac/include/lac/solver_cg.h index 9590545a12..0ebee15b0f 100644 --- a/deal.II/lac/include/lac/solver_cg.h +++ b/deal.II/lac/include/lac/solver_cg.h @@ -22,7 +22,10 @@ #include #include +/*!@addtogroup Solvers */ +/*@{*/ +//! Conjugate gradient method for symmetric positive definite matrices. /** * Preconditioned cg method. * @@ -166,6 +169,7 @@ class SolverCG : public Solver AdditionalData additional_data; }; +/*@}*/ /*------------------------- Implementation ----------------------------*/ @@ -318,5 +322,4 @@ SolverCG::solve (const MATRIX &A, // otherwise exit as normal } - #endif diff --git a/deal.II/lac/include/lac/solver_control.h b/deal.II/lac/include/lac/solver_control.h index 12bfbf2d8e..1f70b3fc09 100644 --- a/deal.II/lac/include/lac/solver_control.h +++ b/deal.II/lac/include/lac/solver_control.h @@ -19,7 +19,10 @@ class ParameterHandler; +/*!@addtogroup Solvers */ +/*@{*/ +//! Control of the stopping criterion for solvers /** * Control class for iterative solvers. * @@ -356,7 +359,7 @@ class SolverControl : public Subscriptor bool m_log_result; }; - +//! Control of the stopping criterion depending on the initial residual. /** * Specialization of @p{SolverControl} which returns @p{success} if either * the specified tolerance is achieved or if the initial residual (or @@ -448,6 +451,7 @@ class ReductionControl : public SolverControl double reduced_tol; }; +/*@}*/ //------------------------------------------------------------// diff --git a/deal.II/lac/include/lac/solver_gmres.h b/deal.II/lac/include/lac/solver_gmres.h index 3f189b14d1..ffa77bc04c 100644 --- a/deal.II/lac/include/lac/solver_gmres.h +++ b/deal.II/lac/include/lac/solver_gmres.h @@ -26,6 +26,8 @@ #include #include +/*!@addtogroup Solvers */ +/*@{*/ namespace internal { @@ -109,7 +111,7 @@ namespace internal } } - +//! Generalized minimal residual method. /** * Implementation of the Restarted Preconditioned Direct Generalized * Minimal Residual Method. The stopping criterion is the norm of the @@ -287,7 +289,7 @@ class SolverGMRES : public Solver SolverGMRES (const SolverGMRES&); }; - +//! Generalized minimal residual method with flexible preconditioning. /** * Flexible GMRES. * @@ -367,6 +369,7 @@ class SolverFGMRES : public Solver FullMatrix H1; }; +/*@}*/ /* --------------------- Inline and template functions ------------------- */ diff --git a/deal.II/lac/include/lac/solver_minres.h b/deal.II/lac/include/lac/solver_minres.h index 5dc2e83083..c590b7b4eb 100644 --- a/deal.II/lac/include/lac/solver_minres.h +++ b/deal.II/lac/include/lac/solver_minres.h @@ -21,7 +21,10 @@ #include #include +/*!@addtogroup Solvers */ +/*@{*/ +//! Minimal residual method for symmetric matrices. /** * Preconditioned MinRes method. * @@ -137,7 +140,7 @@ class SolverMinRes : public Solver double res2; }; - +/*@}*/ /*------------------------- Implementation ----------------------------*/ diff --git a/deal.II/lac/include/lac/solver_qmrs.h b/deal.II/lac/include/lac/solver_qmrs.h index 9f0de94336..0ade9497c8 100644 --- a/deal.II/lac/include/lac/solver_qmrs.h +++ b/deal.II/lac/include/lac/solver_qmrs.h @@ -22,7 +22,10 @@ #include +/*!@addtogroup Solvers */ +/*@{*/ +//! Quasi-minimal residual method for symmetric matrices. /** * QMRS method. * @@ -191,7 +194,7 @@ class SolverQMRS : public Solver unsigned int step; }; - +/*@}*/ /*------------------------- Implementation ----------------------------*/ diff --git a/deal.II/lac/include/lac/solver_richardson.h b/deal.II/lac/include/lac/solver_richardson.h index 794cffa84d..603ebf4716 100644 --- a/deal.II/lac/include/lac/solver_richardson.h +++ b/deal.II/lac/include/lac/solver_richardson.h @@ -20,6 +20,10 @@ #include #include +/*!@addtogroup Solvers */ +/*@{*/ + +//! Richardson's or stationary iteration. /** * Implementation of the richardson iteration method. The stopping criterion * is the norm of the residual. @@ -162,7 +166,7 @@ class SolverRichardson : public Solver typename VECTOR::value_type res; }; - +/*@}*/ /*----------------- Implementation of the Richardson Method ------------------*/ diff --git a/deal.II/lac/include/lac/solver_selector.h b/deal.II/lac/include/lac/solver_selector.h index 34663e639e..298b4c0dc3 100644 --- a/deal.II/lac/include/lac/solver_selector.h +++ b/deal.II/lac/include/lac/solver_selector.h @@ -28,6 +28,10 @@ #include +/*!@addtogroup Solvers */ +/*@{*/ + +//! Selects a solver by changing a parameter. /** * By calling the @p{solve} function of this @p{SolverSelector}, it selects * the @p{solve} function of that @p{Solver} that was specified in the constructor @@ -200,7 +204,7 @@ class SolverSelector : public Subscriptor typename SolverGMRES::AdditionalData gmres_data; }; - +/*@}*/ /* --------------------- Inline and template functions ------------------- */ diff --git a/deal.II/lac/include/lac/sparse_decomposition.h b/deal.II/lac/include/lac/sparse_decomposition.h index 86224dbb88..fbccde398c 100644 --- a/deal.II/lac/include/lac/sparse_decomposition.h +++ b/deal.II/lac/include/lac/sparse_decomposition.h @@ -1,5 +1,5 @@ //---------------------- sparse_decomposition.h --------------------------- -// Copyright (C) 1998, 1999, 2000, 2001, 2002 +// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003 // by the deal.II authors and Stephen "Cheffo" Kolaroff // // This file is subject to QPL and may not be distributed @@ -16,6 +16,10 @@ #include +/*! @addtogroup LAC + *@{ + */ + /** * Abstract base class for sparse LU decompositions of a sparse matrix * into another sparse matrix. @@ -435,7 +439,8 @@ class SparseLUDecomposition : protected SparseMatrix, SparsityPattern *own_sparsity; }; - +/*@}*/ +//----------------------------------------------------------------------// template inline number diff --git a/deal.II/lac/include/lac/sparse_direct.h b/deal.II/lac/include/lac/sparse_direct.h index f49e884728..7c743e5fba 100644 --- a/deal.II/lac/include/lac/sparse_direct.h +++ b/deal.II/lac/include/lac/sparse_direct.h @@ -24,6 +24,10 @@ +/*! @addtogroup LAC + *@{ + */ + /** * This class provides an interface to the sparse direct solver MA27 * from the Harwell Subroutine Library. MA27 is a direct solver @@ -972,7 +976,7 @@ class SparseDirectMA47 : public Subscriptor const unsigned int *ICNTL); }; - +/*@}*/ #endif diff --git a/deal.II/lac/include/lac/sparse_ilu.h b/deal.II/lac/include/lac/sparse_ilu.h index 78fc47993c..a5aef6f077 100644 --- a/deal.II/lac/include/lac/sparse_ilu.h +++ b/deal.II/lac/include/lac/sparse_ilu.h @@ -1,5 +1,5 @@ //---------------------------- sparse_ilu.h --------------------------- -// Copyright (C) 1998, 1999, 2000, 2001, 2002 +// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003 // by the deal.II authors and Stephen "Cheffo" Kolaroff // // This file is subject to QPL and may not be distributed @@ -18,6 +18,10 @@ #include +/*! @addtogroup LAC + *@{ + */ + /** * Incomplete LU decomposition of a sparse matrix into another sparse matrix. * A given matrix is decomposed into a incomplete LU factorization, where @@ -188,7 +192,8 @@ class SparseILU : public SparseLUDecomposition << " is not greater or equal than zero!"); }; - +/*@}*/ +//----------------------------------------------------------------------// template template diff --git a/deal.II/lac/include/lac/sparse_matrix.h b/deal.II/lac/include/lac/sparse_matrix.h index 24f4408e7d..88bff51702 100644 --- a/deal.II/lac/include/lac/sparse_matrix.h +++ b/deal.II/lac/include/lac/sparse_matrix.h @@ -23,6 +23,10 @@ template class Vector; template class FullMatrix; +/*! @addtogroup Matrix1 + *@{ + */ + /** * Sparse matrix. * @@ -1200,7 +1204,7 @@ class SparseMatrix : public virtual Subscriptor template friend class SparseMatrix; }; - +/*@}*/ /*---------------------- Inline functions -----------------------------------*/ diff --git a/deal.II/lac/include/lac/sparse_matrix_ez.h b/deal.II/lac/include/lac/sparse_matrix_ez.h index f363bb3560..a5a4561165 100644 --- a/deal.II/lac/include/lac/sparse_matrix_ez.h +++ b/deal.II/lac/include/lac/sparse_matrix_ez.h @@ -24,6 +24,10 @@ template class Vector; template class FullMatrix; +/*! @addtogroup Matrix1 + *@{ + */ + /** * Sparse matrix without sparsity pattern. * @@ -1091,7 +1095,7 @@ class SparseMatrixEZ : public Subscriptor #endif }; - +/*@}*/ /*---------------------- Inline functions -----------------------------------*/ template diff --git a/deal.II/lac/include/lac/sparse_mic.h b/deal.II/lac/include/lac/sparse_mic.h index f5b7c34588..20f51f8e29 100644 --- a/deal.II/lac/include/lac/sparse_mic.h +++ b/deal.II/lac/include/lac/sparse_mic.h @@ -1,5 +1,5 @@ //---------------------------- sparse_mic.h --------------------------- -// Copyright (C) 1998, 1999, 2000, 2001, 2002 +// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003 // by the deal.II authors and Stephen "Cheffo" Kolaroff // // This file is subject to QPL and may not be distributed @@ -15,6 +15,10 @@ #include +/*! @addtogroup Preconditioners + *@{ + */ + /** * Modified incomplete Cholesky (MIC(0)) preconditioner. This class * conforms to the state and usage specification in @@ -183,6 +187,6 @@ class SparseMIC : public SparseLUDecomposition number get_rowsum (const unsigned int row) const; }; - +/*@}*/ #endif // __deal2__ diff --git a/deal.II/lac/include/lac/sparse_vanka.h b/deal.II/lac/include/lac/sparse_vanka.h index 88b797d0d8..9bfd1d648f 100644 --- a/deal.II/lac/include/lac/sparse_vanka.h +++ b/deal.II/lac/include/lac/sparse_vanka.h @@ -29,6 +29,10 @@ template class Vector; template class SparseVanka; template class SparseBlockVanka; +/*! @addtogroup Preconditioners + *@{ + */ + /** * Point-wise Vanka preconditioning. * This class does Vanka preconditioning on a point-wise base. @@ -594,5 +598,5 @@ class SparseBlockVanka : public SparseVanka const BlockingStrategy blocking_strategy); }; - +/*@}*/ #endif diff --git a/deal.II/lac/include/lac/sparsity_pattern.h b/deal.II/lac/include/lac/sparsity_pattern.h index 69ceeddf96..93ae1522f5 100644 --- a/deal.II/lac/include/lac/sparsity_pattern.h +++ b/deal.II/lac/include/lac/sparsity_pattern.h @@ -28,6 +28,10 @@ class CompressedSparsityPattern; +/*! @addtogroup Matrix1 + *@{ + */ + /** * Structure representing the sparsity pattern of a sparse matrix. * @@ -1039,6 +1043,7 @@ class SparsityPattern : public Subscriptor }; +/*@}*/ /*---------------------- Inline functions -----------------------------------*/ diff --git a/deal.II/lac/include/lac/swappable_vector.h b/deal.II/lac/include/lac/swappable_vector.h index 7f4cf9687f..f05c001409 100644 --- a/deal.II/lac/include/lac/swappable_vector.h +++ b/deal.II/lac/include/lac/swappable_vector.h @@ -20,6 +20,10 @@ #include +/*! @addtogroup LAC + *@{ + */ + /** * This class is a wrapper to the @p{Vector} class which allows to swap @@ -306,7 +310,7 @@ class SwappableVector : public Vector void reload_vector (const bool set_flag); }; - +/*@}*/ /*---------------------------- swappable_vector.h ---------------------------*/ /* end of #ifndef __deal2__swappable_vector_h */ diff --git a/deal.II/lac/include/lac/vector.h b/deal.II/lac/include/lac/vector.h index ba8b2e1420..c590befaad 100644 --- a/deal.II/lac/include/lac/vector.h +++ b/deal.II/lac/include/lac/vector.h @@ -20,6 +20,10 @@ #include +/*! @addtogroup LAC + *@{ + */ + /** * Numerical vector of data. For this class there are different types * of functions available. The first type of function mesures the norm @@ -580,7 +584,7 @@ class Vector template friend class Vector; }; - +/*@}*/ /*----------------------- Inline functions ----------------------------------*/ diff --git a/deal.II/lac/include/lac/vector_memory.h b/deal.II/lac/include/lac/vector_memory.h index 4f117b7ed9..7a6f4a4f7a 100644 --- a/deal.II/lac/include/lac/vector_memory.h +++ b/deal.II/lac/include/lac/vector_memory.h @@ -23,6 +23,10 @@ #include +/*! @addtogroup LAC + *@{ + */ + /** * Memory management for vectors. This class is used by all * iterative methods to allocate space for auxilliary @@ -176,7 +180,7 @@ class GrowingVectorMemory : public VectorMemory }; - +/*@}*/ /* --------------------- inline functions ---------------------- */ -- 2.39.5