]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
More doc fixes for doc++.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 1 Jun 1999 13:33:01 +0000 (13:33 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 1 Jun 1999 13:33:01 +0000 (13:33 +0000)
git-svn-id: https://svn.dealii.org/trunk@1361 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/tensorindex.h
deal.II/deal.II/include/multigrid/mg_base.h
deal.II/lac/include/lac/mgbase.h

index 51ff5adff9d278a35a3309bb0d6e7d6f6c55b4f1..beb570adaa943307cc1e0f7ce078dd967be51301 100644 (file)
@@ -33,13 +33,15 @@ public:
   TensorIndex(...);
   
                                   /**
-                                   *
                                    * Access operator returning index
                                    * in #n#th component
-                                   *
                                    */
   unsigned int operator () (unsigned int n) const;
-  DeclException1(ExcRank, int,
+
+                                    /**
+                                     * Exception.
+                                     */
+    DeclException1(ExcRank, int,
                 << "Index " << arg1 << " higher than maximum " << rank-1);  
 };
 
@@ -66,10 +68,8 @@ public:
   
   
                                   /**
-                                   *
                                    * Access operator returning index
                                    * in #n#th component
-                                   *
                                    */
   unsigned int operator () (unsigned int n) const
       {
@@ -88,12 +88,12 @@ private:
                                   /**
                                    * Field of indices.
                                    */
-  unsigned index[3];
-public:
-                                  /**
-                                   * Constructor taking #rank# indices.
-                                   */
-  TensorIndex(unsigned i0, unsigned i1, unsigned i2)
+    unsigned index[3];
+  public:
+                                    /**
+                                     * Constructor taking #rank# indices.
+                                     */
+    TensorIndex(unsigned i0, unsigned i1, unsigned i2)
       {
        index[0] = i0;
        index[1] = i1;
@@ -101,95 +101,93 @@ public:
       }
   
   
-                                  /**
-                                   *
-                                   * Access operator returning index
-                                   * in #n#th component
-                                   *
-                                   */
-  unsigned operator () (unsigned n) const
+                                    /**
+                                     * Access operator returning index
+                                     * in #n#th component
+                                     *
+                                     */
+    unsigned operator () (unsigned n) const
       {
        Assert(n<3, ExcRank(n));
        return index[n];
 
       }
   
-  DeclException1(ExcRank, unsigned,
-                << "Index " << arg1 << " higher than maximum 2");  
+    DeclException1(ExcRank, unsigned,
+                  << "Index " << arg1 << " higher than maximum 2");  
 };
 
 template<>
 class TensorIndex<2>
 {
-private:
-                                  /**
-                                   * Field of indices.
-                                   */
-  unsigned index[4];
-public:
-                                  /**
-                                   * Constructor taking #rank# indices.
-                                   */
-  TensorIndex(unsigned i0, unsigned i1)
+  private:
+                                    /**
+                                     * Field of indices.
+                                     */
+    unsigned index[4];
+  public:
+                                    /**
+                                     * Constructor taking #rank# indices.
+                                     */
+    TensorIndex(unsigned i0, unsigned i1)
       {
        index[0] = i0;
        index[1] = i1;
       }
   
   
-                                  /**
-                                   *
-                                   * Access operator returning index
-                                   * in #n#th component
-                                   *
-                                   */
-  unsigned operator () (unsigned n) const
+                                    /**
+                                     * Access operator returning index
+                                     * in #n#th component
+                                     */
+    unsigned operator () (unsigned n) const
       {
        Assert(n<2, ExcRank(n));
        return index[n];
 
       }
-  DeclException1(ExcRank, unsigned,
-                << "Index " << arg1 << " higher than maximum 1");  
+    DeclException1(ExcRank, unsigned,
+                  << "Index " << arg1 << " higher than maximum 1");  
 };
 
 template<>
 class TensorIndex<1>
 {
-private:
-                                  /**
-                                   * Field of indices.
-                                   */
-  unsigned index[1];
-public:
-                                  /**
-                                   * Constructor taking #rank# indices.
-                                   */
-  TensorIndex(unsigned i0)
+  private:
+                                    /**
+                                     * Field of indices.
+                                     */
+    unsigned index[1];
+  public:
+                                    /**
+                                     * Constructor taking #rank# indices.
+                                     */
+    TensorIndex(unsigned i0)
       {
        index[0] = i0;
       }
   
   
-                                  /**
-                                   *
-                                   * Access operator returning index
-                                   * in #n#th component
-                                   *
-                                   */
-  unsigned operator () (unsigned n) const
+                                    /**
+                                     * Access operator returning index
+                                     * in #n#th component
+                                     */
+    unsigned operator () (unsigned n) const
       {
        Assert(n<1, ExcRank(n));
        return index[n];
 
       }
-  DeclException1(ExcRank, unsigned,
-                << "Index " << arg1 << " higher than maximum 0");  
+    DeclException1(ExcRank, unsigned,
+                  << "Index " << arg1 << " higher than maximum 0");  
 };
 
+
+
 template<int rank>
 inline unsigned
-TensorIndex<rank>::operator() (unsigned n) const
+TensorIndex<rank>::
+operator() (unsigned n) const
 {
   Assert(n<rank, ExcRank(n));
   return index[n];
index 41c746197e3ba4e7faccf628f9b8b366333776a5..18704a4799f8bc75d76087f4a215c7a17da1a7d7 100644 (file)
@@ -1,8 +1,10 @@
-// $Id$
+/*----------------------------   mg_base.h     ---------------------------*/
+/*      $Id$                 */
+#ifndef __mg_base_H
+#define __mg_base_H
+/*----------------------------   mg_base.h     ---------------------------*/
 
 
-#ifndef __lac_mg_base_h
-#define __lac_mg_base_h
 
 #include <base/subscriptor.h>
 #include <base/smartpointer.h>
@@ -436,9 +438,11 @@ class PreconditionMG
 
 
 
+
+
 template<class SOLVER, class MATRIX, class PRECOND>
-MGCoarseGridLACIteration<SOLVER, MATRIX, PRECOND>
-::MGCoarseGridLACIteration(SOLVER& s, const MATRIX& m, const PRECOND& p)
+MGCoarseGridLACIteration<SOLVER, MATRIX, PRECOND>::
+MGCoarseGridLACIteration(SOLVER& s, const MATRIX& m, const PRECOND& p)
                :
                solver(s), matrix(m), precondition(p)
 {}
@@ -451,7 +455,10 @@ MGCoarseGridLACIteration<SOLVER, MATRIX, PRECOND>::operator()
   solver.solve(matrix, dst, src, precondition);
 }
 
-//////////////////////////////////////////////////////////////////////
+
+
+
+/* ------------------------------------------------------------------- */
 
 template<class VECTOR>
 MGVector<VECTOR>::MGVector(unsigned int min, unsigned int max)
@@ -478,7 +485,10 @@ MGVector<VECTOR>::operator[](unsigned int i) const
   return vector<VECTOR>::operator[](i-minlevel);
 }
 
-//////////////////////////////////////////////////////////////////////
+
+
+/* ------------------------------------------------------------------- */
+
 
 template<class MATRIX>
 MGMatrix<MATRIX>::MGMatrix(unsigned int min, unsigned int max)
@@ -505,13 +515,16 @@ MGMatrix<MATRIX>::operator[](unsigned int i) const
   return vector<MATRIX>::operator[](i-minlevel);
 }
 
-//////////////////////////////////////////////////////////////////////
+
+
+/* ------------------------------------------------------------------- */
+
 
 template<class MG, class VECTOR>
 PreconditionMG<MG, VECTOR>::PreconditionMG(MG& mg,
-                              const MGSmootherBase& pre,
-                              const MGSmootherBase& post,
-                              const MGCoarseGridSolver& coarse)
+                                          const MGSmootherBase& pre,
+                                          const MGSmootherBase& post,
+                                          const MGCoarseGridSolver& coarse)
                :
                multigrid(&mg),
                pre(&pre),
@@ -519,9 +532,12 @@ PreconditionMG<MG, VECTOR>::PreconditionMG(MG& mg,
                coarse(&coarse)
 {}
 
+
+
 template<class MG, class VECTOR>
 void
-PreconditionMG<MG, VECTOR>::operator() (VECTOR& dst, const VECTOR& src) const
+PreconditionMG<MG, VECTOR>::operator() (VECTOR& dst,
+                                       const VECTOR& src) const
 {
   multigrid->copy_to_mg(src);
   multigrid->vcycle(*pre, *post, *coarse);
@@ -529,4 +545,8 @@ PreconditionMG<MG, VECTOR>::operator() (VECTOR& dst, const VECTOR& src) const
 }
 
 
+
+/*----------------------------   mg_base.h     ---------------------------*/
+/* end of #ifndef __mg_base_H */
 #endif
+/*----------------------------   mg_base.h     ---------------------------*/
index cc71bc98f4dcadfb6ea3394de9124fef0720f140..d464b68f083909d0a588ccd91bb1ae620b6da329 100644 (file)
@@ -1,8 +1,10 @@
-// $Id$
+/*----------------------------   mgbase.h     ---------------------------*/
+/*      $Id$                 */
+#ifndef __mgbase_H
+#define __mgbase_H
+/*----------------------------   mgbase.h     ---------------------------*/
 
 
-#ifndef __lac_mgbase_h
-#define __lac_mgbase_h
 
 #include <base/subscriptor.h>
 #include <base/smartpointer.h>
@@ -436,9 +438,11 @@ class PreconditionMG
 
 
 
+
+
 template<class SOLVER, class MATRIX, class PRECOND>
-MGCoarseGridLACIteration<SOLVER, MATRIX, PRECOND>
-::MGCoarseGridLACIteration(SOLVER& s, const MATRIX& m, const PRECOND& p)
+MGCoarseGridLACIteration<SOLVER, MATRIX, PRECOND>::
+MGCoarseGridLACIteration(SOLVER& s, const MATRIX& m, const PRECOND& p)
                :
                solver(s), matrix(m), precondition(p)
 {}
@@ -451,7 +455,10 @@ MGCoarseGridLACIteration<SOLVER, MATRIX, PRECOND>::operator()
   solver.solve(matrix, dst, src, precondition);
 }
 
-//////////////////////////////////////////////////////////////////////
+
+
+
+/* ------------------------------------------------------------------- */
 
 template<class VECTOR>
 MGVector<VECTOR>::MGVector(unsigned int min, unsigned int max)
@@ -478,7 +485,10 @@ MGVector<VECTOR>::operator[](unsigned int i) const
   return vector<VECTOR>::operator[](i-minlevel);
 }
 
-//////////////////////////////////////////////////////////////////////
+
+
+/* ------------------------------------------------------------------- */
+
 
 template<class MATRIX>
 MGMatrix<MATRIX>::MGMatrix(unsigned int min, unsigned int max)
@@ -505,13 +515,16 @@ MGMatrix<MATRIX>::operator[](unsigned int i) const
   return vector<MATRIX>::operator[](i-minlevel);
 }
 
-//////////////////////////////////////////////////////////////////////
+
+
+/* ------------------------------------------------------------------- */
+
 
 template<class MG, class VECTOR>
 PreconditionMG<MG, VECTOR>::PreconditionMG(MG& mg,
-                              const MGSmootherBase& pre,
-                              const MGSmootherBase& post,
-                              const MGCoarseGridSolver& coarse)
+                                          const MGSmootherBase& pre,
+                                          const MGSmootherBase& post,
+                                          const MGCoarseGridSolver& coarse)
                :
                multigrid(&mg),
                pre(&pre),
@@ -519,9 +532,12 @@ PreconditionMG<MG, VECTOR>::PreconditionMG(MG& mg,
                coarse(&coarse)
 {}
 
+
+
 template<class MG, class VECTOR>
 void
-PreconditionMG<MG, VECTOR>::operator() (VECTOR& dst, const VECTOR& src) const
+PreconditionMG<MG, VECTOR>::operator() (VECTOR& dst,
+                                       const VECTOR& src) const
 {
   multigrid->copy_to_mg(src);
   multigrid->vcycle(*pre, *post, *coarse);
@@ -529,4 +545,8 @@ PreconditionMG<MG, VECTOR>::operator() (VECTOR& dst, const VECTOR& src) const
 }
 
 
+
+/*----------------------------   mgbase.h     ---------------------------*/
+/* end of #ifndef __mgbase_H */
 #endif
+/*----------------------------   mgbase.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.