]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Add documentation to PreconditionAMG::AdditionalData.
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 27 Mar 2013 20:07:09 +0000 (20:07 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 27 Mar 2013 20:07:09 +0000 (20:07 +0000)
git-svn-id: https://svn.dealii.org/trunk@29087 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/include/deal.II/lac/trilinos_precondition.h

index e958fc8e5eff3b02cbce7ca7a55671bbc30ab0be..173648e82746bcefd4cc228ac6f1146f4f91be28 100644 (file)
@@ -1,7 +1,7 @@
 //---------------------------------------------------------------------------
 //    $Id$
 //
-//    Copyright (C) 2008, 2010, 2012 by the deal.II authors
+//    Copyright (C) 2008, 2010, 2012, 2013 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -1275,6 +1275,12 @@ namespace TrilinosWrappers
   {
   public:
 
+    /**
+     * A data structure that is used to control details of how the algebraic
+     * multigrid is set up. The flags detailed in here are then passed to
+     * the Trilinos ML implementation. A structure of the current type are
+     * passed to the constructor of PreconditionAMG.
+     */
     struct AdditionalData
     {
       /**

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.