From bbee8fc06f3da139b4b6240eaa70b6e1a6354285 Mon Sep 17 00:00:00 2001
From: Oliver Sander <sander@igpm.rwth-aachen.de>
Date: Fri, 13 Aug 2010 09:26:40 +0000
Subject: [PATCH] minor doc improvements
[[Imported from SVN: r6211]]
---
dune/gfe/localgeodesicfefunction.hh | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/dune/gfe/localgeodesicfefunction.hh b/dune/gfe/localgeodesicfefunction.hh
index 5f3e7063..3fd50524 100644
--- a/dune/gfe/localgeodesicfefunction.hh
+++ b/dune/gfe/localgeodesicfefunction.hh
@@ -11,7 +11,8 @@
#include <dune/gfe/svd.hh>
-/** \brief A geodesic function from the reference element to a manifold
+/** \brief A function defined by simplicial geodesic interpolation
+ from the reference element to a Riemannian manifold.
\tparam dim Dimension of the reference element
\tparam ctype Type used for coordinates on the reference element
@@ -37,7 +38,7 @@ public:
/** \brief Evaluate the derivative of the function */
Dune::FieldMatrix<ctype, EmbeddedTangentVector::size, dim> evaluateDerivative(const Dune::FieldVector<ctype, dim>& local);
- /** \brief Evaluate the derivative of the function using a finite-difference approximation*/
+ /** \brief For debugging: Evaluate the derivative of the function using a finite-difference approximation*/
Dune::FieldMatrix<ctype, EmbeddedTangentVector::size, dim> evaluateDerivativeFD(const Dune::FieldVector<ctype, dim>& local);
private:
--
GitLab