* 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>
/**
* 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>
* 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>
* 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>
* 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.
*
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
};
/**
* 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
* @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
*/
* 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)
* 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>
* @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>
* @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>
projects / dealii-svn.git / commitdiff