]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
doxygenized
authorguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 3 May 2004 22:25:13 +0000 (22:25 +0000)
committerguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 3 May 2004 22:25:13 +0000 (22:25 +0000)
git-svn-id: https://svn.dealii.org/trunk@9169 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/petsc_full_matrix.h
deal.II/lac/include/lac/petsc_matrix_base.h
deal.II/lac/include/lac/petsc_parallel_sparse_matrix.h
deal.II/lac/include/lac/petsc_parallel_vector.h
deal.II/lac/include/lac/petsc_precondition.h
deal.II/lac/include/lac/petsc_solver.h
deal.II/lac/include/lac/petsc_sparse_matrix.h
deal.II/lac/include/lac/petsc_vector.h
deal.II/lac/include/lac/petsc_vector_base.h
deal.II/lac/include/lac/sparse_matrix.h

index 4c5f8ccda9c7bf3d7858ab45e10c4501a7caa308..a5a0f376a22891684a96a88fb470acc7a410693d 100644 (file)
 
 #include <lac/petsc_matrix_base.h>
 
+
+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
 
index 13e88c9fb194faa06c2eff4fcf15fb9d1f2d93be..1e7b933189ecfe57c610fd969c421f594ce4f7ba 100644 (file)
 #include <boost/shared_ptr.hpp>
 #include <vector>
 
-/*! @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
 
index 4009dd85c5235042db0c566412b64937d8568bac..8c13bed9c8bd816b60d8f312a93defe10edb0e67 100644 (file)
 #include <vector>
 
 
-/*! @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     ---------------------------*/
index 06a1c8df3638b7c4c31137c65561b00d2f7241e8..fa293350435ec879cc91c9c321ad9e8d3b247924 100644 (file)
@@ -168,7 +168,7 @@ namespace PETScWrappers
                                           * wants to set every element of the
                                           * vector to zero, but instead, what
                                           * happens is this call:
-                                          * <tt>v=Vector<number>(0);</tt>, i.e. the
+                                          * <tt>v=Vector@<number@>(0);</tt>, 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
   }
-/*@}*/  
 }
 
 
index 60cc1b036f1b6cd10d057d3dd0a6f5fbf9961a49..015764f04c26cdbc63478305e7811f1f2a241ddf 100644 (file)
 #include <petscpc.h>
 
 
-/*! @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     ---------------------------*/
index 11c2414382efc58b01bc62bbae926006ae2ea58d..9dc7ca4a437db30bbb41b197fb17c1a247422955 100644 (file)
 #include <petscksp.h>
 
 
-/*! @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     ---------------------------*/
index 68d46629b57d5f7c1691d6ddde818dfcdbe4a675..d8185dee7e01ca911a69f8621f76982bc716c6e7 100644 (file)
 
 #include <vector>
 
-/*! @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     ---------------------------*/
index f6491545d2b9995952e385faf3861f7dfaa2f0f0..23202c24b78191ba86c8ff8505abcf3f110e7127 100644 (file)
@@ -59,7 +59,7 @@ namespace PETScWrappers
                                         * <tt>v=0;</tt>. Presumably, the user wants
                                         * to set every element of the vector to
                                         * zero, but instead, what happens is
-                                        * this call: <tt>v=Vector<number>(0);</tt>,
+                                        * this call: <tt>v=Vector@<number@>(0);</tt>,
                                         * i.e. the vector is replaced by one of
                                         * length zero.
                                         */
index 992e5130bcc95d1b187af7f407a85d20f9df5fc5..1f982401b7f3719493c44998b01b79e84f08ab6c 100644 (file)
@@ -24,9 +24,6 @@
 
 #include <utility>
 
-/*! @addtogroup PETSc
- *@{
- */
 
                                  // forward declaration
 template <typename number> class Vector;
@@ -35,6 +32,7 @@ template <typename number> 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     ---------------------------*/
index c45546d637e70bd46f9b43b62933daff46b05ad3..8c971a37b14d11a6084d67e94cb27b0ca7583649 100644 (file)
@@ -1628,6 +1628,8 @@ class SparseMatrix : public virtual Subscriptor
 };
 
 /*@}*/
+
+/// @if NoDoc
 /*---------------------- Inline functions -----------------------------------*/
 
 
@@ -2250,7 +2252,7 @@ SparseMatrix<number>::end (const unsigned int r)
   return end();
 }
 
-
+/// @endif
 
 
 /*----------------------------   sparse_matrix.h     ---------------------------*/

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.