From: bangerth Date: Thu, 6 Mar 2008 21:52:05 +0000 (+0000) Subject: Add some documentation. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9fde419c3b1db19be153201d42e79324897127de;p=dealii-svn.git Add some documentation. git-svn-id: https://svn.dealii.org/trunk@15866 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/dofs/dof_renumbering.h b/deal.II/deal.II/include/dofs/dof_renumbering.h index b72a0344b8..275115c012 100644 --- a/deal.II/deal.II/include/dofs/dof_renumbering.h +++ b/deal.II/deal.II/include/dofs/dof_renumbering.h @@ -201,14 +201,69 @@ DEAL_II_NAMESPACE_OPEN * standard library to do its work. * * + *

A comparison of reordering strategies

+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * @image html "reorder_sparsity_step_31_original.png" + * + * @image html "reorder_sparsity_step_31_random.png" + * + * @image html "reorder_sparsity_step_31_deal_cmk.png" + * + * @image html "reorder_sparsity_step_31_boost_cmk.png" + * + * @image html "reorder_sparsity_step_31_boost_king.png" + * + * @image html "reorder_sparsity_step_31_boost_md.png" + *
+ * Enumeration as produced by deal.II's DoFHandler::distribute_dofs function + * + * Random enumeration as produced by applying DoFRenumbering::random + * after calling DoFHandler::distribute_dofs. + * + * Cuthill-McKee enumeration as produced by calling the deal.II implementation + * of the algorithm provided by DoFRenumbering::Cuthill_McKee + * after DoFHandler::distribute_dofs. + * + * Cuthill-McKee enumeration as produced by calling the BOOST implementation + * of the algorithm provided by DoFRenumbering::boost::Cuthill_McKee + * after DoFHandler::distribute_dofs. + * + * King enumeration as produced by calling the BOOST implementation + * of the algorithm provided by DoFRenumbering::boost::king_ordering + * after DoFHandler::distribute_dofs. + * + * Minimum degree enumeration as produced by calling the BOOST implementation + * of the algorithm provided by DoFRenumbering::boost::minimum_degree + * after DoFHandler::distribute_dofs. + *
+ * + * *

Multigrid DoF numbering

* - * Most algorithms also work on multigrid degree of freedom + * Most of the algorithms listed above also work on multigrid degree of freedom * numberings. Refer to the actual function declarations to get more * information on this. * * @ingroup dofs - * @author Wolfgang Bangerth, Guido Kanschat, 1998, 1999, 2000, 2004, 2007 + * @author Wolfgang Bangerth, Guido Kanschat, 1998, 1999, 2000, 2004, 2007, 2008 */ class DoFRenumbering { @@ -242,6 +297,14 @@ class DoFRenumbering * documentation of the * parent class for details * on the different methods. + * + * As an example of the + * results of this algorithm, + * take a look at the + * comparison of various + * algorithms in the + * documentation of the + * DoFRenumbering namespace. */ template static void @@ -278,6 +341,14 @@ class DoFRenumbering * slightly (also by a few * percent) better * preconditioners. + * + * As an example of the + * results of this algorithm, + * take a look at the + * comparison of various + * algorithms in the + * documentation of the + * DoFRenumbering namespace. */ template static void @@ -304,15 +375,25 @@ class DoFRenumbering * freedom based on the BOOST * implementation of the * minimum degree - * algorithm. This often - * results in slightly larger - * (by a few percent) - * bandwidths than the + * algorithm. Unlike the * Cuthill-McKee algorithm, - * but sparse ILUs are often - * slightly (also by a few - * percent) better - * preconditioners. + * this algorithm does not + * attempt to minimize the + * bandwidth of a matrix but + * to minimize the amount of + * fill-in when doing an LU + * decomposition. It may + * sometimes yield better + * ILUs because of this + * property. + * + * As an example of the + * results of this algorithm, + * take a look at the + * comparison of various + * algorithms in the + * documentation of the + * DoFRenumbering namespace. */ template static void @@ -346,6 +427,13 @@ class DoFRenumbering * See the general documentation * of this class for details on * the different methods. + * + * As an example of the results + * of this algorithm, take a look + * at the comparison of various + * algorithms in the + * documentation of the + * DoFRenumbering namespace. */ template static void diff --git a/deal.II/doc/doxygen/images/reorder_sparsity_step_31_boost_cmk.png b/deal.II/doc/doxygen/images/reorder_sparsity_step_31_boost_cmk.png new file mode 100644 index 0000000000..f8f8642f58 Binary files /dev/null and b/deal.II/doc/doxygen/images/reorder_sparsity_step_31_boost_cmk.png differ diff --git a/deal.II/doc/doxygen/images/reorder_sparsity_step_31_boost_king.png b/deal.II/doc/doxygen/images/reorder_sparsity_step_31_boost_king.png new file mode 100644 index 0000000000..f652457fd1 Binary files /dev/null and b/deal.II/doc/doxygen/images/reorder_sparsity_step_31_boost_king.png differ diff --git a/deal.II/doc/doxygen/images/reorder_sparsity_step_31_boost_md.png b/deal.II/doc/doxygen/images/reorder_sparsity_step_31_boost_md.png new file mode 100644 index 0000000000..31fa1930c3 Binary files /dev/null and b/deal.II/doc/doxygen/images/reorder_sparsity_step_31_boost_md.png differ diff --git a/deal.II/doc/doxygen/images/reorder_sparsity_step_31_deal_cmk.png b/deal.II/doc/doxygen/images/reorder_sparsity_step_31_deal_cmk.png new file mode 100644 index 0000000000..fec1eb7cd5 Binary files /dev/null and b/deal.II/doc/doxygen/images/reorder_sparsity_step_31_deal_cmk.png differ diff --git a/deal.II/doc/doxygen/images/reorder_sparsity_step_31_original.png b/deal.II/doc/doxygen/images/reorder_sparsity_step_31_original.png new file mode 100644 index 0000000000..b38137b499 Binary files /dev/null and b/deal.II/doc/doxygen/images/reorder_sparsity_step_31_original.png differ diff --git a/deal.II/doc/doxygen/images/reorder_sparsity_step_31_random.png b/deal.II/doc/doxygen/images/reorder_sparsity_step_31_random.png new file mode 100644 index 0000000000..1f16ec0c05 Binary files /dev/null and b/deal.II/doc/doxygen/images/reorder_sparsity_step_31_random.png differ