Separate component filter implemented as a compound preconditioner. More...

#include <SeparateComponentPreconditioner.hpp>

Inheritance diagram for geos::SeparateComponentPreconditioner< LAI >:

Public Types
using	Base = PreconditionerBase< LAI >
	Alias for base type.

using	Vector = typename Base::Vector
	Alias for vector type.

using	Matrix = typename Base::Matrix
	Alias for matrix type.

Public Types inherited from geos::PreconditionerBase< LAI >
using	Base = LinearOperator< typename LAI::ParallelVector >
	Alias for base type.

using	Vector = typename Base::Vector
	Alias for vector type.

using	Matrix = typename LAI::ParallelMatrix
	Alias for matrix type.

Public Types inherited from geos::LinearOperator< LAI::ParallelVector >
using	Vector = LAI::ParallelVector
	Alias for template parameter.

Public Member Functions
	SeparateComponentPreconditioner (localIndex const numComp, std::unique_ptr< PreconditionerBase< LAI > > precond)
	Constructor. More...

virtual	~SeparateComponentPreconditioner () override
	Destructor.

virtual void	setup (Matrix const &mat) override
	Compute the preconditioner from a matrix. More...

virtual void	apply (Vector const &src, Vector &dst) const override
	Apply operator to a vector. More...

virtual void	clear () override
	Clean up the preconditioner setup. More...

virtual bool	hasPreconditionerMatrix () const override
	Check whether the preconditioner is available in matrix (explicit) form. More...

virtual Matrix const &	preconditionerMatrix () const override
	Access the preconditioner in matrix form (whenever available). It must be overridden by the specific preconditioner. More...

Matrix const &	separateComponentMatrix () const

PreconditionerBase< LAI > const &	innerPrecond () const
	Access to the nested preconditioner. More...

Public Member Functions inherited from geos::PreconditionerBase< LAI >
virtual globalIndex	numGlobalRows () const override
	Get the number of global rows. More...

virtual globalIndex	numGlobalCols () const override
	Get the number of global columns. More...

virtual localIndex	numLocalRows () const override
	Get the number of local rows. More...

virtual localIndex	numLocalCols () const override
	Get the number of local columns. More...

virtual MPI_Comm	comm () const override
	Get the MPI communicator the matrix was created with. More...

bool	ready () const
	Chech if preconditioner is ready to use. More...

Matrix const &	matrix () const
	Access the matrix the preconditioner was computed from. More...

Public Member Functions inherited from geos::LinearOperator< LAI::ParallelVector >
	LinearOperator ()=default
	Constructor.

virtual	~LinearOperator ()=default
	Destructor.

virtual void	apply (Vector const &src, Vector &dst) const=0
	Apply operator to a vector, `dst = this(src)`. More...

virtual void	residual (Vector const &x, Vector const &b, Vector &r) const
	Compute residual `r = b - this(x)`. More...

Detailed Description

template<typename LAI>
class geos::SeparateComponentPreconditioner< LAI >

Separate component filter implemented as a compound preconditioner.

Template Parameters

LAI	linear algebra interface to use

Definition at line 35 of file SeparateComponentPreconditioner.hpp.

Constructor & Destructor Documentation

◆ SeparateComponentPreconditioner()

template<typename LAI >

geos::SeparateComponentPreconditioner< LAI >::SeparateComponentPreconditioner	(	localIndex const	numComp,
		std::unique_ptr< PreconditionerBase< LAI > >	precond
	)

Constructor.

Parameters

numComp	number of components in the field
precond	the actual preconditioner to apply to filtered matrix (ownership transferred)

Member Function Documentation

◆ apply()

template<typename LAI >

virtual void geos::SeparateComponentPreconditioner< LAI >::apply	(	Vector const &	src,
		Vector &	dst
	)		const

overridevirtual

Apply operator to a vector.

Parameters

src	Input vector (x).
dst	Output vector (b).

Warning: src and dst cannot alias the same vector.

◆ clear()

template<typename LAI >

virtual void geos::SeparateComponentPreconditioner< LAI >::clear ( )

overridevirtual

Clean up the preconditioner setup.

Releases memory used and allows the matrix to be deleted cleanly. This method should be called before the matrix used to compute the preconditioner goes out of scope or is re-created. Some implementations require the matrix to outlive the preconditioner (for example, Trilinos/ML may crash the program if deleted after the matrix).

Note: Should be properly overridden in derived classes, which may call this method.

Reimplemented from geos::PreconditionerBase< LAI >.

◆ hasPreconditionerMatrix()

template<typename LAI >

virtual bool geos::SeparateComponentPreconditioner< LAI >::hasPreconditionerMatrix ( ) const

inlineoverridevirtual

Check whether the preconditioner is available in matrix (explicit) form.

Returns: if the preconditioner is available in explicit form

Reimplemented from geos::PreconditionerBase< LAI >.

Definition at line 74 of file SeparateComponentPreconditioner.hpp.

◆ innerPrecond()

template<typename LAI >

PreconditionerBase< LAI > const& geos::SeparateComponentPreconditioner< LAI >::innerPrecond ( ) const

inline

Access to the nested preconditioner.

Returns: reference to the preconditioner passed at construction

Definition at line 97 of file SeparateComponentPreconditioner.hpp.

◆ preconditionerMatrix()

template<typename LAI >

virtual Matrix const& geos::SeparateComponentPreconditioner< LAI >::preconditionerMatrix ( ) const

inlineoverridevirtual

Access the preconditioner in matrix form (whenever available). It must be overridden by the specific preconditioner.

Returns: reference to the preconditioner matrix

Reimplemented from geos::PreconditionerBase< LAI >.

Definition at line 79 of file SeparateComponentPreconditioner.hpp.

◆ separateComponentMatrix()

template<typename LAI >

Matrix const& geos::SeparateComponentPreconditioner< LAI >::separateComponentMatrix ( ) const

inline

Returns: reference to the filtered matrix

Definition at line 87 of file SeparateComponentPreconditioner.hpp.

◆ setup()

template<typename LAI >

virtual void geos::SeparateComponentPreconditioner< LAI >::setup ( Matrix const & mat )

overridevirtual

Compute the preconditioner from a matrix.

Parameters

mat	the matrix to precondition.

Reimplemented from geos::PreconditionerBase< LAI >.

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

coreComponents/linearAlgebra/solvers/SeparateComponentPreconditioner.hpp

Public Types

Public Member Functions

Detailed Description

template<typename LAI> class geos::SeparateComponentPreconditioner< LAI >

Constructor & Destructor Documentation

◆ SeparateComponentPreconditioner()

Member Function Documentation

◆ apply()

◆ clear()

◆ hasPreconditionerMatrix()

◆ innerPrecond()

◆ preconditionerMatrix()

◆ separateComponentMatrix()

◆ setup()

template<typename LAI>
class geos::SeparateComponentPreconditioner< LAI >