From 9e1edcecbda56db0c0b8f1b353a72981d47448b9 Mon Sep 17 00:00:00 2001
From: Maximilian Reininghaus <maximilian.reininghaus@tu-dortmund.de>
Date: Mon, 11 Mar 2019 23:57:23 -0300
Subject: [PATCH] documentation for FlatExponential
---
Environment/FlatExponential.h | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/Environment/FlatExponential.h b/Environment/FlatExponential.h
index 7f294bebd..ef8cdc9a3 100644
--- a/Environment/FlatExponential.h
+++ b/Environment/FlatExponential.h
@@ -20,7 +20,18 @@
#include <corsika/units/PhysicalUnits.h>
namespace corsika::environment {
-
+
+ //clang-format off
+ /**
+ * flat exponential density distribution with
+ * \f[
+ * \varrho(r) = \varrho_0 \exp\left( \frac{1}{\lambda} (r - p) \cdot
+ * \vec{a} \right).
+ * \f]
+ * \f$ \vec{a} \f$ denotes the axis and should be normalized to avoid degeneracy
+ * with the scale parameter \f$ \lambda \f$.
+ */
+ //clang-format on
template <class T>
class FlatExponential : public BaseExponential<FlatExponential<T>>, public T {
geometry::Vector<units::si::dimensionless_d> const fAxis;
--
GitLab