SolverStatistics.h

Go to the documentation of this file.

// This file is part of the Peano's multigrid extension. For conditions of
// distribution and use, please see the copyright notice at
// www.peano-framework.org
#pragma once
 
 
#include <string>
 
#include "tarch/la/Vector.h"
#include "tarch/logging/Log.h"
#include "tarch/multicore/BooleanSemaphore.h"
 
#include "peano4/utils/Globals.h"
 
 
namespace mghype {
  namespace matrixfree {
    namespace solvers {
      class SolverStatistics;
    }
  }
}
 
 
class mghype::matrixfree::solvers::SolverStatistics {
  public:
    SolverStatistics(double tolerance = 0.0);
 
    bool terminationCriterionHolds();
 
    void updateGlobalResidual(
      double residual,
      const tarch::la::Vector<Dimensions,double>&  h
    );
 
    /*
     *
     * @todo This name is not good. We should argue over a cycle
     * residual or something similar. But in any case, it is not
     * a good name.
     */
    void updateGlobalPrecondResidual(
      double residual
    );
 
    void updateGlobalSolutionUpdates(
      double deltaU,
      const tarch::la::Vector<Dimensions,double>&  h
    );
 
    void updateMinMaxMeshSize(
      const tarch::la::Vector<Dimensions,double>&  h
    );
 
    void clearGlobalPrecondResidualUpdate();
 
    double getGlobalResidualMaxNorm() const;
    std::array<double, 2> getGlobalPrecondResidualNorms() const;
 
    std::string toString() const;
 
    void merge( const SolverStatistics&  statistics );
 
    std::string reportPrecondNorms() const;
 
    void clearGlobalResidualAndSolutionUpdate();
 
    void synchroniseGlobalResidualAndSolutionUpdate();
  protected:
 
    static tarch::logging::Log _log;
 
    const double _tolerance;
 
    double     _minH;
 
    double     _maxH;
 
    double     _globalResidualMaxNorm;
    double     _globalResidualEukledianNormSquared;
    double     _globalResidualHNormSquared;
 
    double _initialGlobalResidualMaxNorm;
    double _initialGlobalResidualEukledianNormSquared;
    double _initialGlobalResidualHNormSquared;
 
    double _previousGlobalResidualMaxNorm;
    double _previousGlobalResidualEukledianNormSquared;
    double _previousGlobalResidualHNormSquared;
 
    double     _globalDeltaUMaxNorm;
    double     _globalDeltaUEukledianNormSquared;
    double     _globalDeltaUHNormSquared;
 
    double _globalPrecondResidualMaxNorm;
    double _globalPrecondResidualEukledianNormSquared;
};