From e57ae94c2ff5f4d79d9a623781289667583ca4d5 Mon Sep 17 00:00:00 2001 From: guido Date: Tue, 30 Aug 2005 09:46:55 +0000 Subject: [PATCH] doxygen documentation git-svn-id: https://svn.dealii.org/trunk@11338 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/lac/include/lac/precondition_block.h | 16 ++++------------ deal.II/lac/include/lac/solver_control.h | 13 +++++++++---- deal.II/lac/include/lac/sparse_decomposition.h | 4 ++-- deal.II/lac/include/lac/sparse_ilu.h | 15 ++------------- deal.II/lac/include/lac/sparse_mic.h | 2 +- deal.II/lac/include/lac/sparse_vanka.h | 13 +------------ deal.II/lac/include/lac/swappable_vector.h | 13 +------------ deal.II/lac/include/lac/vector.h | 13 +------------ 8 files changed, 21 insertions(+), 68 deletions(-) diff --git a/deal.II/lac/include/lac/precondition_block.h b/deal.II/lac/include/lac/precondition_block.h index d01d01f669..b2b3c586c4 100644 --- a/deal.II/lac/include/lac/precondition_block.h +++ b/deal.II/lac/include/lac/precondition_block.h @@ -69,18 +69,6 @@ class PreconditionBlockJacobi; * example, number==double, inverse_type=float 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 @@ -417,6 +405,8 @@ class PreconditionBlock : public virtual Subscriptor /** * Block Jacobi preconditioning. * See PreconditionBlock for requirements on the matrix. + * + * @ref Instantiations: some (SparseMatrix, SparseMatrix, double, float) * @author Ralf Hartmann, Guido Kanschat, 1999, 2000, 2003 */ template @@ -700,6 +690,7 @@ class PreconditionBlockJacobi : public virtual Subscriptor, * arbitrarily. * * See PreconditionBlock for requirements on the matrix. + * @ref Instantiations: some (SparseMatrix, SparseMatrix, double, float) * @author Ralf Hartmann, Guido Kanschat, 1999, 2000, 2001, 2002, 2003 */ template @@ -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, SparseMatrix, double, float) * @author Ralf Hartmann, Guido Kanschat, 1999, 2000 */ template diff --git a/deal.II/lac/include/lac/solver_control.h b/deal.II/lac/include/lac/solver_control.h index fce9ee7fd1..8d654ef943 100644 --- a/deal.II/lac/include/lac/solver_control.h +++ b/deal.II/lac/include/lac/solver_control.h @@ -39,8 +39,8 @@ class ParameterHandler; * sophisticated tests. * * - * @sect2{State} - * The return states of the check function are of type @p State, + *

State

+ * 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 }; /** diff --git a/deal.II/lac/include/lac/sparse_decomposition.h b/deal.II/lac/include/lac/sparse_decomposition.h index ce94a3ba18..3e7e3d81c6 100644 --- a/deal.II/lac/include/lac/sparse_decomposition.h +++ b/deal.II/lac/include/lac/sparse_decomposition.h @@ -82,7 +82,7 @@ * restrictions on the sparsity see section `Fill-in' above). * * - * @sect2{State management} + *

State management

* * The state management simply requires the initialize() function to * be called before the object is used as preconditioner. @@ -106,7 +106,7 @@ * method. It is legal to apply this decomposition (vmult() method) in * decomposed state. * - * @sect2{Particular implementations} + *

Particular implementations

* * It is enough to override the initialize() and vmult() methods to * implement particular LU decompositions, like the true LU, or the diff --git a/deal.II/lac/include/lac/sparse_ilu.h b/deal.II/lac/include/lac/sparse_ilu.h index 542c697e5d..64f4af846c 100644 --- a/deal.II/lac/include/lac/sparse_ilu.h +++ b/deal.II/lac/include/lac/sparse_ilu.h @@ -46,23 +46,12 @@ * @endverbatim * * - * @sect2{Usage and state management} + *

Usage and state management

* * 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 */ diff --git a/deal.II/lac/include/lac/sparse_mic.h b/deal.II/lac/include/lac/sparse_mic.h index c8ca448ffc..238059d02e 100644 --- a/deal.II/lac/include/lac/sparse_mic.h +++ b/deal.II/lac/include/lac/sparse_mic.h @@ -25,7 +25,7 @@ * SparseLUDecomposition. * * - * @sect2{The decomposition} + *

The decomposition

* * 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) diff --git a/deal.II/lac/include/lac/sparse_vanka.h b/deal.II/lac/include/lac/sparse_vanka.h index 8637858362..ca0cd10aa9 100644 --- a/deal.II/lac/include/lac/sparse_vanka.h +++ b/deal.II/lac/include/lac/sparse_vanka.h @@ -118,18 +118,7 @@ template 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 diff --git a/deal.II/lac/include/lac/swappable_vector.h b/deal.II/lac/include/lac/swappable_vector.h index e4a9056992..ffe8195fa9 100644 --- a/deal.II/lac/include/lac/swappable_vector.h +++ b/deal.II/lac/include/lac/swappable_vector.h @@ -41,18 +41,7 @@ * @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 (@ @) * @author Wolfgang Bangerth, 1999, 2000 */ template diff --git a/deal.II/lac/include/lac/vector.h b/deal.II/lac/include/lac/vector.h index 02e9305be5..e0c112a553 100644 --- a/deal.II/lac/include/lac/vector.h +++ b/deal.II/lac/include/lac/vector.h @@ -48,18 +48,7 @@ template 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 (@ @) * @author Guido Kanschat, Franz-Theo Suttmeier, Wolfgang Bangerth */ template -- 2.39.5