RelativeConvergenceMeasure.hpp

Go to the documentation of this file.

#pragma once
 
#include <Eigen/Core>
#include <iomanip>
#include <limits>
#include <math.h>
#include <ostream>
#include <string>
#include "../CouplingData.hpp"
#include "ConvergenceMeasure.hpp"
#include "logging/Logger.hpp"
#include "math/differences.hpp"
#include "math/math.hpp"
#include "utils/IntraComm.hpp"
#include "utils/assertion.hpp"
 
namespace precice::cplscheme::tests {
class RelativeConvergenceMeasureTest;
}
 
// ----------------------------------------------------------- CLASS DEFINITION
 
namespace precice::cplscheme::impl {

class RelativeConvergenceMeasure : public ConvergenceMeasure {
public:
  RelativeConvergenceMeasure(double convergenceLimitPercent);
 
  ~RelativeConvergenceMeasure() override = default;
 
  void newMeasurementSeries() override
  {
    _isConvergence = false;
  }
 
  void measure(
      const Eigen::VectorXd &oldValues,
      const Eigen::VectorXd &newValues) override
  {
    PRECICE_ASSERT(oldValues.size() == newValues.size());
    /*
     std::cout<<"\n-------\n";
     std::cout<<"   old val: \n"<<oldValues<<'\n';
     std::cout<<"   new val: \n"<<newValues<<"\n\n";
     std::cout<<"-------\n\n";
*/
 
    _normDiff      = utils::IntraComm::l2norm(newValues - oldValues);
    _norm          = utils::IntraComm::l2norm(newValues);
    _isConvergence = _normDiff <= _norm * _convergenceLimitPercent;
  }
 
  bool isConvergence() const override
  {
    return _isConvergence;
  }

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