Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
PreconditionBase< VectorType > Class Template Referenceabstract
Inheritance diagram for PreconditionBase< VectorType >:
[legend]

Public Member Functions

 PreconditionBase ()
virtual void vmult (VectorType &dst, const VectorType &src) const =0
void timer_print () const
void timer_reset () const

Protected Attributes

const MPI_Comm comm
ConditionalOStream pcout
TimerOutput timer

Detailed Description

template<typename VectorType>
class PreconditionBase< VectorType >

A base class of preconditioners used by the smoother.

Definition at line 55 of file fluid_dynamics_matrix_free.cc.

Constructor & Destructor Documentation

◆ PreconditionBase()

template<typename VectorType>
PreconditionBase< VectorType >::PreconditionBase ( )
inline

Constructor.

Definition at line 61 of file fluid_dynamics_matrix_free.cc.

Member Function Documentation

◆ timer_print()

template<typename VectorType>
void PreconditionBase< VectorType >::timer_print ( ) const
inline

Print timers.

Definition at line 80 of file fluid_dynamics_matrix_free.cc.

◆ timer_reset()

template<typename VectorType>
void PreconditionBase< VectorType >::timer_reset ( ) const
inline

Reset timers.

Definition at line 89 of file fluid_dynamics_matrix_free.cc.

◆ vmult()

template<typename VectorType>
virtual void PreconditionBase< VectorType >::vmult ( VectorType & dst,
const VectorType & src ) const
pure virtual

Apply preconditioner.

Parameters
[in,out]dstDestination vector holding the result.
[in]srcInput source vector.

Implemented in MyDiagonalMatrix< VectorType >, PreconditionAdapter< VectorType, VectorTypePrecondition >, and PreconditionASM< VectorType >.

Member Data Documentation

◆ comm

template<typename VectorType>
const MPI_Comm PreconditionBase< VectorType >::comm
protected

Communicator used for timer output.

Definition at line 96 of file fluid_dynamics_matrix_free.cc.

◆ pcout

template<typename VectorType>
ConditionalOStream PreconditionBase< VectorType >::pcout
protected

Stream used for timer output.

Definition at line 99 of file fluid_dynamics_matrix_free.cc.

◆ timer

template<typename VectorType>
TimerOutput PreconditionBase< VectorType >::timer
mutableprotected

Timer.

Definition at line 102 of file fluid_dynamics_matrix_free.cc.


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