diff --git a/src/lbm_mesapd_coupling/utility/SubCyclingManager.h b/src/lbm_mesapd_coupling/utility/SubCyclingManager.h index cd748446b51676878ec26f7cea1139fe915139fa..d1f1989162ad1d9e049647930b34e691ffe40c97 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: