From 82f9568be2b534b1c2e01b115572f93994f83b01 Mon Sep 17 00:00:00 2001
From: Cristian C Lalescu <Cristian.Lalescu@ds.mpg.de>
Date: Thu, 16 Jan 2020 21:43:33 +0100
Subject: [PATCH] [doc] add comment
---
cpp/particles/particles_system_builder.hpp | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/cpp/particles/particles_system_builder.hpp b/cpp/particles/particles_system_builder.hpp
index 9cc8178e..40123abb 100644
--- a/cpp/particles/particles_system_builder.hpp
+++ b/cpp/particles/particles_system_builder.hpp
@@ -45,6 +45,13 @@
///
/// Double template "for"
///
+/// "Template_double_for_if" is used to systematically generate specialized
+/// templates for two ranges of template parameters.
+/// For the interpolation we have `n` and `m` that designate "number of
+/// neighbours" and "smoothness of interpolant".
+/// Calling Template_double_for_if is essentially equivalent to having a couple
+/// of nested "switch" statements, but without all the repetitive code lines.
+///
//////////////////////////////////////////////////////////////////////////////
namespace Template_double_for_if{
--
GitLab