From 97dd5d36adab6b486fd299e2f542817b0f897eb6 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Sat, 14 Jan 2006 17:36:20 +0000 Subject: [PATCH] Add a 'numerical algorithms' module. git-svn-id: https://svn.dealii.org/trunk@12027 0785d39b-7218-0410-832d-ea1e28bc413d --- .../numerics/derivative_approximation.h | 1 + .../include/numerics/dof_print_solver_step.h | 4 ++-- .../deal.II/include/numerics/error_estimator.h | 3 ++- deal.II/deal.II/include/numerics/matrices.h | 4 +++- .../include/numerics/solution_transfer.h | 3 ++- deal.II/deal.II/include/numerics/vectors.h | 2 ++ .../doc/doxygen/headers/numerical_algorithms.h | 18 ++++++++++++++++++ 7 files changed, 30 insertions(+), 5 deletions(-) create mode 100644 deal.II/doc/doxygen/headers/numerical_algorithms.h diff --git a/deal.II/deal.II/include/numerics/derivative_approximation.h b/deal.II/deal.II/include/numerics/derivative_approximation.h index 8b7a4972ee..8057d719af 100644 --- a/deal.II/deal.II/include/numerics/derivative_approximation.h +++ b/deal.II/deal.II/include/numerics/derivative_approximation.h @@ -163,6 +163,7 @@ namespace hp * the appropriate analogues for the derivative that is to be * approximated. * + * @ingroup numerics * @author Wolfgang Bangerth, 2000 */ class DerivativeApproximation diff --git a/deal.II/deal.II/include/numerics/dof_print_solver_step.h b/deal.II/deal.II/include/numerics/dof_print_solver_step.h index 89aeb71067..12877ce0d6 100644 --- a/deal.II/deal.II/include/numerics/dof_print_solver_step.h +++ b/deal.II/deal.II/include/numerics/dof_print_solver_step.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005 by the deal.II authors +// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -48,7 +48,7 @@ * written as a finite element field using the DataOut class. * Please note that this class may produce enormous amounts of data! * - * @ingroup IO + * @ingroup output * @author Guido Kanschat, 2000 */ template > diff --git a/deal.II/deal.II/include/numerics/error_estimator.h b/deal.II/deal.II/include/numerics/error_estimator.h index 2c12d93ab2..5cf95ca20f 100644 --- a/deal.II/deal.II/include/numerics/error_estimator.h +++ b/deal.II/deal.II/include/numerics/error_estimator.h @@ -203,7 +203,8 @@ template class FESubfaceValues; * function that accepts several in- and output vectors at the same * time. * - * @author Wolfgang Bangerth, 1998, 1999, 2000; parallelization by Thomas Richter, 2000 + * @ingroup numerics + * @author Wolfgang Bangerth, 1998, 1999, 2000, 2004, 2006; parallelization by Thomas Richter, 2000 */ template class KellyErrorEstimator diff --git a/deal.II/deal.II/include/numerics/matrices.h b/deal.II/deal.II/include/numerics/matrices.h index c3e6a3db57..0923ac3eb9 100644 --- a/deal.II/deal.II/include/numerics/matrices.h +++ b/deal.II/deal.II/include/numerics/matrices.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 by the deal.II authors +// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -178,6 +178,7 @@ namespace PETScWrappers * latter may be useful if you want to create many right hand side * vectors. * + * @ingroup numerics * @author Wolfgang Bangerth, 1998, Ralf Hartmann, 2001 */ class MatrixCreator @@ -737,6 +738,7 @@ class MatrixCreator * there are no hanging nodes and even then doesn't always work fully * satisfactorily. * + * @ingroup numerics * @author Wolfgang Bangerth, 1998, 2000, 2004, 2005 */ class MatrixTools : public MatrixCreator diff --git a/deal.II/deal.II/include/numerics/solution_transfer.h b/deal.II/deal.II/include/numerics/solution_transfer.h index 1f316c5a64..b98dd1372a 100644 --- a/deal.II/deal.II/include/numerics/solution_transfer.h +++ b/deal.II/deal.II/include/numerics/solution_transfer.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005 by the deal.II authors +// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -200,6 +200,7 @@ * refine_interpolate(in, out)) only be called once. * * + * @ingroup numerics * @author Ralf Hartmann, 1999 */ template diff --git a/deal.II/deal.II/include/numerics/vectors.h b/deal.II/deal.II/include/numerics/vectors.h index 1a96b6665f..2a9e1fd5d7 100644 --- a/deal.II/deal.II/include/numerics/vectors.h +++ b/deal.II/deal.II/include/numerics/vectors.h @@ -297,6 +297,8 @@ class ConstraintMatrix; * pointer stored within the triangulation object is accessed. * * @ref Instantiations : some (Vector, Vector, BlockVector, BlockVector, see also individual functions) + * + * @ingroup numerics * @author Wolfgang Bangerth, Ralf Hartmann, Guido Kanschat, 1998, 1999, 2000, 2001 */ class VectorTools diff --git a/deal.II/doc/doxygen/headers/numerical_algorithms.h b/deal.II/doc/doxygen/headers/numerical_algorithms.h new file mode 100644 index 0000000000..5a3f665d29 --- /dev/null +++ b/deal.II/doc/doxygen/headers/numerical_algorithms.h @@ -0,0 +1,18 @@ +//------------------------------------------------------------------------- +// $Id$ +// Version: $Name$ +// +// Copyright (C) 2006 by the deal.II authors +// +// This file is subject to QPL and may not be distributed +// without copyright and license information. Please refer +// to the file deal.II/doc/license.html for the text and +// further information on this license. +// +//------------------------------------------------------------------------- + +/** + * @defgroup numerics Numerical algorithms + * + * + */ -- 2.39.5