flexiblesusy::fixed_point_iterator::Convergence_tester_relative< dimension > Class Template Reference

#include <fixed_point_iterator.hpp>

Collaboration diagram for flexiblesusy::fixed_point_iterator::Convergence_tester_relative< dimension >:

Public Types
enum	Status : int { SUCCESS , CONTINUE }
using	Vector_t = Eigen::Matrix< double, dimension, 1 >

Public Member Functions
	Convergence_tester_relative (double precision_=1.0e-2)
const char *	name () const
int	operator() (const Vector_t &a, const Vector_t &b) const

Private Attributes
double	precision
	precision goal

Detailed Description

template<std::size_t dimension>
class flexiblesusy::fixed_point_iterator::Convergence_tester_relative< dimension >

Definition at line 69 of file fixed_point_iterator.hpp.

Member Typedef Documentation

Vector_t

template<std::size_t dimension>

using flexiblesusy::fixed_point_iterator::Convergence_tester_relative< dimension >::Vector_t = Eigen::Matrix<double,dimension,1>

Definition at line 71 of file fixed_point_iterator.hpp.

Member Enumeration Documentation

Status

template<std::size_t dimension>

enum flexiblesusy::fixed_point_iterator::Convergence_tester_relative::Status : int

Enumerator
SUCCESS
CONTINUE

Definition at line 72 of file fixed_point_iterator.hpp.

Constructor & Destructor Documentation

Convergence_tester_relative()

template<std::size_t dimension>

flexiblesusy::fixed_point_iterator::Convergence_tester_relative< dimension >::Convergence_tester_relative ( double  precision_ = 1.0e-2 )

inlineexplicit

Definition at line 74 of file fixed_point_iterator.hpp.

Member Function Documentation

name()

template<std::size_t dimension>

const char * flexiblesusy::fixed_point_iterator::Convergence_tester_relative< dimension >::name ( ) const

inline

Definition at line 78 of file fixed_point_iterator.hpp.

operator()()

template<std::size_t dimension>

int flexiblesusy::fixed_point_iterator::Convergence_tester_relative< dimension >::operator() ( const Vector_t &  a, const Vector_t &  b  ) const

inline

Test whether the relative difference is less than the set precision. The relative difference test used here is carried out by applying is_equal_rel() to each element of the vector.

Parameters

a	first vector
b	second vector

Returns

status code (SUCCESS or CONTINUE)

Definition at line 89 of file fixed_point_iterator.hpp.

References flexiblesusy::fixed_point_iterator::Convergence_tester_relative< dimension >::CONTINUE, flexiblesusy::is_equal_rel(), flexiblesusy::fixed_point_iterator::Convergence_tester_relative< dimension >::precision, and flexiblesusy::fixed_point_iterator::Convergence_tester_relative< dimension >::SUCCESS.

Member Data Documentation

precision

template<std::size_t dimension>

double flexiblesusy::fixed_point_iterator::Convergence_tester_relative< dimension >::precision

private

precision goal

Definition at line 94 of file fixed_point_iterator.hpp.

Referenced by flexiblesusy::fixed_point_iterator::Convergence_tester_relative< dimension >::operator()().

---

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

• fixed_point_iterator.hpp