From ee615ae3166cf45398e2044bfb3430850fbfeb5f Mon Sep 17 00:00:00 2001
From: Elias Pipping <elias.pipping@fu-berlin.de>
Date: Sun, 29 Jul 2012 16:34:27 +0200
Subject: [PATCH] Comments

---
 dune/tectonic/samplefunctional.hh | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/dune/tectonic/samplefunctional.hh b/dune/tectonic/samplefunctional.hh
index 04d09779..ea9dfceb 100644
--- a/dune/tectonic/samplefunctional.hh
+++ b/dune/tectonic/samplefunctional.hh
@@ -31,6 +31,7 @@ template <int dim> class SampleFunctional {
     return y * v + (*phi)(v); // <1/2 Av - b,v> + H(|v|)
   }
 
+  // returns false if the direction is tangential
   bool descentDirection(SmallVector const x, SmallVector &ret) const {
     // Check the squared norm rather than each component because
     // complementaryProjection() divides by it
@@ -91,7 +92,9 @@ template <int dim> class SampleFunctional {
   SmallMatrix const &A;
   SmallVector const &b;
   shared_ptr<NonlinearityType const> const phi;
-  int const ignore;
+  int const ignore; // Dimension that should be ignored; goes from 0
+                    // to dim-1; the special value dim means that no
+                    // dimension should be ignored
 
 private:
   // Gradient of the smooth part
-- 
GitLab