From d8d08a6d139b3874729e9963861b7f117cbb1233 Mon Sep 17 00:00:00 2001
From: Maximilian Reininghaus <maximilian.reininghaus@tu-dortmund.de>
Date: Mon, 11 Mar 2019 20:39:15 -0300
Subject: [PATCH] documentation
---
Environment/SlidingPlanarExponential.h | 16 ++++++++++++----
1 file changed, 12 insertions(+), 4 deletions(-)
diff --git a/Environment/SlidingPlanarExponential.h b/Environment/SlidingPlanarExponential.h
index 573d2de7e..73b3b2e7d 100644
--- a/Environment/SlidingPlanarExponential.h
+++ b/Environment/SlidingPlanarExponential.h
@@ -24,12 +24,20 @@
#include <cassert>
#include <limits>
-/**
- *
- */
-
namespace corsika::environment {
+ // clang-format off
+ /**
+ * The SlidingPlanarExponential models mass density as
+ * \f[
+ * \varrho(r) = \varrho_0 \exp\left( \frac{|p_0 - r|}{\lambda} \right).
+ * \f]
+ * For grammage/length conversion, the density distribution is approximated as
+ * locally flat at the starting point \f$ r_0 \f$ of the trajectory with the axis pointing
+ * from \f$ p_0 \f$ to \f$ r_0 \f$.
+ */
+ //clang-format on
+
template <class T>
class SlidingPlanarExponential : public BaseExponential<SlidingPlanarExponential<T>>,
public T {
--
GitLab