]> https://gitweb.dealii.org/ - dealii.git/commitdiff
@section etc. removed
authorGuido Kanschat <dr.guido.kanschat@gmail.com>
Sun, 24 Jul 2005 21:16:19 +0000 (21:16 +0000)
committerGuido Kanschat <dr.guido.kanschat@gmail.com>
Sun, 24 Jul 2005 21:16:19 +0000 (21:16 +0000)
git-svn-id: https://svn.dealii.org/trunk@11188 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/block_matrix_base.h
deal.II/lac/include/lac/block_vector_base.h
deal.II/lac/include/lac/petsc_parallel_sparse_matrix.h
deal.II/lac/include/lac/petsc_parallel_vector.h
deal.II/lac/include/lac/precondition.h
deal.II/lac/include/lac/sparse_direct.h

index 7eb6ec1c08a6673b560fb6e2e16b8a1023dbcf87..9b77f141f744cb27ee3bb267a15d887fb6151955 100644 (file)
@@ -248,7 +248,7 @@ namespace internal
  * individual blocks.
  *
  * 
- * @section Inheritance Inheriting from this class
+ * <h3>Inheriting from this class</h3>
  *
  * Since this class simply forwards its calls to the subobjects (if necessary
  * after adjusting indices denoting which subobject is meant), this class is
index 21816545c1c37017966fd400f0c109edc3cb4762..61fc3fdcab6544a4f577e313af6efb1b83c65065 100644 (file)
@@ -634,7 +634,7 @@ namespace internal
  * type the block vector is built on.
  * 
  *
- * @section BlockVectorAccess Accessing individual blocks, and resizing vectors
+ * <h3>Accessing individual blocks, and resizing vectors</h3>
  *
  * Apart from using this object as a whole, you can use each block
  * separately as a vector, using the block() function.  There
index d2cfa586ef5a053b8d1f3a83db4e53934eeed096..345eb7ab037544545ae5f9f5af63de1f4b557802 100644 (file)
@@ -46,7 +46,7 @@ namespace PETScWrappers
  * class. These comments apply here as well.
  *
  *
- * @section Partitioning Partitioning of matrices
+ * <h3>Partitioning of matrices</h3>
  *
  * PETSc partitions parallel matrices so that each MPI process "owns" a
  * certain number of rows (i.e. only this process stores the respective
index 23e8cb6bc73721f0ce7b4ce9f9348962787dfc2f..be845b49413f39d00b2aff2441ff43e80ccb45b2 100644 (file)
@@ -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
+ * <h3>Parallel communication model</h3>
  *
  * 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
+ * <h3>Accessing individual elements of a vector</h3>
  *
  * 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
index f415959aefffb299bb3bdb0739eb80d85fab6f09..a8985f43909c0f0de71631617fc7a0eedc5516e1 100644 (file)
@@ -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
  * <tt>MATRIX</tt> class used is required to have a function
  * <tt>precondition_Jacobi(VECTOR&, const VECTOR&, double</tt>)
  *
- * @section PrecJU Usage
- *
  * @code
  *     // Declare related objects
  *
@@ -372,8 +368,6 @@ class PreconditionJacobi : public PreconditionRelaxation<MATRIX>
  * <tt>precondition_SOR(VECTOR&, const VECTOR&, double)</tt> and
  * <tt>precondition_TSOR(VECTOR&, const VECTOR&, double)</tt>.
  *
- *
- * @section PrexSORU Usage
  * @code
  *     // Declare related objects
  *
@@ -419,8 +413,6 @@ class PreconditionSOR : public PreconditionRelaxation<MATRIX>
  * <tt>MATRIX</tt> class used is required to have a function
  * <tt>precondition_SSOR(VECTOR&, const VECTOR&, double)</tt>
  *
- *
- * @section PrexSSORU Usage
  * @code
  *     // Declare related objects
  *
@@ -469,8 +461,6 @@ class PreconditionSSOR : public PreconditionRelaxation<MATRIX>
  * <tt>PSOR(VECTOR&, const VECTOR&, double)</tt> and
  * <tt>TPSOR(VECTOR&, const VECTOR&, double)</tt>.
  *
- *
- * @section PrecPSORU Usage
  * @code
  *     // Declare related objects
  *
@@ -560,8 +550,6 @@ class PreconditionPSOR : public PreconditionRelaxation<MATRIX>
  * 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
index 4c1f2f83a2f0e33640df70b477f4d7b86f97052d..142ef61b1c66b0e2c8036ae4f5b4583b4cbd4f96 100644 (file)
@@ -47,7 +47,7 @@
  * the configure script is looking for and how to provide it.
  *
  *
- * @section SPDMA1 Interface and Method
+ * <h3>Interface and Method</h3>
  *
  * 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
+ * <h3>Parameters to the constructor</h3>
  *
  * The constructor of this class takes several arguments. The meaning
  * is the following: the MA27 functions require the user to allocate
  * indicated value is far too small and can not be relied upon.
  *
  *
- * @section SPDMA3 Note on parallelization
+ * <h3>Note on parallelization</h3>
  *
- * @subsection SPDMA4 Synchronisation
+ * <h4>Synchronisation</h4>
  * 
  * Due to the use of global variables through COMMON blocks, the calls
  * to the sparse direct solver routines are not multithreading-safe,
  * 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
+ * <h4>Detached mode</h4>
  *
  * As an alternative, you can call the function set_detached_mode()
  * right after calling the constructor. This lets the program fork, so
  * you probably wanted.
  *
  * 
- * @subsection SPDMA6 Internals of the detached mode
+ * <h5>Internals of the detached mode</h5>
  *
  * The program that actually runs the detached solver is called
  * <tt>detached_ma27</tt>, 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
+ * <h3>Interface and Method</h3>
  *
  * 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
+ * <h3>Parameters to the constructor</h3>
  *
  * 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
+ * <h3>Note on parallelization</h3>
  *
  * Due to the use of global variables through COMMON blocks, the calls
  * to the sparse direct solver routines is not multithreading-capable,

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.