]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Documented private members in point_value_history.h and added myself to authors list...
authorrapson <rapson@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 9 Jul 2009 14:57:04 +0000 (14:57 +0000)
committerrapson <rapson@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 9 Jul 2009 14:57:04 +0000 (14:57 +0000)
git-svn-id: https://svn.dealii.org/trunk@19052 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/numerics/point_value_history.h
deal.II/doc/authors.html

index 77a1b554b8aa20d8af1c1af5db80ac80cadec786..f005f61b801bde1e5f629de1dcc899434d044ed4 100644 (file)
@@ -477,8 +477,9 @@ class PointValueHistory
 
   private:
                                     /**
-                                     * Commonly time, but possibly time step,
-                                     * iteration etc
+                                     * Stores keys, values on the abscissa. 
+                                      * This will often be time, but possibly 
+                                      * time step, iteration etc.
                                      */
     std::vector <double> dataset_key;
 
@@ -491,7 +492,7 @@ class PointValueHistory
                                     /**
                                      * Saves data for each mnemonic entry.
                                      * data_store: mnemonic -> [component]
-                                     * [time_instance]
+                                     * [key]
                                      */
     std::map <std::string, std::vector <std::vector <double> > > data_store;
 
@@ -503,29 +504,46 @@ class PointValueHistory
     point_geometry_data;
 
                                     /**
-                                     * Could possibly be removed, just used
-                                     * as the value to be added to
-                                     * data_store.
+                                     * A tempory pair used when adding to 
+                                      * @p data_store.
                                      */
-    std::pair<std::string, std::vector <std::vector <double> > > pair_data;
+    std::pair<std::string, std::vector <std::vector <double> > > pair_data; // could possibly be removed
     
+                                    /**
+                                     * Used to enforce @p closed state for some 
+                                     * methods.
+                                     */
     bool closed;
-
+                                    
+                                    /**
+                                     * Used to enforce @p !cleared state for 
+                                     * some methods.
+                                     */
     bool cleared; 
-
+    
+    
+                                    /**
+                                     * A smart pointer to the dof_handler 
+                                     * supplied to the constructor. This can be 
+                                     * released by calling @p clear().
+                                     */
     SmartPointer<const DoFHandler<dim> > dof_handler;
     
-                                    /*
+                                    /**
                                      * Variable to check that number of dofs
-                                     * in the dof_handler does not change. A
-                                     * cheap way to check that the
+                                     * in the dof_handler does not change.
+                                      */
+                                     /* A cheap way to check that the
                                      * triangulation has not been refined in
                                      * anyway since the class was set up.
                                      * Refinement will invalidate stored dof
                                      * indices linked to support points.
                                      */
     unsigned int n_dofs;
-    
+                                    /**
+                                     * Stores the number of independent 
+                                     * variables requested.
+                                     */
     unsigned int n_indep;
 
 };
index 4bb8ac75b1b7340f98b3c8ac97f3987db62ec40e..e64c6cd42eb3277f70feed8e5652f93867ebaadf 100644 (file)
@@ -175,6 +175,9 @@ contact with them, send email to <tt>authors</tt> at <tt>dealii.org</tt>.
 
 <li><em>Toby D. Young:</em>
     Interfaces to SLEPc and compatibility with PETSc 3.0.
+
+<li><em>Michael Rapson:</em>
+    PointValueHistory class.
 </ul>
 
 

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.