From 053d82efc63b41f9954a16b576f4463a4cdccf52 Mon Sep 17 00:00:00 2001 From: bangerth Date: Fri, 2 Apr 2010 13:09:20 +0000 Subject: [PATCH] Link all relevant classes to a glossary entry. git-svn-id: https://svn.dealii.org/trunk@20934 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/lac/include/lac/block_indices.h | 1 + deal.II/lac/include/lac/block_matrix.h | 3 ++- deal.II/lac/include/lac/block_matrix_array.h | 7 ++++--- deal.II/lac/include/lac/block_matrix_base.h | 4 +++- deal.II/lac/include/lac/block_sparse_matrix.h | 3 ++- deal.II/lac/include/lac/block_sparse_matrix_ez.h | 3 ++- deal.II/lac/include/lac/block_sparsity_pattern.h | 3 ++- deal.II/lac/include/lac/block_vector.h | 3 ++- deal.II/lac/include/lac/block_vector_base.h | 3 ++- deal.II/lac/include/lac/matrix_block.h | 1 + deal.II/lac/include/lac/petsc_block_sparse_matrix.h | 3 ++- deal.II/lac/include/lac/petsc_block_vector.h | 3 ++- .../lac/include/lac/petsc_parallel_block_sparse_matrix.h | 3 ++- deal.II/lac/include/lac/petsc_parallel_block_vector.h | 1 + deal.II/lac/include/lac/precondition_block.h | 3 ++- deal.II/lac/include/lac/schur_matrix.h | 3 ++- deal.II/lac/include/lac/trilinos_block_sparse_matrix.h | 3 ++- deal.II/lac/include/lac/trilinos_block_vector.h | 4 +++- 18 files changed, 37 insertions(+), 17 deletions(-) diff --git a/deal.II/lac/include/lac/block_indices.h b/deal.II/lac/include/lac/block_indices.h index 0ee28c3227..e64fa20fc4 100644 --- a/deal.II/lac/include/lac/block_indices.h +++ b/deal.II/lac/include/lac/block_indices.h @@ -31,6 +31,7 @@ DEAL_II_NAMESPACE_OPEN * translate global row and column indices to local ones. * * @ingroup data + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Wolfgang Bangerth, Guido Kanschat, 2000, 2007 */ class BlockIndices : public Subscriptor diff --git a/deal.II/lac/include/lac/block_matrix.h b/deal.II/lac/include/lac/block_matrix.h index 26c9311c8f..0f145b7d5c 100644 --- a/deal.II/lac/include/lac/block_matrix.h +++ b/deal.II/lac/include/lac/block_matrix.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2009 by the deal.II authors +// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2009, 2010 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -36,6 +36,7 @@ DEAL_II_NAMESPACE_OPEN * apply the @p vmult of the original matrix (or preconditioner) to a * block vector. * + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Guido Kanschat, 2000 */ template diff --git a/deal.II/lac/include/lac/block_matrix_array.h b/deal.II/lac/include/lac/block_matrix_array.h index 92faba0d20..93897ba884 100644 --- a/deal.II/lac/include/lac/block_matrix_array.h +++ b/deal.II/lac/include/lac/block_matrix_array.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by the deal.II authors +// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -91,7 +91,7 @@ template class Vector; * GrowingVectorMemory type, since it remembers the vector and avoids * reallocating. * - * @ line Growing + * @line Growing * * Now, we are ready to build a 2x2 BlockMatrixArray. * @line Block @@ -116,7 +116,8 @@ template class Vector; * and is described in the documentation of * BlockTrianglePrecondition. * - * @author Guido Kanschat, 2000 - 2005 + * @see @ref GlossBlockLA "Block (linear algebra)" + * @author Guido Kanschat, 2000-2005 */ template class BlockMatrixArray : public Subscriptor diff --git a/deal.II/lac/include/lac/block_matrix_base.h b/deal.II/lac/include/lac/block_matrix_base.h index 500a12caad..d336d1d94c 100644 --- a/deal.II/lac/include/lac/block_matrix_base.h +++ b/deal.II/lac/include/lac/block_matrix_base.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 by the deal.II authors +// Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -46,6 +46,7 @@ template class BlockSparseMatrixEZ; * want to do things differently depending on whether a template type * denotes a regular or a block matrix type. * + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Wolfgang Bangerth, 2009 */ template @@ -428,6 +429,7 @@ namespace BlockMatrixIterators * @; others can be generated in application programs (see the * section on @ref Instantiations in the manual). * + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Wolfgang Bangerth, 2000, 2004 */ template diff --git a/deal.II/lac/include/lac/block_sparse_matrix.h b/deal.II/lac/include/lac/block_sparse_matrix.h index 205441ecf9..e6b48e9773 100644 --- a/deal.II/lac/include/lac/block_sparse_matrix.h +++ b/deal.II/lac/include/lac/block_sparse_matrix.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 by the deal.II authors +// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009, 2010 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -39,6 +39,7 @@ DEAL_II_NAMESPACE_OPEN * the calls to the individual blocks to the functions implemented in the base * class. See there also for a description of when this class is useful. * + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Wolfgang Bangerth, 2000, 2004 */ template diff --git a/deal.II/lac/include/lac/block_sparse_matrix_ez.h b/deal.II/lac/include/lac/block_sparse_matrix_ez.h index 8b79671dd5..66e32f39b2 100644 --- a/deal.II/lac/include/lac/block_sparse_matrix_ez.h +++ b/deal.II/lac/include/lac/block_sparse_matrix_ez.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2002, 2003, 2004, 2005, 2006, 2009 by the deal.II authors +// Copyright (C) 2002, 2003, 2004, 2005, 2006, 2009, 2010 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -41,6 +41,7 @@ template class BlockVector; * are functions for the multiplication with BlockVector and * access to the individual blocks. * + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Guido Kanschat, 2002, 2003 */ template diff --git a/deal.II/lac/include/lac/block_sparsity_pattern.h b/deal.II/lac/include/lac/block_sparsity_pattern.h index d6fc3eb329..4967802bc9 100644 --- a/deal.II/lac/include/lac/block_sparsity_pattern.h +++ b/deal.II/lac/include/lac/block_sparsity_pattern.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by the deal.II authors +// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -73,6 +73,7 @@ namespace TrilinosWrappers * You will in general not want to use this class, but one of the * derived classes. * + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Wolfgang Bangerth, 2000, 2001 */ template diff --git a/deal.II/lac/include/lac/block_vector.h b/deal.II/lac/include/lac/block_vector.h index 376b57d8dc..08cb7a4445 100644 --- a/deal.II/lac/include/lac/block_vector.h +++ b/deal.II/lac/include/lac/block_vector.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by the deal.II authors +// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -50,6 +50,7 @@ namespace TrilinosWrappers * @; others can be generated in application programs (see the * section on @ref Instantiations in the manual). * + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Wolfgang Bangerth, Guido Kanschat, 1999, 2000, 2001, 2002, 2004 */ template diff --git a/deal.II/lac/include/lac/block_vector_base.h b/deal.II/lac/include/lac/block_vector_base.h index b979a7bea9..c6a50e180d 100644 --- a/deal.II/lac/include/lac/block_vector_base.h +++ b/deal.II/lac/include/lac/block_vector_base.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2004, 2005, 2006, 2007 by the deal.II authors +// Copyright (C) 2004, 2005, 2006, 2007, 2010 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -649,6 +649,7 @@ namespace internal * debug version does not check consistency here for performance * reasons! * + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Wolfgang Bangerth, Guido Kanschat, 1999, 2000, 2001, 2002, 2004 */ template diff --git a/deal.II/lac/include/lac/matrix_block.h b/deal.II/lac/include/lac/matrix_block.h index b1e400bd9e..504110d061 100644 --- a/deal.II/lac/include/lac/matrix_block.h +++ b/deal.II/lac/include/lac/matrix_block.h @@ -73,6 +73,7 @@ DEAL_II_NAMESPACE_OPEN * * @ingroup Matrix2 * @ingroup vector_valued + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Guido Kanschat, 2006 */ template diff --git a/deal.II/lac/include/lac/petsc_block_sparse_matrix.h b/deal.II/lac/include/lac/petsc_block_sparse_matrix.h index 03c93e15c1..37fcb88a6e 100644 --- a/deal.II/lac/include/lac/petsc_block_sparse_matrix.h +++ b/deal.II/lac/include/lac/petsc_block_sparse_matrix.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2004, 2005, 2006, 2007 by the deal.II authors +// Copyright (C) 2004, 2005, 2006, 2007, 2010 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -56,6 +56,7 @@ namespace PETScWrappers * the same reason as is documented with the BlockSparsityPattern class. * * @ingroup Matrix1 + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Wolfgang Bangerth, 2004 */ class BlockSparseMatrix : public BlockMatrixBase diff --git a/deal.II/lac/include/lac/petsc_block_vector.h b/deal.II/lac/include/lac/petsc_block_vector.h index aefdfd7fae..00eead5743 100644 --- a/deal.II/lac/include/lac/petsc_block_vector.h +++ b/deal.II/lac/include/lac/petsc_block_vector.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2004, 2005, 2006, 2007 by the deal.II authors +// Copyright (C) 2004, 2005, 2006, 2007, 2010 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -41,6 +41,7 @@ namespace PETScWrappers * that are specific to the underlying vector type. * * @ingroup Vectors + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Wolfgang Bangerth, 2004 */ class BlockVector : public BlockVectorBase diff --git a/deal.II/lac/include/lac/petsc_parallel_block_sparse_matrix.h b/deal.II/lac/include/lac/petsc_parallel_block_sparse_matrix.h index 8553f6f43e..27576696dc 100644 --- a/deal.II/lac/include/lac/petsc_parallel_block_sparse_matrix.h +++ b/deal.II/lac/include/lac/petsc_parallel_block_sparse_matrix.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2004, 2005, 2006, 2007 by the deal.II authors +// Copyright (C) 2004, 2005, 2006, 2007, 2010 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -57,6 +57,7 @@ namespace PETScWrappers * the same reason as is documented with the BlockSparsityPattern class. * * @ingroup Matrix1 + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Wolfgang Bangerth, 2004 */ class BlockSparseMatrix : public BlockMatrixBase diff --git a/deal.II/lac/include/lac/petsc_parallel_block_vector.h b/deal.II/lac/include/lac/petsc_parallel_block_vector.h index 162294450f..4a33730ed6 100644 --- a/deal.II/lac/include/lac/petsc_parallel_block_vector.h +++ b/deal.II/lac/include/lac/petsc_parallel_block_vector.h @@ -52,6 +52,7 @@ namespace PETScWrappers * of these blocks to be stored on the local process. * * @ingroup Vectors + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Wolfgang Bangerth, 2004 */ class BlockVector : public BlockVectorBase diff --git a/deal.II/lac/include/lac/precondition_block.h b/deal.II/lac/include/lac/precondition_block.h index 2c7d464a77..b00e602e53 100644 --- a/deal.II/lac/include/lac/precondition_block.h +++ b/deal.II/lac/include/lac/precondition_block.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by the deal.II authors +// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -71,6 +71,7 @@ class PreconditionBlockJacobi; * example, number==double, inverse_type=float might be a viable * choice. * + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Ralf Hartmann, Guido Kanschat, 1999, 2000 */ template diff --git a/deal.II/lac/include/lac/schur_matrix.h b/deal.II/lac/include/lac/schur_matrix.h index 10bb351867..448d260afa 100644 --- a/deal.II/lac/include/lac/schur_matrix.h +++ b/deal.II/lac/include/lac/schur_matrix.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2009 by the deal.II authors +// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2009, 2010 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -87,6 +87,7 @@ DEAL_II_NAMESPACE_OPEN * schur.postprocess (u, p); * @endverbatim * + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Guido Kanschat, 2000, 2001, 2002 */ template diff --git a/deal.II/lac/include/lac/trilinos_block_sparse_matrix.h b/deal.II/lac/include/lac/trilinos_block_sparse_matrix.h index 7dadd219e3..ee2c8ce154 100644 --- a/deal.II/lac/include/lac/trilinos_block_sparse_matrix.h +++ b/deal.II/lac/include/lac/trilinos_block_sparse_matrix.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2008 by the deal.II authors +// Copyright (C) 2008, 2010 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -65,6 +65,7 @@ namespace TrilinosWrappers * the same reason as is documented with the BlockSparsityPattern class. * * @ingroup Matrix1 + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Martin Kronbichler, Wolfgang Bangerth, 2008 */ class BlockSparseMatrix : public BlockMatrixBase diff --git a/deal.II/lac/include/lac/trilinos_block_vector.h b/deal.II/lac/include/lac/trilinos_block_vector.h index 0b7e7bf068..78defaef6d 100644 --- a/deal.II/lac/include/lac/trilinos_block_vector.h +++ b/deal.II/lac/include/lac/trilinos_block_vector.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2008, 2009 by the deal.II authors +// Copyright (C) 2008, 2009, 2010 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -62,6 +62,7 @@ namespace TrilinosWrappers * * @ingroup Vectors * @ingroup TrilinosWrappers + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Martin Kronbichler, Wolfgang Bangerth, 2008, 2009 */ class BlockVector : public BlockVectorBase @@ -517,6 +518,7 @@ namespace TrilinosWrappers * * @ingroup Vectors * @ingroup TrilinosWrappers + * @see @ref GlossBlockLA "Block (linear algebra)" * @author Martin Kronbichler, 2008 */ class BlockVector : public BlockVectorBase -- 2.39.5