]> https://gitweb.dealii.org/ - dealii.git/commitdiff
doxygen documentation
authorGuido Kanschat <dr.guido.kanschat@gmail.com>
Tue, 30 Aug 2005 09:46:55 +0000 (09:46 +0000)
committerGuido Kanschat <dr.guido.kanschat@gmail.com>
Tue, 30 Aug 2005 09:46:55 +0000 (09:46 +0000)
git-svn-id: https://svn.dealii.org/trunk@11338 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/precondition_block.h
deal.II/lac/include/lac/solver_control.h
deal.II/lac/include/lac/sparse_decomposition.h
deal.II/lac/include/lac/sparse_ilu.h
deal.II/lac/include/lac/sparse_mic.h
deal.II/lac/include/lac/sparse_vanka.h
deal.II/lac/include/lac/swappable_vector.h
deal.II/lac/include/lac/vector.h

index d01d01f66968cc491d5a751283657a1ce961e7ad..b2b3c586c46ddb1dc8e4a7c1ae8f9776524486dc 100644 (file)
@@ -69,18 +69,6 @@ class PreconditionBlockJacobi;
  * example, <tt>number==double, inverse_type=float</tt> might be a viable
  * choice.
  *
- *
- * @sect2{On template instantiations}
- *
- * Member functions of this class are either implemented in this file
- * or in a file of the same name with suffix ``.templates.h''. For the
- * most common combinations of the template parameters, instantiations
- * of this class are provided in a file with suffix ``.cc'' in the
- * ``source'' directory. If you need an instantiation that is not
- * listed there, you have to include this file along with the
- * corresponding ``.templates.h'' file and instantiate the respective
- * class yourself.
- *
  * @author Ralf Hartmann, Guido Kanschat, 1999, 2000
  */
 template<class MATRIX, typename inverse_type = typename MATRIX::value_type>
@@ -417,6 +405,8 @@ class PreconditionBlock : public virtual Subscriptor
 /**
  * Block Jacobi preconditioning.
  * See PreconditionBlock for requirements on the matrix.
+ *
+ * @ref Instantiations: some (SparseMatrix<double>, SparseMatrix<float>, <tt>double</tt>, <tt>float</tt>)
  * @author Ralf Hartmann, Guido Kanschat, 1999, 2000, 2003
  */
 template<class MATRIX, typename inverse_type = typename MATRIX::value_type>
@@ -700,6 +690,7 @@ class PreconditionBlockJacobi : public virtual Subscriptor,
  * arbitrarily.
  *
  * See PreconditionBlock for requirements on the matrix.
+ * @ref Instantiations: some (SparseMatrix<double>, SparseMatrix<float>, <tt>double</tt>, <tt>float</tt>)
  * @author Ralf Hartmann, Guido Kanschat, 1999, 2000, 2001, 2002, 2003
  */
 template<class MATRIX, typename inverse_type = typename MATRIX::value_type>
@@ -855,6 +846,7 @@ class PreconditionBlockSOR : public virtual Subscriptor,
  * class requires storage of the diagonal blocks and their inverses.
  *
  * See PreconditionBlock for requirements on the matrix.
+ * @ref Instantiations: some (SparseMatrix<double>, SparseMatrix<float>, <tt>double</tt>, <tt>float</tt>)
  * @author Ralf Hartmann, Guido Kanschat, 1999, 2000
  */
 template<class MATRIX, typename inverse_type = typename MATRIX::value_type>
index fce9ee7fd1e2116f834ff596e0dd67bd0577f52d..8d654ef943cf16fad552287e6d133fa7c8e97ea3 100644 (file)
@@ -39,8 +39,8 @@ class ParameterHandler;
  * sophisticated tests.
  *
  *
- * @sect2{State}
- * The return states of the check function are of type @p State,
+ * <h3>State</h3>
+ * The return states of the check function are of type #State,
  * which is an enum local to this class. It indicates the state the
  * solver is in.
  *
@@ -59,14 +59,19 @@ class SolverControl : public Subscriptor
   public:
 
                                     /**
-                                     * @p Enum denoting the different
+                                     * Enum denoting the different
                                      * states a solver can be in. See
                                      * the general documentation of
                                      * this class for more
                                      * information.
                                      */
     enum State {
-      iterate = 0, success, failure
+                                          /// Continue iteration
+      iterate = 0,
+                                      /// Stop iteration, goal reached
+      success,
+                                      /// Stop iteration, goal not reached
+      failure
     };
 
                                     /**
index ce94a3ba18ba0d6a96cd30dca32c1f31a7b3193b..3e7e3d81c6fe5b1633361696546fa4b5c0db8c9d 100644 (file)
@@ -82,7 +82,7 @@
  * restrictions on the sparsity see section `Fill-in' above).
  *
  *
- * @sect2{State management}
+ * <h3>State management</h3>
  *
  * The state management simply requires the initialize() function to
  * be called before the object is used as preconditioner.
  * method. It is legal to apply this decomposition (vmult() method) in
  * decomposed state.
  *
- * @sect2{Particular implementations}
+ * <h3>Particular implementations</h3>
  *
  * It is enough to override the initialize() and vmult() methods to
  * implement particular LU decompositions, like the true LU, or the
index 542c697e5d2402d97f5c0524fdf686c2619c7901..64f4af846c401e5cd133dcaa105991d7f074675c 100644 (file)
  * @endverbatim
  *
  * 
- * @sect2{Usage and state management}
+ * <h3>Usage and state management</h3>
  *
  * Refer to SparseLUDecomposition documentation for suggested
  * usage and state management.
  *
- * 
- * @sect2{On template instantiations}
- *
- * Member functions of this class are either implemented in this file
- * or in a file of the same name with suffix ``.templates.h''. For the
- * most common combinations of the template parameters, instantiations
- * of this class are provided in a file with suffix ``.cc'' in the
- * ``source'' directory. If you need an instantiation that is not
- * listed there, you have to include this file along with the
- * corresponding ``.templates.h'' file and instantiate the respective
- * class yourself.
- *
+ * @ref Instantiations: some (float, double)
  * @author Wolfgang Bangerth, 1999, based on a similar implementation
  * by Malte Braack; unified interface: Ralf Hartmann
  */
index c8ca448ffc9ddbd211ef181db965ea5e953b95ab..238059d02ed949626fbe34822dcaff9c16d87817 100644 (file)
@@ -25,7 +25,7 @@
  * SparseLUDecomposition.
  *
  * 
- * @sect2{The decomposition}
+ * <h3>The decomposition</h3>
  * 
  * Let a sparse matrix A is in the form A = - L - U + D, where -L and
  * -U are strictly lower and upper triangular matrices. The MIC(0)
index 86378583625d7e4c4bdbd33cf482052392e89668..ca0cd10aa9c3a791bd58578b844648c3344f8b95 100644 (file)
@@ -118,18 +118,7 @@ template <typename number> class SparseBlockVanka;
  * whether this might pose some problems in the inversion of the local matrices.
  * Maybe someone would like to check this.
  *
- *
- * @sect2{On template instantiations}
- *
- * Member functions of this class are either implemented in this file
- * or in a file of the same name with suffix ``.templates.h''. For the
- * most common combinations of the template parameters, instantiations
- * of this class are provided in a file with suffix ``.cc'' in the
- * ``source'' directory. If you need an instantiation that is not
- * listed there, you have to include this file along with the
- * corresponding ``.templates.h'' file and instantiate the respective
- * class yourself.
- *
+ * @ref Instantiations: some (float, double)
  * @author Guido Kanschat, Wolfgang Bangerth; 1999, 2000
  */
 template<typename number>
index e4a90569929a0faa072ffea156d1bfc62b6cdf1f..ffe8195fa910267bad9a64d157d7b19ee5f6344e 100644 (file)
  * @p reload is called. If it is not available, @p reload waits until
  * the detached thread has loaded the data.
  *
- *
- * @sect2{On template instantiations}
- *
- * Member functions of this class are either implemented in this file
- * or in a file of the same name with suffix ``.templates.h''. For the
- * most common combinations of the template parameters, instantiations
- * of this class are provided in a file with suffix ``.cc'' in the
- * ``source'' directory. If you need an instantiation that is not
- * listed there, you have to include this file along with the
- * corresponding ``.templates.h'' file and instantiate the respective
- * class yourself.
- *
+ * @ref Instantiations: some (<tt>@<float@> @<double@></tt>)
  * @author Wolfgang Bangerth, 1999, 2000
  */
 template <typename number>
index 02e9305be5a1f89d207686b0646b47de5cdf2a18..e0c112a553af11f6ae777eb1f41e82024818543e 100644 (file)
@@ -48,18 +48,7 @@ template<typename number> class LAPACKFullMatrix;
  * @p vector (with a lowercase "v"), this class implements an element
  * of a vector space suitable for numerical computations.
  *
- *
- * @sect2{On template instantiations}
- *
- * Member functions of this class are either implemented in this file
- * or in a file of the same name with suffix ``.templates.h''. For the
- * most common combinations of the template parameters, instantiations
- * of this class are provided in a file with suffix ``.cc'' in the
- * ``source'' directory. If you need an instantiation that is not
- * listed there, you have to include this file along with the
- * corresponding ``.templates.h'' file and instantiate the respective
- * class yourself.
- *
+ * @ref Instantiations: some (<tt>@<float@> @<double@></tt>)
  * @author Guido Kanschat, Franz-Theo Suttmeier, Wolfgang Bangerth
  */
 template <typename Number>

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.