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

Public Types

typedef AlgebraT AlgebraType
typedef AlgebraType::Matrix MatrixType
typedef AlgebraType::Vector VectorType
typedef MatrixType::ValueType ValueType
typedef AlgebraType::FutureType FutureType

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::Iteration< AlgebraT >

Definition at line 17 of file Iteration.h.

Member Typedef Documentation

◆ AlgebraType

template<typename AlgebraT>
typedef AlgebraT Alien::Iteration< AlgebraT >::AlgebraType

Definition at line 21 of file Iteration.h.

◆ FutureType

template<typename AlgebraT>
typedef AlgebraType::FutureType Alien::Iteration< AlgebraT >::FutureType

Definition at line 25 of file Iteration.h.

◆ MatrixType

template<typename AlgebraT>
typedef AlgebraType::Matrix Alien::Iteration< AlgebraT >::MatrixType

Definition at line 22 of file Iteration.h.

◆ ValueType

template<typename AlgebraT>
typedef MatrixType::ValueType Alien::Iteration< AlgebraT >::ValueType

Definition at line 24 of file Iteration.h.

◆ VectorType

template<typename AlgebraT>
typedef AlgebraType::Vector Alien::Iteration< AlgebraT >::VectorType

Definition at line 23 of file Iteration.h.

Constructor & Destructor Documentation

◆ Iteration()

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

Definition at line 27 of file Iteration.h.

◆ ~Iteration()

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

Definition at line 54 of file Iteration.h.

Member Function Documentation

◆ first()

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

Definition at line 62 of file Iteration.h.

◆ getStatus()

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

Definition at line 100 of file Iteration.h.

◆ getValue()

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

Definition at line 87 of file Iteration.h.

◆ nullRhs()

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

Definition at line 57 of file Iteration.h.

◆ operator()()

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

Definition at line 95 of file Iteration.h.

◆ operator++()

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

Definition at line 78 of file Iteration.h.

◆ stop()

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

Definition at line 67 of file Iteration.h.

Member Data Documentation

◆ m_algebra

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

Definition at line 107 of file Iteration.h.

◆ m_criteria_value

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

Definition at line 113 of file Iteration.h.

◆ m_f_value

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

Definition at line 112 of file Iteration.h.

◆ m_iter

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

Definition at line 110 of file Iteration.h.

◆ m_max_iteration

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

Definition at line 108 of file Iteration.h.

◆ m_nrm2_b

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

Definition at line 115 of file Iteration.h.

◆ m_sqrt_nrm2_b

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

Definition at line 116 of file Iteration.h.

◆ m_status

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

Definition at line 117 of file Iteration.h.

◆ m_tol

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

Definition at line 109 of file Iteration.h.

◆ m_trace_mng

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

Definition at line 118 of file Iteration.h.

◆ m_value

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

Definition at line 111 of file Iteration.h.

◆ m_value_init

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

Definition at line 114 of file Iteration.h.

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