From facf614244c2d17a1acc69c144fc65d49cacef10 Mon Sep 17 00:00:00 2001
From: Cristian C Lalescu <Cristian.Lalescu@ds.mpg.de>
Date: Fri, 9 Aug 2019 14:26:29 +0200
Subject: [PATCH] add documentation
---
cpp/kspace.hpp | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/cpp/kspace.hpp b/cpp/kspace.hpp
index 0d36e9cc..ea82d54b 100644
--- a/cpp/kspace.hpp
+++ b/cpp/kspace.hpp
@@ -39,6 +39,17 @@
enum field_backend {FFTW};
enum kspace_dealias_type {TWO_THIRDS, SMOOTH};
+/** \brief A class for handling Fourier representation tasks.
+ *
+ * - contains wavenumber information (specific to each MPI process).
+ * This includes values of kx, ky, kz, including lowest modes dkx etc,
+ * as well as number of modes within sferical shells and mean wavenumber
+ * within shells.
+ * - has methods for spectrum computation and similar.
+ * - has methods for filtering.
+ * - has CLOOP methods, useful for computing arbitrary formulas over the
+ * Fourier space grid (i.e. use lambda expressions).
+ */
template <field_backend be,
kspace_dealias_type dt>
--
GitLab