Registry
GaussSeidel Class Reference

Gauss-Seidel Preconditioner. More...

+ Inheritance diagram for GaussSeidel:

Public Member Functions

bool apply (Vector *unnamed, const Vector *unnamed)
 
bool apply_update_defect (Vector *unnamed, Vector *unnamed)
 
SmartPtr< ILinearIteratorclone ()
 returns a clone of the object which can be modified independently More...
 
std::string config_string () const
 string to display configuration of the linear iterator More...
 
void enable_consistent_interfaces (bool enable)
 makes the matrix and defect consistent at the proc. interfaces More...
 
void enable_overlap (bool enable)
 Enables matrix overlap. This also means that interfaces are consistent. More...
 
 GaussSeidel ()
 
bool init (SmartPtr< ILinearOperator > unnamed)
 
const char * name () const
 
void set_damp (double damp)
 set the damping to a number More...
 
void set_sor_relax (double sor_relaxation)
 sets sor relaxation parameter More...
 

Detailed Description

Gauss-Seidel Preconditioner.

Note
default specialization is GaussSeidelCPU1
See also
ug::GaussSeidel

Constructor & Destructor Documentation

◆ GaussSeidel()

Member Function Documentation

◆ apply()

bool apply ( Vector unnamed,
const Vector unnamed 
)
inlineinherited
Parameters
[in]unnamed
[in]unnamed

References ILinearIterator< X, Y >::apply().

◆ apply_update_defect()

bool apply_update_defect ( Vector unnamed,
Vector unnamed 
)
inlineinherited
Parameters
[in]unnamed
[in]unnamed

References ILinearIterator< X, Y >::apply_update_defect().

◆ clone()

SmartPtr<ILinearIterator> clone ( )
inlineinherited

returns a clone of the object which can be modified independently

Returns
SmartPointer to a copy of this object

References ILinearIterator< X, Y >::clone().

◆ config_string()

std::string config_string ( ) const
inlineinherited

string to display configuration of the linear iterator

Returns
strConfiguration

References ILinearIterator< X, Y >::config_string().

◆ enable_consistent_interfaces()

void enable_consistent_interfaces ( bool  enable)
inlineinherited

makes the matrix and defect consistent at the proc. interfaces

Parameters
[in]enable

References GaussSeidelBase< TAlgebra >::enable_consistent_interfaces().

◆ enable_overlap()

void enable_overlap ( bool  enable)
inlineinherited

Enables matrix overlap. This also means that interfaces are consistent.

Parameters
[in]enable

References GaussSeidelBase< TAlgebra >::enable_overlap().

◆ init()

bool init ( SmartPtr< ILinearOperator unnamed)
inlineinherited
Parameters
[in]unnamed

References ILinearIterator< X, Y >::init().

◆ name()

const char* name ( ) const
inlineinherited

◆ set_damp()

void set_damp ( double  damp)
inlineinherited

set the damping to a number

Parameters
[in]damp

References ILinearIterator< X, Y >::set_damp().

◆ set_sor_relax()

void set_sor_relax ( double  sor_relaxation)
inlineinherited

sets sor relaxation parameter

Parameters
[in]sor_relaxation

References GaussSeidelBase< TAlgebra >::set_sor_relax().