From 7340d92ac310afd6c03b2a43f8717d9bf96ef897 Mon Sep 17 00:00:00 2001
From: Lukas Werner <lks.werner@fau.de>
Date: Tue, 27 Oct 2020 15:22:00 +0100
Subject: [PATCH] Improved description of SubCyclingManager
---
src/lbm_mesapd_coupling/utility/SubCyclingManager.h | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/src/lbm_mesapd_coupling/utility/SubCyclingManager.h b/src/lbm_mesapd_coupling/utility/SubCyclingManager.h
index cd748446b..d1f198916 100644
--- a/src/lbm_mesapd_coupling/utility/SubCyclingManager.h
+++ b/src/lbm_mesapd_coupling/utility/SubCyclingManager.h
@@ -25,7 +25,12 @@
namespace walberla {
namespace lbm_mesapd_coupling {
-// loosely based on Timeloop class
+/*! \brief Handles the execution of subcycles in a timeloop to allow for finer grained time steps than the LBM ones.
+*
+* Supports registration of functions that are run before, during or after a subcycle.
+* The SubCyclingManager itself has to be added to a parent (LBM) time loop, and will execute the functions registered
+* for execution during the subcycling procedure numberOfSubCycles times.
+*/
class SubCyclingManager {
public:
--
GitLab