flexiblesusy is hosted by Hepforge, IPPP Durham
FlexibleSUSY
flexiblesusy::fixed_point_iterator::Convergence_tester_tadpole< dimension > Class Template Reference

#include <fixed_point_iterator.hpp>

Collaboration diagram for flexiblesusy::fixed_point_iterator::Convergence_tester_tadpole< dimension >:
Collaboration graph

Public Types

using Function_t = std::function< Vector_t(const Vector_t &)>
 
enum  Status : int { SUCCESS , CONTINUE }
 
using Vector_t = Eigen::Matrix< double, dimension, 1 >
 

Public Member Functions

 Convergence_tester_tadpole (double precision_, const Function_t &tadpole_function_)
 
const char * name () const
 
int operator() (const Vector_t &a, const Vector_t &b) const
 

Private Member Functions

int check_tadpoles (const Vector_t &x) const
 

Private Attributes

double precision
 precision goal More...
 
const Function_t tadpole_function
 function to calculate tadpole More...
 

Detailed Description

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

Definition at line 98 of file fixed_point_iterator.hpp.

Member Typedef Documentation

◆ Function_t

template<std::size_t dimension>
using flexiblesusy::fixed_point_iterator::Convergence_tester_tadpole< dimension >::Function_t = std::function<Vector_t(const Vector_t&)>

Definition at line 101 of file fixed_point_iterator.hpp.

◆ Vector_t

template<std::size_t dimension>
using flexiblesusy::fixed_point_iterator::Convergence_tester_tadpole< dimension >::Vector_t = Eigen::Matrix<double,dimension,1>

Definition at line 100 of file fixed_point_iterator.hpp.

Member Enumeration Documentation

◆ Status

Enumerator
SUCCESS 
CONTINUE 

Definition at line 102 of file fixed_point_iterator.hpp.

Constructor & Destructor Documentation

◆ Convergence_tester_tadpole()

template<std::size_t dimension>
flexiblesusy::fixed_point_iterator::Convergence_tester_tadpole< dimension >::Convergence_tester_tadpole ( double  precision_,
const Function_t tadpole_function_ 
)
inline

Definition at line 104 of file fixed_point_iterator.hpp.

Member Function Documentation

◆ check_tadpoles()

◆ name()

template<std::size_t dimension>
const char * flexiblesusy::fixed_point_iterator::Convergence_tester_tadpole< dimension >::name ( ) const
inline

Definition at line 110 of file fixed_point_iterator.hpp.

◆ operator()()

template<std::size_t dimension>
int flexiblesusy::fixed_point_iterator::Convergence_tester_tadpole< 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. If the relative difference is below the precision, it is tested whether the tadpoles are below the precision. If the tadpoles are larger than the precision, CONTINUE is returned.

Parameters
afirst vector
bsecond vector
Returns
status code (SUCCESS or CONTINUE)

Definition at line 124 of file fixed_point_iterator.hpp.

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

Member Data Documentation

◆ precision

◆ tadpole_function

template<std::size_t dimension>
const Function_t flexiblesusy::fixed_point_iterator::Convergence_tester_tadpole< dimension >::tadpole_function
private

function to calculate tadpole

Definition at line 141 of file fixed_point_iterator.hpp.


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