Documented SegregatedSolver

src/coupled/solvers/SegregatedSolver.cpp

@@ -61,6 +61,7 @@ SegregatedSolver::EvaluateIteration(const IElphyAssemble &elphyAssemble, const I
   evaluationMetrics[metrics[19]].emplace_back(elphyAssemble.L2Norm(mechValues[1]));
   evaluationMetrics[metrics[20]].emplace_back(elphyAssemble.H1Norm(mechValues[1]));
 
+  // Get some metrices from src/elasticity/problem/ElasticityProblem.hpp (for the mechanics part)
   auto problemMetrics = mechAssemble.GetElasticityProblem().EvaluationMetrics();
   auto problemEntries = mechAssemble.GetElasticityProblem().EvaluationResults(mechValues[0]);
   for (int i = 0; i < problemMetrics.size(); ++i) {

src/coupled/solvers/SegregatedSolver.hpp

@@ -23,6 +23,7 @@ class SegregatedSolver : public CardiacSolver {
   std::unique_ptr<ElphySolver> elphySolver;
   std::unique_ptr<ElastodynamicTimeIntegrator> mechSolver;
 
+  /// Creates some output for each step.
   void printStep();
   void printFullEvaluation();
   void initEvaluation(const IElphyAssemble &elphyAssemble,
@@ -62,8 +63,10 @@ public:
 
   void Initialize(IElphyAssemble &elphyAssemble, IElasticity &mechAssemble, Vector &potential, Vector &displacement);
 
+  /// Solves coupled equation from mechAssemble.firstTimeStep to mechAssemble.lastTimeStep
   void Method(IElphyAssemble &elphyAssemble, IElasticity &mechAssemble, Vector &potential, Vector &displacement);
 
+  /// Calculates next timestep for the mechanics as well as for the electrophysiology.
   void Step(IElphyAssemble &elphyAssemble, IElasticity &mechAssemble, Vectors &elphyValues, Vectors &mechValues);
 
   void Finalize(Vectors &values) {};