From cd4f02497bc5fc69ff1d7e430e6d323e1d72e56c Mon Sep 17 00:00:00 2001
From: ralfulrich <ralf.ulrich@kit.edu>
Date: Mon, 20 May 2019 12:41:48 +0200
Subject: [PATCH] added comments
---
Framework/ProcessSequence/ProcessSequence.h | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/Framework/ProcessSequence/ProcessSequence.h b/Framework/ProcessSequence/ProcessSequence.h
index 8116966d1..333a4f47d 100644
--- a/Framework/ProcessSequence/ProcessSequence.h
+++ b/Framework/ProcessSequence/ProcessSequence.h
@@ -136,6 +136,14 @@ namespace corsika::process {
return ret;
}
+ /**
+ The processes of type StackProcess do have an internal counter,
+ so they can be exectuted only each N steps. Often these are
+ "maintenacne processes" that do not need to run after each
+ single step of the simulations. In the CheckStep function it is
+ tested if either A or B are StackProcess and if they are due
+ for execution.
+ */
bool CheckStep() {
bool ret = false;
if constexpr (std::is_base_of_v<StackProcess<T1type>, T1type> || t1ProcSeq) {
@@ -147,6 +155,9 @@ namespace corsika::process {
return ret;
}
+ /**
+ Execute the StackProcess-es in the ProcessSequence
+ */
template <typename TStack>
EProcessReturn DoStack(TStack& vS) {
EProcessReturn ret = EProcessReturn::eOk;
--
GitLab