Kaskade::IdentityPreconditioner< X > Class Template Reference

The trivial (identity) preconditioner. More...

#include <symmetricOperators.hh>

Detailed Description

template<class X>
class Kaskade::IdentityPreconditioner< X >

The trivial (identity) preconditioner.

Definition at line 253 of file symmetricOperators.hh.

Inheritance diagram for Kaskade::IdentityPreconditioner< X >:

Public Types
typedef X::field_type	field_type

Public Member Functions
virtual void	apply (X &v, const X &d)
virtual field_type	applyDp (X &x, X const &y)
	Computes \( x \leftarrow By \) and returns \( \langle By, y \rangle \). More...
virtual bool	requiresInitializedInput () const
	Returns true if the target vector x has to be initialized to zero before calling apply or applyDp. More...
virtual void	pre (X &, X &)
	Preconditioner preparation. More...
virtual void	post (X &x)
	Preconditioner cleanup. More...
virtual Dune::SolverCategory::Category	category () const override
	returns the category of the operator More...

Member Typedef Documentation

field_type

template<class X >

typedef X::field_type Kaskade::IdentityPreconditioner< X >::field_type

Definition at line 256 of file symmetricOperators.hh.

Member Function Documentation

apply()

template<class X >

virtual void Kaskade::IdentityPreconditioner< X >::apply ( X &  v, const X &  d  )

inlinevirtual

Definition at line 258 of file symmetricOperators.hh.

applyDp()

template<class X >

virtual field_type Kaskade::IdentityPreconditioner< X >::applyDp ( X &  x, X const &  y  )

inlinevirtual

Computes \( x \leftarrow By \) and returns \( \langle By, y \rangle \).

Implements Kaskade::SymmetricPreconditioner< X, X >.

Definition at line 266 of file symmetricOperators.hh.

category()

virtual Dune::SolverCategory::Category Kaskade::SymmetricPreconditioner< X, X >::category ( ) const

inlineoverridevirtualinherited

returns the category of the operator

From the Dune doxygen documentation it is unclear what this is supposed to mean. We return a dummy here.

Definition at line 242 of file symmetricOperators.hh.

post()

virtual void Kaskade::SymmetricPreconditioner< X, X >::post ( X &  x )

inlinevirtualinherited

Preconditioner cleanup.

The provided default implementation does nothing.

Definition at line 225 of file symmetricOperators.hh.

pre()

virtual void Kaskade::SymmetricPreconditioner< X, X >::pre ( X &  , X &    )

inlinevirtualinherited

Preconditioner preparation.

The provided default implementation does nothing.

Definition at line 218 of file symmetricOperators.hh.

requiresInitializedInput()

template<class X >

virtual bool Kaskade::IdentityPreconditioner< X >::requiresInitializedInput ( ) const

inlinevirtual

Returns true if the target vector x has to be initialized to zero before calling apply or applyDp.

Implements Kaskade::SymmetricPreconditioner< X, X >.

Definition at line 275 of file symmetricOperators.hh.

---

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

• symmetricOperators.hh