Polymorphic solver interface. More...

#include <base.hpp>

Inheritance diagram for FEAT::Solver::SolverBase< Vector_ >:

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

Public Member Functions
	SolverBase ()
	Empty standard constructor. More...

	SolverBase (const String &section_name, const PropertyMap *config_section)
	Constructor using a PropertyMap. More...

virtual	~SolverBase ()
	Virtual destructor. More...

virtual Status	apply (Vector_ &vec_cor, const Vector_ &vec_def)=0
	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 =0
	Returns a descriptive string. More...

Detailed Description

template<typename Vector_>
class FEAT::Solver::SolverBase< Vector_ >

Polymorphic solver interface.

This class template defines the interface for any solver implementation.

Template Parameters

Vector_ The class of the vector that is passed to the solver in the solve() method.

If the solver was created by calling the PropertyMap based constructor, it can return the name of the corresponding section by get_section_name(). Otherwise, it returns its name through the virtual name() function.

Author: Peter Zajac

Definition at line 182 of file base.hpp.

Member Typedef Documentation

◆ VectorType

template<typename Vector_ >

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

The type of vector this solver can be applied to.

Definition at line 186 of file base.hpp.

Constructor & Destructor Documentation

◆ SolverBase() [1/2]

template<typename Vector_ >

FEAT::Solver::SolverBase< Vector_ >::SolverBase ( )

inline

Empty standard constructor.

Definition at line 192 of file base.hpp.

◆ SolverBase() [2/2]

template<typename Vector_ >

FEAT::Solver::SolverBase< Vector_ >::SolverBase	(	const String &	section_name,
		const PropertyMap *	config_section
	)

inlineexplicit

Constructor using a PropertyMap.

This configures the solver using the key/value pairs in the PropertyMap. This base class has nothing to configure, but this constructor is called from the derived classes as well.

See also: Solver configuration via PropertyMaps

Parameters

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

Definition at line 211 of file base.hpp.

◆ ~SolverBase()

template<typename Vector_ >

virtual FEAT::Solver::SolverBase< Vector_ >::~SolverBase ( )

inlinevirtual

Virtual destructor.

Definition at line 218 of file base.hpp.

Member Function Documentation

◆ apply()

template<typename Vector_ >

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

pure virtual

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.

Implemented in FEAT::Solver::SchwarzPrecond< Global::Vector< LocalVector_, Mirror_ >, Global::Filter< LocalFilter_, Mirror_ > >, FEAT::Solver::CuSolverLU, FEAT::Solver::CuSolverQR, FEAT::Solver::ScalePrecond< Vector_, Filter_ >, FEAT::Solver::DiagonalPrecond< Vector_, Filter_ >, FEAT::Solver::MultiGrid< SystemMatrix_, SystemFilter_, TransferOperator_ >, FEAT::Solver::NLOptPrecond< VectorType_, FilterType_ >, FEAT::Solver::AmaVanka< Matrix_, Filter_ >, FEAT::Solver::ConvertPrecond< VectorOuter_, VectorInner_ >, FEAT::Solver::ConvertPrecond< Global::Vector< LocalVectorOuter_, MirrorOuter_ >, Global::Vector< LocalVectorInner_, MirrorInner_ > >, and FEAT::Solver::BFBT< MatrixA_, MatrixB_, MatrixD_, FilterV_, FilterP_ >.

Referenced by FEAT::Solver::solve().

◆ done()

template<typename Vector_ >

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

inlinevirtual

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 ( )

inlinevirtual

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 ( )

inlinevirtual

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 ( )

inlinevirtual

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 ( )

inlinevirtual

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 ( )

inlinevirtual

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_ >

virtual String FEAT::Solver::SolverBase< Vector_ >::name ( ) const

pure virtual

Returns a descriptive string.

Returns: A string describing the solver.

Referenced by FEAT::Solver::PreconditionedIterativeSolver< Vector_ >::_apply_precond(), FEAT::Solver::Linesearch< Functional_, Filter_ >::_check_convergence(), FEAT::Solver::IterativeSolver< Vector_ >::_set_initial_defect(), FEAT::Solver::NLOptLS< Functional_, Filter_ >::_set_initial_defect(), FEAT::Solver::IterativeSolver< Vector_ >::_set_new_defect(), FEAT::Solver::NLOptLS< Functional_, Filter_ >::_set_new_defect(), and FEAT::Solver::IterativeSolver< Vector_ >::_update_defect().

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

kernel/solver/base.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ VectorType

Constructor & Destructor Documentation

◆ SolverBase() [1/2]

◆ SolverBase() [2/2]

◆ ~SolverBase()

Member Function Documentation

◆ apply()

◆ done()

◆ done_numeric()

◆ done_symbolic()

◆ init()

◆ init_numeric()

◆ init_symbolic()

◆ name()