From 013d8bd38aad7b3130fb780d37879b331cb17587 Mon Sep 17 00:00:00 2001
From: Wenqing Wang <wenqing.wang@ufz.de>
Date: Tue, 18 May 2021 12:30:08 +0200
Subject: [PATCH] [MeshLib] Added a description of getElementRotationMatrices
---
MeshLib/Utils/GetElementRotationMatrices.h | 14 +++++++++++++-
1 file changed, 13 insertions(+), 1 deletion(-)
diff --git a/MeshLib/Utils/GetElementRotationMatrices.h b/MeshLib/Utils/GetElementRotationMatrices.h
index e09be8c695b..dd16d82ca53 100644
--- a/MeshLib/Utils/GetElementRotationMatrices.h
+++ b/MeshLib/Utils/GetElementRotationMatrices.h
@@ -17,7 +17,19 @@
namespace MeshLib
{
class Element;
-
+/**
+ * \brief Element rotation matrix computation
+ *
+ * This function returns a vector containing the rotation matrices of given
+ * elements. The rotation matrix of an element is used to map the
+ * local vector to the global coordinate system. If an element is not inclined,
+ * the identity matrix is used as its rotation matrix.
+ *
+ * @param space_dimension The space dimension.
+ * @param mesh_dimension The mesh dimension.
+ * @param elements The mesh elements.
+ * @return A vector of rotation matrices of given elements.
+ */
std::vector<Eigen::MatrixXd> getElementRotationMatrices(
int const space_dimension, int const mesh_dimension,
std::vector<Element*> const& elements);
--
GitLab