From 6218f68bf3972a20931ae01e77cc80b15f0fa24e Mon Sep 17 00:00:00 2001
From: Christoph Lehmann <christoph.lehmann@ufz.de>
Date: Wed, 17 Aug 2016 12:13:49 +0200
Subject: [PATCH] [PL] added docu
---
ProcessLib/Parameter/SpatialPosition.h | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/ProcessLib/Parameter/SpatialPosition.h b/ProcessLib/Parameter/SpatialPosition.h
index fb5b2116ad0..fde9bf2f13e 100644
--- a/ProcessLib/Parameter/SpatialPosition.h
+++ b/ProcessLib/Parameter/SpatialPosition.h
@@ -15,6 +15,13 @@
namespace ProcessLib
{
+//! Represents a position in space which can be either one of
+//! a node, an element, an integration point or a cartesian coordinates triple.
+//!
+//! The setters of this class make sure that only compatible information can be
+//! stored at the same time; e.g., it is not possible to specify an element ID
+//! and a node ID at the same time (the setAll() method being an exception to
+//! that rule).
class SpatialPosition
{
public:
--
GitLab