#include <profile_convergence_tester.hpp>

Inheritance diagram for BubbleProfiler::Profile_convergence_tester:

Public Member Functions
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
	Re-initialize the convergence tester. More...

Detailed Description

Abstract interface for a class used to determine whether a candidate bubble solution has converged. Implementations are assumed to be stateful, tracking relevant information about successive iterations until the relevant convergence criterea are met.

NOTE: Convergence testers may supply a maximum iteration count. However, it is NOT guaranteed that implementations will return is_converged:TRUE when this is exceeded. It is expected that instead, client classes will make use of this value, and possibly provide a warning when the max count is exceeded before the solution converges.

Definition at line 38 of file profile_convergence_tester.hpp.