Scaling preconditioner class template. More...

#include <scale_precond.hpp>

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

Public Types
typedef Vector_	VectorType
	The type of vector this solver can be applied to. More...

Public Member Functions
	ScalePrecond (const Filter_ &filter, DataType omega)
	Constructor. More...

	ScalePrecond (const String &section_name, const PropertyMap *section, const Filter_ &filter)
	Constructor using a PropertyMap. More...

virtual	~ScalePrecond ()
	Empty virtual destructor. More...

virtual Status	apply (Vector_ &vec_cor, const Vector_ &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...

void	set_omega (DataType omega)
	Sets the damping parameter. More...

Protected Types
typedef SolverBase< Vector_ >	BaseClass
	Our base class. More...

typedef Vector_::DataType	DataType
	our data type More...

Protected Attributes
const Filter_ &	_filter
	the filter More...

DataType	_omega
	the scaling factor More...

Detailed Description

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

Scaling preconditioner class template.

This simple preconditioner represents a scaled identity matrix.

Author: Peter Zajac

Definition at line 22 of file scale_precond.hpp.

Member Typedef Documentation

◆ BaseClass

template<typename Vector_ , typename Filter_ >

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

protected

Our base class.

Definition at line 33 of file scale_precond.hpp.

◆ DataType

template<typename Vector_ , typename Filter_ >

typedef Vector_::DataType FEAT::Solver::ScalePrecond< Vector_, Filter_ >::DataType

protected

our data type

Definition at line 27 of file scale_precond.hpp.

◆ VectorType

template<typename Vector_ >

typedef Vector_ FEAT::Solver::SolverBase< Vector_ >::VectorType

inherited

The type of vector this solver can be applied to.

Definition at line 186 of file base.hpp.

Constructor & Destructor Documentation

◆ ScalePrecond() [1/2]

template<typename Vector_ , typename Filter_ >

FEAT::Solver::ScalePrecond< Vector_, Filter_ >::ScalePrecond	(	const Filter_ &	filter,
		DataType	omega
	)

inlineexplicit

Constructor.

Parameters

[in] omega The scaling factor.

Definition at line 42 of file scale_precond.hpp.

◆ ScalePrecond() [2/2]

template<typename Vector_ , typename Filter_ >

FEAT::Solver::ScalePrecond< Vector_, Filter_ >::ScalePrecond	(	const String &	section_name,
		const PropertyMap *	section,
		const Filter_ &	filter
	)

inlineexplicit

Constructor using a PropertyMap.

Parameters

[in]	section_name	The name of the config section, which it does not know by itself
[in]	section	A pointer to the PropertyMap section configuring this solver
[in]	filter	The system filter.

Definition at line 61 of file scale_precond.hpp.

References FEAT::PropertyMap::query().

◆ ~ScalePrecond()

template<typename Vector_ , typename Filter_ >

virtual FEAT::Solver::ScalePrecond< Vector_, Filter_ >::~ScalePrecond ( )

inlinevirtual

Empty virtual destructor.

Definition at line 76 of file scale_precond.hpp.

Member Function Documentation

◆ apply()

template<typename Vector_ , typename Filter_ >

virtual Status FEAT::Solver::ScalePrecond< Vector_, Filter_ >::apply	(	Vector_ &	vec_cor,
		const Vector_ &	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 100 of file scale_precond.hpp.

References FEAT::Solver::ScalePrecond< Vector_, Filter_ >::_filter, and 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::ScalePrecond< Vector_, Filter_ >::name ( ) const

inlineoverridevirtual

Returns the name of the solver.

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

Definition at line 81 of file scale_precond.hpp.

◆ set_omega()

template<typename Vector_ , typename Filter_ >

void FEAT::Solver::ScalePrecond< Vector_, Filter_ >::set_omega ( DataType omega )

inline

Sets the damping parameter.

Parameters

[in] omega The new damping parameter.

Definition at line 93 of file scale_precond.hpp.

References FEAT::Solver::ScalePrecond< Vector_, Filter_ >::_omega, and XASSERT.

Member Data Documentation

◆ _filter

template<typename Vector_ , typename Filter_ >

const Filter_& FEAT::Solver::ScalePrecond< Vector_, Filter_ >::_filter

protected

the filter

Definition at line 29 of file scale_precond.hpp.

Referenced by FEAT::Solver::ScalePrecond< Vector_, Filter_ >::apply().

◆ _omega

template<typename Vector_ , typename Filter_ >

DataType FEAT::Solver::ScalePrecond< Vector_, Filter_ >::_omega

protected

the scaling factor

Definition at line 31 of file scale_precond.hpp.

Referenced by FEAT::Solver::ScalePrecond< Vector_, Filter_ >::set_omega().

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

kernel/solver/scale_precond.hpp

Public Types

Public Member Functions

Protected Types

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ DataType

◆ VectorType

Constructor & Destructor Documentation

◆ ScalePrecond() [1/2]

◆ ScalePrecond() [2/2]

◆ ~ScalePrecond()

Member Function Documentation

◆ apply()

◆ done()

◆ done_numeric()

◆ done_symbolic()

◆ init()

◆ init_numeric()

◆ init_symbolic()

◆ name()

◆ set_omega()

Member Data Documentation

◆ _filter

◆ _omega