Public Member Functions | Protected Attributes | List of all members
Seldon::SorPreconditioner< T > Class Template Reference
Inheritance diagram for Seldon::SorPreconditioner< T >:
Seldon::Preconditioner_Base< T >

Public Member Functions

 SorPreconditioner ()
 Default constructor.
 
bool IsSymmetric () const
 returns true if symmetric sor is used
 
void InitSymmetricPreconditioning ()
 if called forward and backward sweep will be applied such that the preconditioning is symmetric
 
void InitUnSymmetricPreconditioning ()
 if called, forward sweep is applied when calling Solve backward sweep is applied when calling TransSolve
 
void SetParameterRelaxation (const typename ClassComplexType< T >::Treal &param)
 sets the relaxation parameter omega
 
void SetNumberIterations (int nb_iterations)
 sets the number of SOR sweeps to perform when calling Solve/TransSolve
 
void CopyParameter (const Preconditioner_Base< T > &)
 copies the parameters of another sor preconditioning
 
template<class Vector1 , class Matrix1 >
void Solve (const Matrix1 &A, const Vector1 &r, Vector1 &z, bool init_guess_null=true)
 Solves M z = r.
 
template<class Vector1 , class Matrix1 >
void TransSolve (const Matrix1 &A, const Vector1 &r, Vector1 &z, bool init_guess_null=true)
 Solves M^t z = r.
 
template<class Matrix1 , class Vector1 >
void Solve (const Matrix1 &A, const Vector1 &r, Vector1 &z)
 Solves M z = r. More...
 
template<class Matrix1 , class Vector1 >
void TransSolve (const Matrix1 &A, const Vector1 &r, Vector1 &z)
 Solves M^t z = r. More...
 

Protected Attributes

bool symmetric_precond
 true for Symmetric relaxation
 
int nb_iter
 number of iterations
 
ClassComplexType< T >::Treal omega
 relaxation parameter
 

Detailed Description

template<class T>
class Seldon::SorPreconditioner< T >

Definition at line 26 of file Precond_Ssor.hxx.

Member Function Documentation

◆ Solve()

template<class T >
template<class Matrix1 , class Vector1 >
void Seldon::Preconditioner_Base< T >::Solve ( const Matrix1 &  A,
const Vector1 &  r,
Vector1 &  z 
)
inlineinherited

Solves M z = r.

Identity preconditioner M = I

Definition at line 87 of file IterativeInline.cxx.

◆ TransSolve()

template<class T >
template<class Matrix1 , class Vector1 >
void Seldon::Preconditioner_Base< T >::TransSolve ( const Matrix1 &  A,
const Vector1 &  r,
Vector1 &  z 
)
inlineinherited

Solves M^t z = r.

Identity preconditioner M = I

Definition at line 99 of file IterativeInline.cxx.

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