#include <relative_convergence_tester.hpp>

Inheritance diagram for BubbleProfiler::Relative_convergence_tester:

Collaboration diagram for BubbleProfiler::Relative_convergence_tester:

Public Member Functions
	Relative_convergence_tester ()=default
	Construct relative convergence tester with default tolerances. More...

	Relative_convergence_tester (double tol)
	Construct relative convergence tester with the same tolerance value for change in action and change in field values at origin. More...

	Relative_convergence_tester (double action_tol, double fields_tol)
	Construct relative convergence tester with different tolerance values for change in action and change in field values at origin. More...

	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
	Check whether the candidate bubble solution has converged. More...

virtual int	get_max_iterations () const override
	Return the maximum number of iterations allowed. More...

virtual void	restart () override
	Restart the convergence tester to the start of the iteration. More...

void	set_max_iterations (int it)
	Set the maximum number of iterations allowed. More...

Public Member Functions inherited from BubbleProfiler::Profile_convergence_tester
virtual	~Profile_convergence_tester ()=default

Private Member Functions
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

Private Attributes
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 {}

Detailed Description

This class implements a convergence criterion based on two factors:

Relative change in Euclidean action
Relative change in field values at the origin

The user supplies relative tolerances for both factors. Note that in general there is more than one scalar field; in which case the field with the greatest relative change between iterations is used to test convergence.

Definition at line 40 of file relative_convergence_tester.hpp.

Constructor & Destructor Documentation

BubbleProfiler::Relative_convergence_tester::Relative_convergence_tester ( )

default

Construct relative convergence tester with default tolerances.

BubbleProfiler::Relative_convergence_tester::Relative_convergence_tester ( double tol )

explicit

Construct relative convergence tester with the same tolerance value for change in action and change in field values at origin.

The maximum number of iterations is set to

\[ -10 \log_{10}(\epsilon), \]

with \(\epsilon\) equal to the supplied value of tol .

Parameters

tol	relative change tolerance

Definition at line 46 of file relative_convergence_tester.cpp.

BubbleProfiler::Relative_convergence_tester::Relative_convergence_tester	(	double	action_tol,
		double	fields_tol
	)

Construct relative convergence tester with different tolerance values for change in action and change in field values at origin.

The maximum number of iterations is set to

\[ \max(-10 \log_{10}(\epsilon)), \]

where \(\epsilon\) is the smaller of action_tol and fields_tol .

Parameters

action_tol	relative change tolerance for the action
fields_tol	relative change tolerance for field values at origin

Definition at line 38 of file relative_convergence_tester.cpp.

References calculate_max_iterations(), and max_iterations.

BubbleProfiler::Relative_convergence_tester::Relative_convergence_tester ( const Relative_convergence_tester & )

default

BubbleProfiler::Relative_convergence_tester::Relative_convergence_tester ( Relative_convergence_tester && )

default

virtual BubbleProfiler::Relative_convergence_tester::~Relative_convergence_tester ( )

virtualdefault

Member Function Documentation

int BubbleProfiler::Relative_convergence_tester::calculate_max_iterations ( ) const

private

Definition at line 80 of file relative_convergence_tester.cpp.

References action_relative_tol, and field_vals_relative_tol.

Referenced by Relative_convergence_tester().

bool BubbleProfiler::Relative_convergence_tester::check_action_converged ( double action ) const

private

Definition at line 102 of file relative_convergence_tester.cpp.

References action_relative_tol, BubbleProfiler::logging::Basic_logger::log_message(), logger, old_action, relative_difference(), and BubbleProfiler::logging::Trace.

Referenced by is_converged().

bool BubbleProfiler::Relative_convergence_tester::check_fields_converged	(	double	domain_start,
		const Eigen::VectorXd &	field_vals
	)		const

private

Definition at line 118 of file relative_convergence_tester.cpp.

References field_vals_relative_tol, BubbleProfiler::logging::Basic_logger::log_message(), logger, gaussian_alpha_tests::n_fields, old_field_vals, relative_difference(), and BubbleProfiler::logging::Trace.

Referenced by is_converged().

virtual int BubbleProfiler::Relative_convergence_tester::get_max_iterations ( ) const

inlineoverridevirtual

Return the maximum number of iterations allowed.

If this count is exceeded, before convergence is reached (as indicated by is_converged returning true), the client may want to issue a warning or implement some other error handling strategy.