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

Public Types

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

Public Member Functions

 NeumannPolyPreconditioner (AlgebraType &algebra, MatrixType const &matrix, ValueType factor, int polynome_order, int factor_max_iter, ITraceMng *trace_mng=nullptr)
void setOutputLevel (int level)
void init ()
void solve (const VectorType &x, VectorType &y)
void solve (AlgebraType &algebra, VectorType const &x, VectorType &y) const
void evalG (AlgebraType &algebra, const VectorType &x, VectorType &y) const
void evalG (const VectorType &x, VectorType &y)
void computeFactor ()

Private Attributes

AlgebraType & m_algebra
MatrixType const & m_matrix
 matrix a preconditioner
ValueType m_factor = 0.
 facteur d'acceleration
int m_polynome_order = 3
int m_factor_max_iter = 10
VectorType m_y
VectorType m_yy
ITraceMng * m_trace_mng = nullptr
int m_output_level = 0

Detailed Description

template<typename AlgebraT>
class Alien::NeumannPolyPreconditioner< AlgebraT >

Definition at line 32 of file NeumannPolyPreconditioner.h.

Member Typedef Documentation

◆ AlgebraType

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

Definition at line 36 of file NeumannPolyPreconditioner.h.

◆ MatrixType

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

Definition at line 37 of file NeumannPolyPreconditioner.h.

◆ ValueType

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

Definition at line 39 of file NeumannPolyPreconditioner.h.

◆ VectorType

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

Definition at line 38 of file NeumannPolyPreconditioner.h.

Constructor & Destructor Documentation

◆ NeumannPolyPreconditioner()

template<typename AlgebraT>
Alien::NeumannPolyPreconditioner< AlgebraT >::NeumannPolyPreconditioner ( AlgebraType & algebra,
MatrixType const & matrix,
ValueType factor,
int polynome_order,
int factor_max_iter,
ITraceMng * trace_mng = nullptr )
inline

Definition at line 42 of file NeumannPolyPreconditioner.h.

◆ ~NeumannPolyPreconditioner()

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

Definition at line 57 of file NeumannPolyPreconditioner.h.

Member Function Documentation

◆ computeFactor()

template<typename AlgebraT>
void Alien::NeumannPolyPreconditioner< AlgebraT >::computeFactor ( )
inline

Definition at line 142 of file NeumannPolyPreconditioner.h.

◆ evalG() [1/2]

template<typename AlgebraT>
void Alien::NeumannPolyPreconditioner< AlgebraT >::evalG ( AlgebraType & algebra,
const VectorType & x,
VectorType & y ) const
inline
Parameters
yinput

Definition at line 121 of file NeumannPolyPreconditioner.h.

References m_factor, and m_matrix.

Referenced by solve().

Here is the caller graph for this function:

◆ evalG() [2/2]

template<typename AlgebraT>
void Alien::NeumannPolyPreconditioner< AlgebraT >::evalG ( const VectorType & x,
VectorType & y )
inline
Parameters
yinput

Definition at line 132 of file NeumannPolyPreconditioner.h.

References m_factor, and m_matrix.

◆ init()

template<typename AlgebraT>
void Alien::NeumannPolyPreconditioner< AlgebraT >::init ( )
inline

Definition at line 68 of file NeumannPolyPreconditioner.h.

◆ setOutputLevel()

template<typename AlgebraT>
void Alien::NeumannPolyPreconditioner< AlgebraT >::setOutputLevel ( int level)
inline

Definition at line 63 of file NeumannPolyPreconditioner.h.

◆ solve() [1/2]

template<typename AlgebraT>
void Alien::NeumannPolyPreconditioner< AlgebraT >::solve ( AlgebraType & algebra,
VectorType const & x,
VectorType & y ) const
inline

Definition at line 103 of file NeumannPolyPreconditioner.h.

◆ solve() [2/2]

template<typename AlgebraT>
void Alien::NeumannPolyPreconditioner< AlgebraT >::solve ( const VectorType & x,
VectorType & y )
inline
Parameters
yinput output

Definition at line 85 of file NeumannPolyPreconditioner.h.

References evalG(), and m_factor.

Here is the call graph for this function:

Member Data Documentation

◆ m_algebra

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

Definition at line 179 of file NeumannPolyPreconditioner.h.

◆ m_factor

template<typename AlgebraT>
ValueType Alien::NeumannPolyPreconditioner< AlgebraT >::m_factor = 0.
private

facteur d'acceleration

Definition at line 185 of file NeumannPolyPreconditioner.h.

Referenced by evalG(), evalG(), and solve().

◆ m_factor_max_iter

template<typename AlgebraT>
int Alien::NeumannPolyPreconditioner< AlgebraT >::m_factor_max_iter = 10
private

Definition at line 187 of file NeumannPolyPreconditioner.h.

◆ m_matrix

template<typename AlgebraT>
MatrixType const& Alien::NeumannPolyPreconditioner< AlgebraT >::m_matrix
private

matrix a preconditioner

Definition at line 182 of file NeumannPolyPreconditioner.h.

Referenced by evalG(), and evalG().

◆ m_output_level

template<typename AlgebraT>
int Alien::NeumannPolyPreconditioner< AlgebraT >::m_output_level = 0
private

Definition at line 193 of file NeumannPolyPreconditioner.h.

◆ m_polynome_order

template<typename AlgebraT>
int Alien::NeumannPolyPreconditioner< AlgebraT >::m_polynome_order = 3
private

Definition at line 186 of file NeumannPolyPreconditioner.h.

◆ m_trace_mng

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

Definition at line 192 of file NeumannPolyPreconditioner.h.

◆ m_y

template<typename AlgebraT>
VectorType Alien::NeumannPolyPreconditioner< AlgebraT >::m_y
mutableprivate

Definition at line 189 of file NeumannPolyPreconditioner.h.

◆ m_yy

template<typename AlgebraT>
VectorType Alien::NeumannPolyPreconditioner< AlgebraT >::m_yy
mutableprivate

Definition at line 190 of file NeumannPolyPreconditioner.h.


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