Diagonal preconditioner implementation. More...

#include <diagonal_precond.hpp>

Inheritance diagram for FEAT::Solver::DiagonalPrecond< Vector_, Filter_ >:

Public Types
typedef SolverBase< Vector_ >	BaseClass

typedef Filter_	FilterType

typedef Vector_	VectorType

Public Member Functions
	DiagonalPrecond (const String &section_name, const PropertyMap *section, const VectorType &diag, const FilterType &filter)

	DiagonalPrecond (const VectorType &diag, const FilterType &filter)
	Constructor. More...

virtual Status	apply (VectorType &vec_cor, const VectorType &vec_def) override
	Solver application method. More...

virtual void	done ()
	Finalization method. More...

virtual void	done_numeric ()
	Numeric finalization method. More...

virtual void	done_symbolic ()
	Symbolic finalization method. More...

virtual void	init ()
	Initialization method. More...

virtual void	init_numeric ()
	Numeric initialization method. More...

virtual void	init_symbolic ()
	Symbolic initialization method. More...

virtual String	name () const override
	Returns the name of the solver. More...

Protected Attributes
const VectorType &	_diag

const FilterType &	_filter

Detailed Description

template<typename Vector_, typename Filter_>
class FEAT::Solver::DiagonalPrecond< Vector_, Filter_ >

Diagonal preconditioner implementation.

This class implements a simple Diagonal preconditioner.

Author: Peter Zajac

Definition at line 23 of file diagonal_precond.hpp.

Member Typedef Documentation

◆ BaseClass

template<typename Vector_ , typename Filter_ >

typedef SolverBase<Vector_> FEAT::Solver::DiagonalPrecond< Vector_, Filter_ >::BaseClass

Definition at line 27 of file diagonal_precond.hpp.

◆ FilterType

template<typename Vector_ , typename Filter_ >

typedef Filter_ FEAT::Solver::DiagonalPrecond< Vector_, Filter_ >::FilterType

Definition at line 29 of file diagonal_precond.hpp.

◆ VectorType

template<typename Vector_ , typename Filter_ >

typedef Vector_ FEAT::Solver::DiagonalPrecond< Vector_, Filter_ >::VectorType

Definition at line 28 of file diagonal_precond.hpp.

Constructor & Destructor Documentation

◆ DiagonalPrecond() [1/2]

template<typename Vector_ , typename Filter_ >

FEAT::Solver::DiagonalPrecond< Vector_, Filter_ >::DiagonalPrecond	(	const VectorType &	diag,
		const FilterType &	filter
	)

inlineexplicit

Constructor.

Parameters

[in]	diag	The vector representing a diagonal matrix.
[in]	filter	The filter.

Definition at line 45 of file diagonal_precond.hpp.

◆ DiagonalPrecond() [2/2]

template<typename Vector_ , typename Filter_ >

FEAT::Solver::DiagonalPrecond< Vector_, Filter_ >::DiagonalPrecond	(	const String &	section_name,
		const PropertyMap *	section,
		const VectorType &	diag,
		const FilterType &	filter
	)

inlineexplicit

Definition at line 51 of file diagonal_precond.hpp.

Member Function Documentation

◆ apply()

template<typename Vector_ , typename Filter_ >

virtual Status FEAT::Solver::DiagonalPrecond< Vector_, Filter_ >::apply	(	VectorType &	vec_cor,
		const VectorType &	vec_def
	)

inlineoverridevirtual

Solver application method.

This method applies the solver represented by this object onto a given defect vector and returns the corresponding correction vector.

Note: Solvers which derive from the IterativeSolver base class also provide a correct() method which corrects an initial solution instead of starting with the null vector.

Parameters

[out]	vec_cor	The vector that shall receive the solution of the linear system. It is assumed to be allocated, but its numerical contents may be undefined upon calling this method.
[in]	vec_def	The vector that represents the right-hand-side of the linear system to be solved.

Attention: vec_cor and vec_def must not refer to the same vector object!

Returns: A Status code that represents the status of the solution step.

Implements FEAT::Solver::SolverBase< Vector_ >.

Definition at line 65 of file diagonal_precond.hpp.

References FEAT::Solver::success.

◆ done()

template<typename Vector_ >

virtual void FEAT::Solver::SolverBase< Vector_ >::done ( )

inlinevirtualinherited

Finalization method.

This function performs both the symbolic and numeric finalization, i.e. it simply performs

this->done_numeric();
this->done_symbolic();

Definition at line 283 of file base.hpp.

References FEAT::Solver::SolverBase< Vector_ >::done_numeric(), and FEAT::Solver::SolverBase< Vector_ >::done_symbolic().

◆ done_numeric()

template<typename Vector_ >

virtual void FEAT::Solver::SolverBase< Vector_ >::done_numeric ( )

inlinevirtualinherited

Numeric finalization method.

This method is called to release any data allocated in the numeric initialization step.

Reimplemented in FEAT::Solver::BFBT< MatrixA_, MatrixB_, MatrixD_, FilterV_, FilterP_ >, FEAT::Solver::BFBT< Global::Matrix< MatrixA_, MirrorV_, MirrorV_ >, Global::Matrix< MatrixB_, MirrorV_, MirrorP_ >, Global::Matrix< MatrixD_, MirrorP_, MirrorV_ >, Global::Filter< FilterV_, MirrorV_ >, Global::Filter< FilterP_, MirrorP_ > >, FEAT::Solver::ConvertPrecond< VectorOuter_, VectorInner_ >, FEAT::Solver::ConvertPrecond< Global::Vector< LocalVectorOuter_, MirrorOuter_ >, Global::Vector< LocalVectorInner_, MirrorInner_ > >, FEAT::Solver::CUDSS, FEAT::Solver::DirectStokesSolver< LAFEM::SaddlePointMatrix< MatrixA_, MatrixB_, MatrixD_ >, LAFEM::TupleFilter< FilterV_, FilterP_ > >, FEAT::Solver::DirectStokesSolver< Global::Matrix< LocalMatrix_, Mirror_, Mirror_ >, Global::Filter< LocalFilter_, Mirror_ > >, FEAT::Solver::ParaSailsPrecond< Matrix_, Filter_ >, FEAT::Solver::EuclidPrecond< Matrix_, Filter_ >, FEAT::Solver::BoomerAMG< Matrix_, Filter_ >, FEAT::Solver::PreconditionedIterativeSolver< Vector_ >, FEAT::Solver::PreconditionedIterativeSolver< Matrix_::VectorTypeR >, FEAT::Solver::PreconditionedIterativeSolver< Functional_::VectorTypeR >, FEAT::Solver::MKLDSS, FEAT::Solver::MultiGrid< SystemMatrix_, SystemFilter_, TransferOperator_ >, FEAT::Solver::PCGNR< Matrix_, Filter_ >, FEAT::Solver::SchwarzPrecond< Global::Vector< LocalVector_, Mirror_ >, Global::Filter< LocalFilter_, Mirror_ > >, FEAT::Solver::Umfpack, FEAT::Solver::UmfpackMean, FEAT::Solver::SaddleUmfpackMean< DT_, IT_, dim_ >, FEAT::Solver::GenericUmfpack< Matrix_ >, FEAT::Solver::UzawaPrecond< MatrixA_, MatrixB_, MatrixD_, FilterV_, FilterP_ >, and FEAT::Solver::UzawaPrecond< Global::Matrix< MatrixA_, MirrorV_, MirrorV_ >, Global::Matrix< MatrixB_, MirrorV_, MirrorP_ >, Global::Matrix< MatrixD_, MirrorP_, MirrorV_ >, Global::Filter< FilterV_, MirrorV_ >, Global::Filter< FilterP_, MirrorP_ > >.

Definition at line 246 of file base.hpp.

◆ done_symbolic()

template<typename Vector_ >

virtual void FEAT::Solver::SolverBase< Vector_ >::done_symbolic ( )

inlinevirtualinherited

Symbolic finalization method.

This method is called to release any data allocated in the symbolic initialization step.

Definition at line 255 of file base.hpp.

◆ init()

template<typename Vector_ >

virtual void FEAT::Solver::SolverBase< Vector_ >::init ( )

inlinevirtualinherited

Initialization method.

This function performs both the symbolic and numeric initialization, i.e. it simply performs

this->init_symbolic();
this->init_numeric();

Definition at line 268 of file base.hpp.

References FEAT::Solver::SolverBase< Vector_ >::init_numeric(), and FEAT::Solver::SolverBase< Vector_ >::init_symbolic().

◆ init_numeric()

template<typename Vector_ >

virtual void FEAT::Solver::SolverBase< Vector_ >::init_numeric ( )

inlinevirtualinherited

Numeric initialization method.

This method is called to perform numeric initialization of the solver.
Before this function can be called, the symbolic initialization must be performed.

Definition at line 237 of file base.hpp.

◆ init_symbolic()

template<typename Vector_ >

virtual void FEAT::Solver::SolverBase< Vector_ >::init_symbolic ( )

inlinevirtualinherited

Symbolic initialization method.

This method is called to perform symbolic initialization of the solver.

Definition at line 227 of file base.hpp.

◆ name()

template<typename Vector_ , typename Filter_ >

virtual String FEAT::Solver::DiagonalPrecond< Vector_, Filter_ >::name ( ) const

inlineoverridevirtual

Returns the name of the solver.

Implements FEAT::Solver::SolverBase< Vector_ >.

Definition at line 60 of file diagonal_precond.hpp.

Member Data Documentation

◆ _diag

template<typename Vector_ , typename Filter_ >

const VectorType& FEAT::Solver::DiagonalPrecond< Vector_, Filter_ >::_diag

protected

Definition at line 32 of file diagonal_precond.hpp.

◆ _filter

template<typename Vector_ , typename Filter_ >

const FilterType& FEAT::Solver::DiagonalPrecond< Vector_, Filter_ >::_filter

protected

Definition at line 33 of file diagonal_precond.hpp.

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

kernel/solver/diagonal_precond.hpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ FilterType

◆ VectorType

Constructor & Destructor Documentation

◆ DiagonalPrecond() [1/2]

◆ DiagonalPrecond() [2/2]

Member Function Documentation

◆ apply()

◆ done()

◆ done_numeric()

◆ done_symbolic()

◆ init()

◆ init_numeric()

◆ init_symbolic()

◆ name()

Member Data Documentation

◆ _diag

◆ _filter