profile_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_PROFILE_CONVERGENCE_TESTER_HPP_INCLUDED
#define BUBBLEPROFILER_PROFILE_CONVERGENCE_TESTER_HPP_INCLUDED

namespace BubbleProfiler {

class Potential;
class Field_profiles;

class Profile_convergence_tester {
public:
   virtual ~Profile_convergence_tester() = default;
   virtual int get_max_iterations() const = 0;
   virtual bool is_converged(const Potential&, const Field_profiles&) = 0;

   virtual void restart() = 0;
};

} // namespace BubbleProfiler

#endif