Sub-class where it is determined whether the required accuracy is achieved in the Broyden's method. More...

#include <Broyden.h>

Public Member Functions
	BroydenSolutionCriterium (double maximum_error=TOL)

virtual	~BroydenSolutionCriterium ()=default
	Destroy the BroydenSolutionCriterium object.

virtual bool	IsSolved (const std::vector< double > &x, const std::vector< double > &f, const std::vector< double > &xdelta=std::vector< double >()) const

Protected Attributes
double	m_MaximumError

Detailed Description

Sub-class where it is determined whether the required accuracy is achieved in the Broyden's method.

By default, the desired accuracy is achieved if all of the equations deviate from zero by less than the specified accuracy. A derived class may implement a different criterium.

Definition at line 144 of file Broyden.h.

Constructor & Destructor Documentation

◆ BroydenSolutionCriterium()

thermalfist::Broyden::BroydenSolutionCriterium::BroydenSolutionCriterium ( double maximum_error = TOL )

inline

Construct a new BroydenSolutionCriterium object

Parameters

maximum_error The maximum deviation from zero of any of the l.h.s. of all the equations for the desired accuracy to be considered achieved.

Definition at line 153 of file Broyden.h.

◆ ~BroydenSolutionCriterium()

virtual thermalfist::Broyden::BroydenSolutionCriterium::~BroydenSolutionCriterium ( )

virtualdefault

Destroy the BroydenSolutionCriterium object.

Member Function Documentation

◆ IsSolved()

bool thermalfist::Broyden::BroydenSolutionCriterium::IsSolved	(	const std::vector< double > &	x,
		const std::vector< double > &	f,
		const std::vector< double > &	xdelta = std::vector<double>() ) const

virtual

Determines whether the solution with the desired accuracy has been achieved.

Parameters

x	Values of the variables.
f	Values of the l.h.s. of all the equations
xdelta	Difference in variables' values between current and previous iterations.

Returns: true The desired accuracy is achieved.; false The desired accuracy not achieved.

Definition at line 181 of file Broyden.cpp.

Member Data Documentation

◆ m_MaximumError

double thermalfist::Broyden::BroydenSolutionCriterium::m_MaximumError

protected

The maximum deviation from zero of any of the l.h.s. of all the equations for the desired accuracy to be considered achieved.

Definition at line 179 of file Broyden.h.

The documentation for this class was generated from the following files:

include/HRGBase/Broyden.h
src/library/HRGBase/Broyden.cpp

Public Member Functions

Protected Attributes