From 2d821163a42f436564d95175459b568fcb40690f Mon Sep 17 00:00:00 2001 From: kronbichler Date: Wed, 3 Sep 2008 16:11:09 +0000 Subject: [PATCH] Cosmetic changes to get a better documentation of the Trilinos wrapper classes. git-svn-id: https://svn.dealii.org/trunk@16737 0785d39b-7218-0410-832d-ea1e28bc413d --- .../lac/trilinos_block_sparse_matrix.h | 2 +- .../lac/include/lac/trilinos_block_vector.h | 27 ++++++++++--------- .../lac/include/lac/trilinos_precondition.h | 12 ++++++++- .../include/lac/trilinos_precondition_amg.h | 7 +++++ deal.II/lac/include/lac/trilinos_vector.h | 18 ++++++------- 5 files changed, 42 insertions(+), 24 deletions(-) diff --git a/deal.II/lac/include/lac/trilinos_block_sparse_matrix.h b/deal.II/lac/include/lac/trilinos_block_sparse_matrix.h index bddfb764e5..18998dbefb 100644 --- a/deal.II/lac/include/lac/trilinos_block_sparse_matrix.h +++ b/deal.II/lac/include/lac/trilinos_block_sparse_matrix.h @@ -58,7 +58,7 @@ namespace TrilinosWrappers * the same reason as is documented with the BlockSparsityPattern class. * * @ingroup Matrix1 - * @author Wolfgang Bangerth, 2004 + * @author Martin Kronbichler, Wolfgang Bangerth, 2008 */ class BlockSparseMatrix : public BlockMatrixBase { diff --git a/deal.II/lac/include/lac/trilinos_block_vector.h b/deal.II/lac/include/lac/trilinos_block_vector.h index abca8be5e0..b97a4230ca 100644 --- a/deal.II/lac/include/lac/trilinos_block_vector.h +++ b/deal.II/lac/include/lac/trilinos_block_vector.h @@ -10,8 +10,8 @@ // further information on this license. // //--------------------------------------------------------------------------- -#ifndef __deal2__trilinos_parallel_block_vector_h -#define __deal2__trilinos_parallel_block_vector_h +#ifndef __deal2__trilinos_block_vector_h +#define __deal2__trilinos_block_vector_h #include @@ -24,16 +24,16 @@ DEAL_II_NAMESPACE_OPEN +/*! @addtogroup TrilinosWrappers + *@{ + */ namespace TrilinosWrappers { // forward declaration class BlockVector; - -/*! @addtogroup TrilinosWrappers - *@{ - */ - + + /** * An implementation of block vectors based on the vector class * implemented in TrilinosWrappers. While the base class provides for most of the @@ -48,6 +48,7 @@ namespace TrilinosWrappers * of these blocks to be stored on the local process. * * @ingroup Vectors + * @ingroup TrilinosWrappers * @author Martin Kronbichler, Wolfgang Bangerth, 2008 */ class BlockVector : public BlockVectorBase @@ -224,8 +225,8 @@ namespace TrilinosWrappers * u.swap(v), again in analogy * to standard functions. */ - void swap (BlockVector &v); - + void swap (BlockVector &v); + /** * Exception */ @@ -236,8 +237,6 @@ namespace TrilinosWrappers DeclException0 (ExcNonMatchingBlockVectors); }; -/*@}*/ - /*----------------------- Inline functions ----------------------------------*/ @@ -393,7 +392,7 @@ namespace TrilinosWrappers /** * Global function which overloads the default implementation * of the C++ standard library which uses a temporary object. The - * function simply exchanges the data of the two vectors. + * function simply exchanges the data of the two vectors. * * @ingroup TrilinosWrappers * @relates TrilinosWrappers::BlockVector @@ -405,9 +404,11 @@ namespace TrilinosWrappers { u.swap (v); } - + } +/*@}*/ + DEAL_II_NAMESPACE_CLOSE #endif // DEAL_II_USE_TRILINOS diff --git a/deal.II/lac/include/lac/trilinos_precondition.h b/deal.II/lac/include/lac/trilinos_precondition.h index 43bcbb138a..c056fbd33a 100755 --- a/deal.II/lac/include/lac/trilinos_precondition.h +++ b/deal.II/lac/include/lac/trilinos_precondition.h @@ -26,12 +26,21 @@ class Ifpack_Preconditioner; DEAL_II_NAMESPACE_OPEN +/*! @addtogroup TrilinosWrappers + *@{ + */ + namespace TrilinosWrappers { + class Vector; class SparseMatrix; - +/** + * @ingroup TrilinosWrappers + * @ingroup Preconditioners + * @author Wolfgang Bangerth, 2008 + */ class PreconditionSSOR { public: @@ -78,6 +87,7 @@ namespace TrilinosWrappers } +/*@}*/ DEAL_II_NAMESPACE_CLOSE diff --git a/deal.II/lac/include/lac/trilinos_precondition_amg.h b/deal.II/lac/include/lac/trilinos_precondition_amg.h index 2c66315388..17f38b9b59 100755 --- a/deal.II/lac/include/lac/trilinos_precondition_amg.h +++ b/deal.II/lac/include/lac/trilinos_precondition_amg.h @@ -43,6 +43,10 @@ class Epetra_CrsMatrix; DEAL_II_NAMESPACE_OPEN +/*! @addtogroup TrilinosWrappers + *@{ + */ + namespace TrilinosWrappers { @@ -73,6 +77,8 @@ namespace TrilinosWrappers * Chebyshev smoother instead of a symmetric Gauss-Seidel smoother. * For most elliptic problems, Chebyshev is better than Gauss-Seidel (SSOR). * + * @ingroup TrilinosWrappers + * @ingroup Preconditioners * @author Martin Kronbichler, 2008 */ class PreconditionAMG : public Subscriptor @@ -187,6 +193,7 @@ namespace TrilinosWrappers }; } +/*@}*/ DEAL_II_NAMESPACE_CLOSE diff --git a/deal.II/lac/include/lac/trilinos_vector.h b/deal.II/lac/include/lac/trilinos_vector.h index 33af1a0c38..f5902e11ec 100755 --- a/deal.II/lac/include/lac/trilinos_vector.h +++ b/deal.II/lac/include/lac/trilinos_vector.h @@ -43,12 +43,8 @@ template class Vector; /** - * A namespace in which wrapper classes for Trilinos objects reside. - * - * @ingroup TrilinosWrappers - * @ingroup Vectors - * @see @ref SoftwareTrilinos - * @author Martin Kronbichler, Wolfgang Bangerth, 2008 + * @addtogroup TrilinosWrappers + *@{ */ namespace TrilinosWrappers { @@ -305,6 +301,8 @@ namespace TrilinosWrappers * necessary. * * @ingroup TrilinosWrappers + * @ingroup Vectors + * @see @ref SoftwareTrilinos * @author Martin Kronbichler, Wolfgang Bangerth, 2008 */ class Vector @@ -901,7 +899,7 @@ namespace TrilinosWrappers // ------------------- inline and template functions -------------- /** - * Global function @p swap which overloads the default implementation + * Global function swap which overloads the default implementation * of the C standard library which uses a temporary object. The * function simply exchanges the data of the two vectors. * @@ -1051,11 +1049,13 @@ namespace TrilinosWrappers #endif // DOXYGEN } +/*@}*/ + DEAL_II_NAMESPACE_CLOSE #endif // DEAL_II_USE_TRILINOS -/*---------------------------- trilinos_vector_base.h ---------------------------*/ +/*---------------------------- trilinos_vector.h ---------------------------*/ #endif -/*---------------------------- trilinos_vector_base.h ---------------------------*/ +/*---------------------------- trilinos_vector.h ---------------------------*/ -- 2.39.5