From cdb8fba8a4f30d688a257f8148eee8497b05307c Mon Sep 17 00:00:00 2001 From: Guido Kanschat Date: Sun, 24 Jul 2005 21:16:19 +0000 Subject: [PATCH] @section etc. removed git-svn-id: https://svn.dealii.org/trunk@11188 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/lac/include/lac/block_matrix_base.h | 2 +- deal.II/lac/include/lac/block_vector_base.h | 2 +- .../include/lac/petsc_parallel_sparse_matrix.h | 2 +- .../lac/include/lac/petsc_parallel_vector.h | 4 ++-- deal.II/lac/include/lac/precondition.h | 12 ------------ deal.II/lac/include/lac/sparse_direct.h | 18 +++++++++--------- 6 files changed, 14 insertions(+), 26 deletions(-) diff --git a/deal.II/lac/include/lac/block_matrix_base.h b/deal.II/lac/include/lac/block_matrix_base.h index 7eb6ec1c08..9b77f141f7 100644 --- a/deal.II/lac/include/lac/block_matrix_base.h +++ b/deal.II/lac/include/lac/block_matrix_base.h @@ -248,7 +248,7 @@ namespace internal * individual blocks. * * - * @section Inheritance Inheriting from this class + *

Inheriting from this class

* * Since this class simply forwards its calls to the subobjects (if necessary * after adjusting indices denoting which subobject is meant), this class is diff --git a/deal.II/lac/include/lac/block_vector_base.h b/deal.II/lac/include/lac/block_vector_base.h index 21816545c1..61fc3fdcab 100644 --- a/deal.II/lac/include/lac/block_vector_base.h +++ b/deal.II/lac/include/lac/block_vector_base.h @@ -634,7 +634,7 @@ namespace internal * type the block vector is built on. * * - * @section BlockVectorAccess Accessing individual blocks, and resizing vectors + *

Accessing individual blocks, and resizing vectors

* * Apart from using this object as a whole, you can use each block * separately as a vector, using the block() function. There diff --git a/deal.II/lac/include/lac/petsc_parallel_sparse_matrix.h b/deal.II/lac/include/lac/petsc_parallel_sparse_matrix.h index d2cfa586ef..345eb7ab03 100644 --- a/deal.II/lac/include/lac/petsc_parallel_sparse_matrix.h +++ b/deal.II/lac/include/lac/petsc_parallel_sparse_matrix.h @@ -46,7 +46,7 @@ namespace PETScWrappers * class. These comments apply here as well. * * - * @section Partitioning Partitioning of matrices + *

Partitioning of matrices

* * PETSc partitions parallel matrices so that each MPI process "owns" a * certain number of rows (i.e. only this process stores the respective diff --git a/deal.II/lac/include/lac/petsc_parallel_vector.h b/deal.II/lac/include/lac/petsc_parallel_vector.h index 23e8cb6bc7..be845b4941 100644 --- a/deal.II/lac/include/lac/petsc_parallel_vector.h +++ b/deal.II/lac/include/lac/petsc_parallel_vector.h @@ -53,7 +53,7 @@ namespace PETScWrappers * functions). Only the functions creating a vector of specific type differ, * and are implemented in this particular class. * - * @section PETScParVec1 Parallel communication model + *

Parallel communication model

* * The parallel functionality of PETSc is built on top of the Message Passing * Interface (MPI). MPI's communication model is built on collective @@ -79,7 +79,7 @@ namespace PETScWrappers * discussed below. * * - * @section PETScParVec2 Accessing individual elements of a vector + *

Accessing individual elements of a vector

* * PETSc does allow read access to individual elements of a vector, but in the * distributed case only to elements that are stored locally. We implement diff --git a/deal.II/lac/include/lac/precondition.h b/deal.II/lac/include/lac/precondition.h index f415959aef..a8985f4390 100644 --- a/deal.II/lac/include/lac/precondition.h +++ b/deal.II/lac/include/lac/precondition.h @@ -185,8 +185,6 @@ class PreconditionRichardson : public Subscriptor * It seems that all builtin preconditioners have a relaxation * parameter, so please use PreconditionRelaxation for these. * - * @section PrecUMU Usage - * * You will usually not want to create a named object of this type, * although possible. The most common use is like this: * @code @@ -322,8 +320,6 @@ class PreconditionRelaxation : public Subscriptor * MATRIX class used is required to have a function * precondition_Jacobi(VECTOR&, const VECTOR&, double) * - * @section PrecJU Usage - * * @code * // Declare related objects * @@ -372,8 +368,6 @@ class PreconditionJacobi : public PreconditionRelaxation * precondition_SOR(VECTOR&, const VECTOR&, double) and * precondition_TSOR(VECTOR&, const VECTOR&, double). * - * - * @section PrexSORU Usage * @code * // Declare related objects * @@ -419,8 +413,6 @@ class PreconditionSOR : public PreconditionRelaxation * MATRIX class used is required to have a function * precondition_SSOR(VECTOR&, const VECTOR&, double) * - * - * @section PrexSSORU Usage * @code * // Declare related objects * @@ -469,8 +461,6 @@ class PreconditionSSOR : public PreconditionRelaxation * PSOR(VECTOR&, const VECTOR&, double) and * TPSOR(VECTOR&, const VECTOR&, double). * - * - * @section PrecPSORU Usage * @code * // Declare related objects * @@ -560,8 +550,6 @@ class PreconditionPSOR : public PreconditionRelaxation * Usually, the use of ReductionControl is preferred over the use of * the basic SolverControl in defining this solver. * - * @section PrecItU Usage - * * Krylov space methods like SolverCG or SolverBicgstab * become inefficient if soution down to machine accuracy is * needed. This is due to the fact, that round-off errors spoil the diff --git a/deal.II/lac/include/lac/sparse_direct.h b/deal.II/lac/include/lac/sparse_direct.h index 4c1f2f83a2..142ef61b1c 100644 --- a/deal.II/lac/include/lac/sparse_direct.h +++ b/deal.II/lac/include/lac/sparse_direct.h @@ -47,7 +47,7 @@ * the configure script is looking for and how to provide it. * * - * @section SPDMA1 Interface and Method + *

Interface and Method

* * For the meaning of the three functions initialize(), factorize(), * and solve(), as well as for the method used in MA27, please see the @@ -62,7 +62,7 @@ * which is significantly less costly than the decomposition process. * * - * @section SPDMA2 Parameters to the constructor + *

Parameters to the constructor

* * The constructor of this class takes several arguments. The meaning * is the following: the MA27 functions require the user to allocate @@ -101,9 +101,9 @@ * indicated value is far too small and can not be relied upon. * * - * @section SPDMA3 Note on parallelization + *

Note on parallelization

* - * @subsection SPDMA4 Synchronisation + *

Synchronisation

* * Due to the use of global variables through COMMON blocks, the calls * to the sparse direct solver routines are not multithreading-safe, @@ -125,7 +125,7 @@ * Since such cross-function synchronisation can only be performed * from outside, it is left to the user of this class to do so. * - * @subsection SPDMA5 Detached mode + *

Detached mode

* * As an alternative, you can call the function set_detached_mode() * right after calling the constructor. This lets the program fork, so @@ -160,7 +160,7 @@ * you probably wanted. * * - * @subsection SPDMA6 Internals of the detached mode + *
Internals of the detached mode
* * The program that actually runs the detached solver is called * detached_ma27, and will show up under this name in the process @@ -619,7 +619,7 @@ class SparseDirectMA27 : public Subscriptor * the configure script is looking for and how to provide it. * * - * @section SPDMA47a Interface and Method + *

Interface and Method

* * For the meaning of the three functions initialize(), factorize(), * and solve(), as well as for the method used in MA47, please see the @@ -634,14 +634,14 @@ class SparseDirectMA27 : public Subscriptor * which is significantly less costly than the decomposition process. * * - * @section SPDMA47b Parameters to the constructor + *

Parameters to the constructor

* * The constructor of this class takes several arguments. Their * meaning is equivalent to those of the constructor of the * SparseDirectMA27 class; see there for more information. * * - * @section SPDMA47c Note on parallelization + *

Note on parallelization

* * Due to the use of global variables through COMMON blocks, the calls * to the sparse direct solver routines is not multithreading-capable, -- 2.39.5