From 3ab08e9fbfd230cf0fe4ceb01bc5c01d9e85324e Mon Sep 17 00:00:00 2001 From: Guido Kanschat Date: Mon, 3 May 2004 22:25:13 +0000 Subject: [PATCH] doxygenized git-svn-id: https://svn.dealii.org/trunk@9169 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/lac/include/lac/petsc_full_matrix.h | 10 +++++----- deal.II/lac/include/lac/petsc_matrix_base.h | 12 +++++------- .../include/lac/petsc_parallel_sparse_matrix.h | 8 +------- deal.II/lac/include/lac/petsc_parallel_vector.h | 6 +++--- deal.II/lac/include/lac/petsc_precondition.h | 15 ++++++++------- deal.II/lac/include/lac/petsc_solver.h | 17 +++++++++++------ deal.II/lac/include/lac/petsc_sparse_matrix.h | 12 +++--------- deal.II/lac/include/lac/petsc_vector.h | 2 +- deal.II/lac/include/lac/petsc_vector_base.h | 14 +++++++------- deal.II/lac/include/lac/sparse_matrix.h | 4 +++- 10 files changed, 47 insertions(+), 53 deletions(-) diff --git a/deal.II/lac/include/lac/petsc_full_matrix.h b/deal.II/lac/include/lac/petsc_full_matrix.h index 4c5f8ccda9..a5a0f376a2 100644 --- a/deal.II/lac/include/lac/petsc_full_matrix.h +++ b/deal.II/lac/include/lac/petsc_full_matrix.h @@ -21,13 +21,13 @@ #include + +namespace PETScWrappers +{ /*! @addtogroup PETSc *@{ */ - -namespace PETScWrappers -{ /** * Implementation of a sequential dense matrix class based on PETSC. All the * functionality is actually in the base class, except for the calls to @@ -49,9 +49,9 @@ namespace PETScWrappers FullMatrix (const unsigned int m, const unsigned int n); }; -} - + /*@}*/ +} #endif // DEAL_II_USE_PETSC diff --git a/deal.II/lac/include/lac/petsc_matrix_base.h b/deal.II/lac/include/lac/petsc_matrix_base.h index 13e88c9fb1..1e7b933189 100644 --- a/deal.II/lac/include/lac/petsc_matrix_base.h +++ b/deal.II/lac/include/lac/petsc_matrix_base.h @@ -23,10 +23,6 @@ #include #include -/*! @addtogroup PETSc - *@{ - */ - namespace PETScWrappers { // forward declarations @@ -46,6 +42,8 @@ namespace PETScWrappers * surprisingly only shows the nonzero elements of the matrix, not all * elements. * + * @ingroup PETSc + * @brief Matrix iterator * @author Guido Kanschat, Roy Stogner, Wolfgang Bangerth, 2004 */ class const_iterator @@ -280,6 +278,7 @@ namespace PETScWrappers * call SparseMatrix::compress() once at the end of the assembly stage and * before the matrix is actively used. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class MatrixBase @@ -694,7 +693,7 @@ namespace PETScWrappers - +/// @if NoDoc // -------------------------- inline and template functions ---------------------- @@ -891,10 +890,9 @@ namespace PETScWrappers Assert (r < m(), ExcIndexRange(r, 0, m())); return const_iterator(this, r+1, 0); } - +/// @endif } -/*@}*/ #endif // DEAL_II_USE_PETSC diff --git a/deal.II/lac/include/lac/petsc_parallel_sparse_matrix.h b/deal.II/lac/include/lac/petsc_parallel_sparse_matrix.h index 4009dd85c5..8c13bed9c8 100644 --- a/deal.II/lac/include/lac/petsc_parallel_sparse_matrix.h +++ b/deal.II/lac/include/lac/petsc_parallel_sparse_matrix.h @@ -24,10 +24,6 @@ #include -/*! @addtogroup PETSc - *@{ - */ - namespace PETScWrappers { @@ -48,6 +44,7 @@ namespace PETScWrappers * to individual elements in the documentation to the parallel vector * class. These comments apply here as well. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class SparseMatrix : public MatrixBase @@ -197,11 +194,8 @@ namespace PETScWrappers }; } - } -/*@}*/ - #endif // DEAL_II_USE_PETSC /*---------------------------- petsc_parallel_sparse_matrix.h ---------------------------*/ diff --git a/deal.II/lac/include/lac/petsc_parallel_vector.h b/deal.II/lac/include/lac/petsc_parallel_vector.h index 06a1c8df36..fa29335043 100644 --- a/deal.II/lac/include/lac/petsc_parallel_vector.h +++ b/deal.II/lac/include/lac/petsc_parallel_vector.h @@ -168,7 +168,7 @@ namespace PETScWrappers * wants to set every element of the * vector to zero, but instead, what * happens is this call: - * v=Vector(0);, i.e. the + * v=Vector@(0);, i.e. the * vector is replaced by one of * length zero. */ @@ -358,7 +358,7 @@ namespace PETScWrappers }; - +/// @if NoDoc // ------------------ template and inline functions ------------- @@ -461,8 +461,8 @@ namespace PETScWrappers return *this; } +/// @endif } -/*@}*/ } diff --git a/deal.II/lac/include/lac/petsc_precondition.h b/deal.II/lac/include/lac/petsc_precondition.h index 60cc1b036f..015764f04c 100644 --- a/deal.II/lac/include/lac/petsc_precondition.h +++ b/deal.II/lac/include/lac/petsc_precondition.h @@ -21,11 +21,6 @@ #include -/*! @addtogroup PETSc - *@{ - */ - - namespace PETScWrappers { // forward declarations @@ -42,6 +37,7 @@ namespace PETScWrappers * only to allow a similar interface than already used for the deal.II solver * and preconditioner classes. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class PreconditionerBase @@ -107,6 +103,7 @@ namespace PETScWrappers * A class that implements the interface to use the PETSc Jacobi * preconditioner. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class PreconditionJacobi : public PreconditionerBase @@ -159,6 +156,7 @@ namespace PETScWrappers * the matrix for preconditioning. This can be changed, as is explained in the * relevant section of the PETSc manual, but is not implemented here. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class PreconditionBlockJacobi : public PreconditionerBase @@ -204,6 +202,7 @@ namespace PETScWrappers * A class that implements the interface to use the PETSc SOR * preconditioner. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class PreconditionSOR : public PreconditionerBase @@ -266,6 +265,7 @@ namespace PETScWrappers * A class that implements the interface to use the PETSc SSOR * preconditioner. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class PreconditionSSOR : public PreconditionerBase @@ -328,6 +328,7 @@ namespace PETScWrappers * A class that implements the interface to use the PETSc Eisenstat * preconditioner. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class PreconditionEisenstat : public PreconditionerBase @@ -390,6 +391,7 @@ namespace PETScWrappers * A class that implements the interface to use the PETSc Incomplete Cholesky * preconditioner. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class PreconditionICC : public PreconditionerBase @@ -452,6 +454,7 @@ namespace PETScWrappers * A class that implements the interface to use the PETSc ILU * preconditioner. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class PreconditionILU : public PreconditionerBase @@ -510,8 +513,6 @@ namespace PETScWrappers } -/*@}*/ - #endif // DEAL_II_USE_PETSC /*---------------------------- petsc_precondition.h ---------------------------*/ diff --git a/deal.II/lac/include/lac/petsc_solver.h b/deal.II/lac/include/lac/petsc_solver.h index 11c2414382..9dc7ca4a43 100644 --- a/deal.II/lac/include/lac/petsc_solver.h +++ b/deal.II/lac/include/lac/petsc_solver.h @@ -22,10 +22,6 @@ #include -/*! @addtogroup PETSc - *@{ - */ - namespace PETScWrappers { // forward declarations @@ -41,6 +37,7 @@ namespace PETScWrappers * classes simply set the right flags to select one solver or another, or to * set certain parameters for individual solvers. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class SolverBase @@ -151,6 +148,7 @@ namespace PETScWrappers * An implementation of the solver interface using the PETSc Richardson * solver. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class SolverRichardson : public SolverBase @@ -232,6 +230,7 @@ namespace PETScWrappers * An implementation of the solver interface using the PETSc Chebychev * solver. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class SolverChebychev : public SolverBase @@ -297,6 +296,7 @@ namespace PETScWrappers * An implementation of the solver interface using the PETSc CG * solver. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class SolverCG : public SolverBase @@ -362,6 +362,7 @@ namespace PETScWrappers * An implementation of the solver interface using the PETSc BiCG * solver. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class SolverBiCG : public SolverBase @@ -510,6 +511,7 @@ namespace PETScWrappers * An implementation of the solver interface using the PETSc BiCGStab * solver. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class SolverBicgstab : public SolverBase @@ -575,6 +577,7 @@ namespace PETScWrappers * An implementation of the solver interface using the PETSc CG Squared * solver. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class SolverCGS : public SolverBase @@ -640,6 +643,7 @@ namespace PETScWrappers * An implementation of the solver interface using the PETSc TFQMR * solver. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class SolverTFQMR : public SolverBase @@ -710,6 +714,7 @@ namespace PETScWrappers * with an error indicating failure to converge with PETSc 2.1.6 and * prior. This should be fixed in later versions of PETSc, though. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class SolverTCQMR : public SolverBase @@ -775,6 +780,7 @@ namespace PETScWrappers * An implementation of the solver interface using the PETSc CR * solver. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class SolverCR : public SolverBase @@ -840,6 +846,7 @@ namespace PETScWrappers * An implementation of the solver interface using the PETSc Least Squares * solver. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class SolverLSQR : public SolverBase @@ -901,8 +908,6 @@ namespace PETScWrappers } -/*@}*/ - #endif // DEAL_II_USE_PETSC /*---------------------------- petsc_solver.h ---------------------------*/ diff --git a/deal.II/lac/include/lac/petsc_sparse_matrix.h b/deal.II/lac/include/lac/petsc_sparse_matrix.h index 68d46629b5..d8185dee7e 100644 --- a/deal.II/lac/include/lac/petsc_sparse_matrix.h +++ b/deal.II/lac/include/lac/petsc_sparse_matrix.h @@ -23,11 +23,6 @@ #include -/*! @addtogroup PETSc - *@{ - */ - - namespace PETScWrappers { /** @@ -39,6 +34,7 @@ namespace PETScWrappers * virtual functions). Only the functions creating a matrix of specific type * differ, and are implemented in this particular class. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class SparseMatrix : public MatrixBase @@ -171,7 +167,7 @@ namespace PETScWrappers }; - +/// @if NoDoc // -------- template and inline functions ---------- inline @@ -180,11 +176,9 @@ namespace PETScWrappers { MatrixBase::reinit (); } - +///@endif } -/*@}*/ - #endif // DEAL_II_USE_PETSC /*---------------------------- petsc_sparse_matrix.h ---------------------------*/ diff --git a/deal.II/lac/include/lac/petsc_vector.h b/deal.II/lac/include/lac/petsc_vector.h index f6491545d2..23202c24b7 100644 --- a/deal.II/lac/include/lac/petsc_vector.h +++ b/deal.II/lac/include/lac/petsc_vector.h @@ -59,7 +59,7 @@ namespace PETScWrappers * v=0;. Presumably, the user wants * to set every element of the vector to * zero, but instead, what happens is - * this call: v=Vector(0);, + * this call: v=Vector@(0);, * i.e. the vector is replaced by one of * length zero. */ diff --git a/deal.II/lac/include/lac/petsc_vector_base.h b/deal.II/lac/include/lac/petsc_vector_base.h index 992e5130bc..1f982401b7 100644 --- a/deal.II/lac/include/lac/petsc_vector_base.h +++ b/deal.II/lac/include/lac/petsc_vector_base.h @@ -24,9 +24,6 @@ #include -/*! @addtogroup PETSc - *@{ - */ // forward declaration template class Vector; @@ -35,6 +32,7 @@ template class Vector; /** * A namespace in which wrapper classes for PETSc objects reside. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ namespace PETScWrappers @@ -46,6 +44,7 @@ namespace PETScWrappers /** * A namespace for internal implementation details of the PETScWrapper * members. + * @ingroup PETSc */ namespace internal { @@ -66,6 +65,7 @@ namespace PETScWrappers * scalar value of this element. It also * has a variety of assignment operator * for writing to this one element. + * @ingroup PETSc */ class VectorReference { @@ -200,6 +200,7 @@ namespace PETScWrappers * after vector assembly. Therefore, you need to call Vector::compress() * before you actually use the vector. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ class VectorBase @@ -661,6 +662,7 @@ namespace PETScWrappers * of the C++ standard library which uses a temporary object. The * function simply exchanges the data of the two vectors. * + * @ingroup PETSc * @author Wolfgang Bangerth, 2004 */ inline @@ -669,7 +671,7 @@ namespace PETScWrappers u.swap (v); } - +///@if NoDoc namespace internal { inline @@ -858,11 +860,9 @@ namespace PETScWrappers } - +///@endif } -/*@}*/ - #endif // DEAL_II_USE_PETSC /*---------------------------- petsc_vector_base.h ---------------------------*/ diff --git a/deal.II/lac/include/lac/sparse_matrix.h b/deal.II/lac/include/lac/sparse_matrix.h index c45546d637..8c971a37b1 100644 --- a/deal.II/lac/include/lac/sparse_matrix.h +++ b/deal.II/lac/include/lac/sparse_matrix.h @@ -1628,6 +1628,8 @@ class SparseMatrix : public virtual Subscriptor }; /*@}*/ + +/// @if NoDoc /*---------------------- Inline functions -----------------------------------*/ @@ -2250,7 +2252,7 @@ SparseMatrix::end (const unsigned int r) return end(); } - +/// @endif /*---------------------------- sparse_matrix.h ---------------------------*/ -- 2.39.5