Alien  1.3.0
Developer documentation
Loading...
Searching...
No Matches
Alien::BiCGStab< AlgebraT >::Iteration Class Reference
Collaboration diagram for Alien::BiCGStab< AlgebraT >::Iteration:

Public Member Functions

 Iteration (AlgebraType &algebra, VectorType const &b, ValueType tol, int max_iter, ITraceMng *trace_mng=nullptr)
bool nullRhs () const
bool first () const
bool stop (VectorType const &r)
void operator++ ()
ValueType getValue () const
int operator() () const
bool getStatus () const

Private Attributes

AlgebraType & m_algebra
int m_max_iteration = 0
ValueType m_tol = 0.
int m_iter = 0
ValueType m_value = 0.
FutureType m_f_value
ValueType m_criteria_value = 0.
ValueType m_value_init = 0.
ValueType m_nrm2_b = 0.
ValueType m_sqrt_nrm2_b = 0.
bool m_status = false
ITraceMng * m_trace_mng = nullptr

Detailed Description

template<typename AlgebraT>
class Alien::BiCGStab< AlgebraT >::Iteration

Definition at line 28 of file BiCGStab.h.

Constructor & Destructor Documentation

◆ Iteration()

template<typename AlgebraT>
Alien::BiCGStab< AlgebraT >::Iteration::Iteration ( AlgebraType & algebra,
VectorType const & b,
ValueType tol,
int max_iter,
ITraceMng * trace_mng = nullptr )
inline

Definition at line 31 of file BiCGStab.h.

◆ ~Iteration()

template<typename AlgebraT>
virtual Alien::BiCGStab< AlgebraT >::Iteration::~Iteration ( )
inlinevirtual

Definition at line 57 of file BiCGStab.h.

Member Function Documentation

◆ first()

template<typename AlgebraT>
bool Alien::BiCGStab< AlgebraT >::Iteration::first ( ) const
inline

Definition at line 65 of file BiCGStab.h.

◆ getStatus()

template<typename AlgebraT>
bool Alien::BiCGStab< AlgebraT >::Iteration::getStatus ( ) const
inline

Definition at line 99 of file BiCGStab.h.

◆ getValue()

template<typename AlgebraT>
ValueType Alien::BiCGStab< AlgebraT >::Iteration::getValue ( ) const
inline

Definition at line 86 of file BiCGStab.h.

◆ nullRhs()

template<typename AlgebraT>
bool Alien::BiCGStab< AlgebraT >::Iteration::nullRhs ( ) const
inline

Definition at line 60 of file BiCGStab.h.

◆ operator()()

template<typename AlgebraT>
int Alien::BiCGStab< AlgebraT >::Iteration::operator() ( ) const
inline

Definition at line 94 of file BiCGStab.h.

◆ operator++()

template<typename AlgebraT>
void Alien::BiCGStab< AlgebraT >::Iteration::operator++ ( )
inline

Definition at line 79 of file BiCGStab.h.

◆ stop()

template<typename AlgebraT>
bool Alien::BiCGStab< AlgebraT >::Iteration::stop ( VectorType const & r)
inline

Definition at line 70 of file BiCGStab.h.

Member Data Documentation

◆ m_algebra

template<typename AlgebraT>
AlgebraType& Alien::BiCGStab< AlgebraT >::Iteration::m_algebra
private

Definition at line 106 of file BiCGStab.h.

◆ m_criteria_value

template<typename AlgebraT>
ValueType Alien::BiCGStab< AlgebraT >::Iteration::m_criteria_value = 0.
private

Definition at line 112 of file BiCGStab.h.

◆ m_f_value

template<typename AlgebraT>
FutureType Alien::BiCGStab< AlgebraT >::Iteration::m_f_value
private

Definition at line 111 of file BiCGStab.h.

◆ m_iter

template<typename AlgebraT>
int Alien::BiCGStab< AlgebraT >::Iteration::m_iter = 0
private

Definition at line 109 of file BiCGStab.h.

◆ m_max_iteration

template<typename AlgebraT>
int Alien::BiCGStab< AlgebraT >::Iteration::m_max_iteration = 0
private

Definition at line 107 of file BiCGStab.h.

◆ m_nrm2_b

template<typename AlgebraT>
ValueType Alien::BiCGStab< AlgebraT >::Iteration::m_nrm2_b = 0.
private

Definition at line 114 of file BiCGStab.h.

◆ m_sqrt_nrm2_b

template<typename AlgebraT>
ValueType Alien::BiCGStab< AlgebraT >::Iteration::m_sqrt_nrm2_b = 0.
private

Definition at line 115 of file BiCGStab.h.

◆ m_status

template<typename AlgebraT>
bool Alien::BiCGStab< AlgebraT >::Iteration::m_status = false
private

Definition at line 116 of file BiCGStab.h.

◆ m_tol

template<typename AlgebraT>
ValueType Alien::BiCGStab< AlgebraT >::Iteration::m_tol = 0.
private

Definition at line 108 of file BiCGStab.h.

◆ m_trace_mng

template<typename AlgebraT>
ITraceMng* Alien::BiCGStab< AlgebraT >::Iteration::m_trace_mng = nullptr
private

Definition at line 117 of file BiCGStab.h.

◆ m_value

template<typename AlgebraT>
ValueType Alien::BiCGStab< AlgebraT >::Iteration::m_value = 0.
private

Definition at line 110 of file BiCGStab.h.

◆ m_value_init

template<typename AlgebraT>
ValueType Alien::BiCGStab< AlgebraT >::Iteration::m_value_init = 0.
private

Definition at line 113 of file BiCGStab.h.

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