relative_convergence_tester.hpp

Go to the documentation of this file.

/*
 * This file is part of BubbleProfiler.
 *
 * BubbleProfiler is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * BubbleProfiler is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with BubbleProfiler.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef BUBBLEPROFILER_RELATIVE_CONVERGENCE_TESTER_HPP_INCLUDED
#define BUBBLEPROFILER_RELATIVE_CONVERGENCE_TESTER_HPP_INCLUDED

#include "basic_logger.hpp"
#include "profile_convergence_tester.hpp"

#include <Eigen/Core>

#include <vector>

namespace BubbleProfiler {

class Relative_convergence_tester : public Profile_convergence_tester {
public:
   Relative_convergence_tester() = default;

   explicit Relative_convergence_tester(double tol);

   Relative_convergence_tester(double action_tol, double fields_tol);
   Relative_convergence_tester(const Relative_convergence_tester&) = default;
   Relative_convergence_tester(Relative_convergence_tester&&) = default;
   virtual ~Relative_convergence_tester() = default;
   Relative_convergence_tester& operator=(const Relative_convergence_tester&) = default;
   Relative_convergence_tester& operator=(Relative_convergence_tester&&) = default;

   virtual bool is_converged(
         const Potential& potential, const Field_profiles& profiles) override;

   virtual int get_max_iterations() const override { return max_iterations; }

   virtual void restart() override;

   void set_max_iterations(int it) { max_iterations = it; }

private:
   int iteration_count{0};
   int max_iterations{10};
   double action_relative_tol{1.e-4};
   double field_vals_relative_tol{1.e-4};
   double old_action{0.};
   Eigen::VectorXd old_field_vals{};
   logging::Basic_logger logger{};

   int calculate_max_iterations() const;
   double relative_difference(double, double) const;
   bool check_action_converged(double) const;
   bool check_fields_converged(double, const Eigen::VectorXd&) const;
};

} // namespace BubbleProfiler

#endif