From: rapson Date: Thu, 9 Jul 2009 14:57:04 +0000 (+0000) Subject: Documented private members in point_value_history.h and added myself to authors list... X-Git-Tag: v8.0.0~7507 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a65666c631eecdb4b433f589357cdafbd1b773f1;p=dealii.git Documented private members in point_value_history.h and added myself to authors list in authors.html git-svn-id: https://svn.dealii.org/trunk@19052 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/numerics/point_value_history.h b/deal.II/deal.II/include/numerics/point_value_history.h index 77a1b554b8..f005f61b80 100644 --- a/deal.II/deal.II/include/numerics/point_value_history.h +++ b/deal.II/deal.II/include/numerics/point_value_history.h @@ -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 dataset_key; @@ -491,7 +492,7 @@ class PointValueHistory /** * Saves data for each mnemonic entry. * data_store: mnemonic -> [component] - * [time_instance] + * [key] */ std::map > > 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 > > pair_data; + std::pair > > 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 > 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; }; diff --git a/deal.II/doc/authors.html b/deal.II/doc/authors.html index 4bb8ac75b1..e64c6cd42e 100644 --- a/deal.II/doc/authors.html +++ b/deal.II/doc/authors.html @@ -175,6 +175,9 @@ contact with them, send email to authors at dealii.org.
  • Toby D. Young: Interfaces to SLEPc and compatibility with PETSc 3.0. + +
  • Michael Rapson: + PointValueHistory class.