From 4f4f47ce858a84f6090666e07b4bf478bac6c702 Mon Sep 17 00:00:00 2001
From: Thomas Fischer <thomas.fischer@ufz.de>
Date: Thu, 11 Oct 2012 09:37:11 +0200
Subject: [PATCH] added documentation
---
MeshLib/Elements/Element.cpp | 5 -----
MeshLib/Elements/Element.h | 9 ++++++++-
2 files changed, 8 insertions(+), 6 deletions(-)
diff --git a/MeshLib/Elements/Element.cpp b/MeshLib/Elements/Element.cpp
index e19affcec61..87679ffe4bb 100644
--- a/MeshLib/Elements/Element.cpp
+++ b/MeshLib/Elements/Element.cpp
@@ -18,11 +18,6 @@
namespace MeshLib {
-/*
-Element::Element(Node** nodes, MshElemType::type type, unsigned value)
-{
-}
-*/
Element::Element(unsigned value)
: _nodes(NULL), _value(value), _neighbors(NULL)
{
diff --git a/MeshLib/Elements/Element.h b/MeshLib/Elements/Element.h
index 56fc9d62868..fc68abb83b6 100644
--- a/MeshLib/Elements/Element.h
+++ b/MeshLib/Elements/Element.h
@@ -124,7 +124,11 @@ public:
*/
virtual FEMElemType::type getFEMType() const = 0;
- /// Get the value for this element.
+ /**
+ * Get the value for this element. The value can be used to store a link
+ * to external information (for instance an index of a field) like material groups.
+ * @return
+ */
unsigned getValue() const { return _value; };
/// Returns true if elem is a neighbour of this element and false otherwise.
@@ -172,6 +176,9 @@ protected:
Node** _nodes;
+ /**
+ * this is an index for external additional information like materials
+ */
unsigned _value;
Element** _neighbors;
--
GitLab