From a5bea2101700223da083921f742b17a73dd96ad5 Mon Sep 17 00:00:00 2001 From: bangerth Date: Mon, 4 Jan 2010 15:25:57 +0000 Subject: [PATCH] Add documentation. git-svn-id: https://svn.dealii.org/trunk@20280 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/multigrid/mg_tools.h | 31 +++++++++++++++----- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/deal.II/deal.II/include/multigrid/mg_tools.h b/deal.II/deal.II/include/multigrid/mg_tools.h index c97ec97b87..ecd4c83b83 100644 --- a/deal.II/deal.II/include/multigrid/mg_tools.h +++ b/deal.II/deal.II/include/multigrid/mg_tools.h @@ -63,7 +63,7 @@ class MGTools const unsigned int level, std::vector& row_lengths, const DoFTools::Coupling flux_couplings = DoFTools::none); - + /** * Compute row length vector for * multilevel methods with @@ -83,7 +83,7 @@ class MGTools * Write the sparsity structure * of the matrix belonging to the * specified @p level. The sparsity pattern - * is not compressed, so before + * is not compressed, so before * creating the actual matrix * you have to compress the * matrix yourself, using @@ -202,7 +202,7 @@ class MGTools std::vector > &result, const bool only_once = false, std::vector target_component = std::vector()); - + /** * @deprecated Wrapper for the * other function with same name, @@ -251,7 +251,7 @@ class MGTools SparseMatrix& matrix, const bool preserve_symmetry, const bool ignore_zeros = false); - + template static void apply_boundary_values ( const std::set& boundary_dofs, @@ -299,7 +299,7 @@ class MGTools MGLevelObject > &v, const unsigned int selected, std::vector >& cached_sizes); - + /** * Adjust block vectors on all * levels to correct size. The @@ -313,7 +313,7 @@ class MGTools MGLevelObject > &v, const std::vector &selected, std::vector >& cached_sizes); - + /** * Adjust block-vectors on all * levels to correct size. Count @@ -346,7 +346,7 @@ class MGTools * as in * DoFRenumbering::component_wise. * - * + * */ template static void @@ -391,6 +391,23 @@ class MGTools std::vector >& cached_sizes); + /** + * For each level in a multigrid + * hierarchy, produce a boolean + * mask that indicates which of + * the degrees of freedom are + * along interfaces of this level + * to cells that only exist on + * coarser levels. The function + * returns the subset of these + * indices in the last argument + * that are not only on interior + * interfaces (i.e. between cells + * of a given level and adjacent + * coarser levels) but also on + * the external boundary of the + * domain. + */ template static void -- 2.39.5