]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Cosmetic changes to get a better documentation of the Trilinos wrapper classes.
authorkronbichler <kronbichler@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 3 Sep 2008 16:11:09 +0000 (16:11 +0000)
committerkronbichler <kronbichler@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 3 Sep 2008 16:11:09 +0000 (16:11 +0000)
git-svn-id: https://svn.dealii.org/trunk@16737 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/trilinos_block_sparse_matrix.h
deal.II/lac/include/lac/trilinos_block_vector.h
deal.II/lac/include/lac/trilinos_precondition.h
deal.II/lac/include/lac/trilinos_precondition_amg.h
deal.II/lac/include/lac/trilinos_vector.h

index bddfb764e5bb938e81c6594811c42da78b0a4f0a..18998dbefbe8d5f0ff3cdd21503184e11b2f6560 100644 (file)
@@ -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<TrilinosWrappers::SparseMatrix>
   {
index abca8be5e054086f50d1c8d7a5eb49bc3826a1d3..b97a4230caaf7771edf0a04cdbef82d3eb8458a1 100644 (file)
@@ -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 <base/config.h>
 
 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<Vector>
@@ -224,8 +225,8 @@ namespace TrilinosWrappers
                                           * <tt>u.swap(v)</tt>, 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
index 43bcbb138aeff77ab41be3a94c2a24884133f40d..c056fbd33a6b8f404e26f91aa13692d23f7f81bc 100755 (executable)
@@ -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
index 2c66315388608475628e479c9b05687b69f86a7f..17f38b9b599b5cc660e6c491f363810e8dd4da3c 100755 (executable)
@@ -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
index 33af1a0c38035bba0cdca20bfb9277ce2f82df97..f5902e11ecf3edbec6cbf3a8c8882cecf866d410 100755 (executable)
@@ -43,12 +43,8 @@ template <typename number> 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     ---------------------------*/

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.