ResidualRelativeConvergenceMeasure.hpp

Go to the documentation of this file.

#pragma once
 
#include <Eigen/Core>
#include <iomanip>
#include <limits>
#include <ostream>
#include <string>
#include "../CouplingData.hpp"
#include "ConvergenceMeasure.hpp"
#include "logging/Logger.hpp"
#include "math/differences.hpp"
#include "utils/IntraComm.hpp"
#include "utils/assertion.hpp"
 
namespace precice::cplscheme::impl {

class ResidualRelativeConvergenceMeasure : public ConvergenceMeasure {
public:
  explicit ResidualRelativeConvergenceMeasure(double convergenceLimitPercent);
 
  ~ResidualRelativeConvergenceMeasure() override = default;
 
  void newMeasurementSeries() override
  {
    _isConvergence     = false;
    _isFirstIteration  = true;
    _normFirstResidual = std::numeric_limits<double>::max();
  }
 
  void measure(
      const Eigen::VectorXd &oldValues,
      const Eigen::VectorXd &newValues) override
  {
    PRECICE_ASSERT(oldValues.size() == newValues.size());
    _normDiff = utils::IntraComm::l2norm(newValues - oldValues);
    if (_isFirstIteration) {
      _normFirstResidual = _normDiff;
      _isFirstIteration  = false;
    }
    _isConvergence = _normDiff < _normFirstResidual * _convergenceLimitPercent;
  }
 
  bool isConvergence() const override
  {
    return _isConvergence;
  }

  std::string printState(const std::string &dataName) override
  {
    std::ostringstream os;
    os << "residual relative convergence measure: ";
    os << "relative two-norm diff of data \"" << dataName << "\" = ";
    os << std::scientific << std::setprecision(2) << getNormResidual();
    os << ", limit = " << _convergenceLimitPercent;
    os << ", normalization = " << _normFirstResidual;
    os << ", conv = ";
    if (_isConvergence)
      os << "true";
    else
      os << "false";
    return os.str();
  }
 
  double getNormResidual() override
  {
    if (math::equals(_normFirstResidual, 0.))
      return std::numeric_limits<double>::infinity();
    else
      return _normDiff / _normFirstResidual;
  }
 
  std::string getAbbreviation() const override
  {
    return "Drop";
  }
 
private:
  logging::Logger _log{"cplscheme::ResidualRelativeConvergenceMeasure"};
 
  double _convergenceLimitPercent;
 
  bool _isFirstIteration = true;
 
  double _normFirstResidual = std::numeric_limits<double>::max();
 
  double _normDiff = 0;
 
  bool _isConvergence = false;
};
} // namespace precice::cplscheme::impl