[cig-commits] [commit] master: Add to the documentation. (ce4b00c)

[cig_noreply at geodynamics.org]

Repository : https://github.com/geodynamics/aspect

On branch  : master
Link       : https://github.com/geodynamics/aspect/compare/58a3ca45d49c7d331fa02d1fce0b2a74705241eb...7c9b74ed7f6e149b86519d3abf0c555383cba169

>---------------------------------------------------------------

commit ce4b00c12e530b44b99a4c10e064c8f4bbe1c48e
Author: Wolfgang Bangerth <bangerth at math.tamu.edu>
Date:   Wed May 21 15:13:41 2014 -0500

    Add to the documentation.


>---------------------------------------------------------------

ce4b00c12e530b44b99a4c10e064c8f4bbe1c48e
 include/aspect/simulator.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/include/aspect/simulator.h b/include/aspect/simulator.h
index f7865dd..8b6f81f 100644
--- a/include/aspect/simulator.h
+++ b/include/aspect/simulator.h
@@ -1253,6 +1253,14 @@ namespace aspect
 
       DoFHandler<dim>                                           dof_handler;
 
+      /**
+       * Constraint objects. The first of these describes all constraints
+       * that are not time dependent (e.g., hanging nodes, no-normal-flux constraints),
+       * whereas the second one is initialized at the top of every time step by
+       * copying from the first and then adding to it constraints that are time
+       * dependent (e.g., time dependent velocity or temperature boundary
+       * conditions).
+       */
       ConstraintMatrix                                          constraints;
       ConstraintMatrix                                          current_constraints;