#include <ginkgo.hpp>

Inheritance diagram for mfem::Ginkgo::IluIsaiPreconditioner:

Collaboration diagram for mfem::Ginkgo::IluIsaiPreconditioner:

Public Member Functions
	IluIsaiPreconditioner (GinkgoExecutor &exec, const std::string &factorization_type="exact", const int sweeps=0, const int sparsity_power=1, const bool skip_sort=false)

Public Member Functions inherited from mfem::Ginkgo::GinkgoPreconditioner
	GinkgoPreconditioner (GinkgoExecutor &exec)

virtual	~GinkgoPreconditioner ()=default

virtual void	SetOperator (const Operator &op)

virtual void	Mult (const Vector &x, Vector &y) const

const std::shared_ptr < gko::LinOpFactory >	GetFactory () const

const std::shared_ptr< gko::LinOp >	GetGeneratedPreconditioner () const

bool	HasGeneratedPreconditioner () const

Public Member Functions inherited from mfem::Solver
	Solver (int s=0, bool iter_mode=false)
	Initialize a square Solver with size s. More...

	Solver (int h, int w, bool iter_mode=false)
	Initialize a Solver with height h and width w. More...

Public Member Functions inherited from mfem::Operator
void	InitTVectors (const Operator Po, const Operator Ri, const Operator *Pi, Vector &x, Vector &b, Vector &X, Vector &B) const
	Initializes memory for true vectors of linear system. More...

	Operator (int s=0)
	Construct a square Operator with given size s (default 0). More...

	Operator (int h, int w)
	Construct an Operator with the given height (output size) and width (input size). More...

int	Height () const
	Get the height (size of output) of the Operator. Synonym with NumRows(). More...

int	NumRows () const
	Get the number of rows (size of output) of the Operator. Synonym with Height(). More...

int	Width () const
	Get the width (size of input) of the Operator. Synonym with NumCols(). More...

int	NumCols () const
	Get the number of columns (size of input) of the Operator. Synonym with Width(). More...

virtual MemoryClass	GetMemoryClass () const
	Return the MemoryClass preferred by the Operator. More...

virtual void	MultTranspose (const Vector &x, Vector &y) const
	Action of the transpose operator: `y=A^t(x)`. The default behavior in class Operator is to generate an error. More...

virtual Operator &	GetGradient (const Vector &x) const
	Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error. More...

virtual void	AssembleDiagonal (Vector &diag) const
	Computes the diagonal entries into diag. Typically, this operation only makes sense for linear Operators. In some cases, only an approximation of the diagonal is computed. More...

virtual const Operator *	GetProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. `NULL` means identity. More...

virtual const Operator *	GetRestriction () const
	Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. `NULL` means identity. More...

virtual const Operator *	GetOutputProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. `NULL` means identity. More...

virtual const Operator *	GetOutputRestrictionTranspose () const
	Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators. More...

virtual const Operator *	GetOutputRestriction () const
	Restriction operator from output vectors for the operator to linear algebra (linear system) vectors. `NULL` means identity. More...

void	FormLinearSystem (const Array< int > &ess_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B, int copy_interior=0)
	Form a constrained linear system using a matrix-free approach. More...

void	FormRectangularLinearSystem (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B)
	Form a column-constrained linear system using a matrix-free approach. More...

virtual void	RecoverFEMSolution (const Vector &X, const Vector &b, Vector &x)
	Reconstruct a solution vector x (e.g. a GridFunction) from the solution X of a constrained linear system obtained from Operator::FormLinearSystem() or Operator::FormRectangularLinearSystem(). More...

void	FormSystemOperator (const Array< int > &ess_tdof_list, Operator *&A)
	Return in A a parallel (on truedofs) version of this square operator. More...

void	FormRectangularSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Operator *&A)
	Return in A a parallel (on truedofs) version of this rectangular operator (including constraints). More...

void	FormDiscreteOperator (Operator *&A)
	Return in A a parallel (on truedofs) version of this rectangular operator. More...

void	PrintMatlab (std::ostream &out, int n=0, int m=0) const
	Prints operator with input size n and output size m in Matlab format. More...

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

Type	GetType () const
	Return the type ID of the Operator class. More...

Additional Inherited Members
Public Types inherited from mfem::Operator
enum	DiagonalPolicy { DIAG_ZERO, DIAG_ONE, DIAG_KEEP }
	Defines operator diagonal policy upon elimination of rows and/or columns. More...

enum	Type { ANY_TYPE, MFEM_SPARSEMAT, Hypre_ParCSR, PETSC_MATAIJ, PETSC_MATIS, PETSC_MATSHELL, PETSC_MATNEST, PETSC_MATHYPRE, PETSC_MATGENERIC, Complex_Operator, MFEM_ComplexSparseMat, Complex_Hypre_ParCSR }
	Enumeration defining IDs for some classes derived from Operator. More...

Public Attributes inherited from mfem::Solver
bool	iterative_mode
	If true, use the second argument of Mult() as an initial guess. More...

Protected Member Functions inherited from mfem::Operator
void	FormConstrainedSystemOperator (const Array< int > &ess_tdof_list, ConstrainedOperator *&Aout)
	see FormSystemOperator() More...

void	FormRectangularConstrainedSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, RectangularConstrainedOperator *&Aout)
	see FormRectangularSystemOperator() More...

Operator *	SetupRAP (const Operator Pi, const Operator Po)
	Returns RAP Operator of this, using input/output Prolongation matrices Pi corresponds to "P", Po corresponds to "Rt". More...

Protected Attributes inherited from mfem::Ginkgo::GinkgoPreconditioner
std::shared_ptr < gko::LinOpFactory >	precond_gen

std::shared_ptr< gko::LinOp >	generated_precond

std::shared_ptr< gko::Executor >	executor

bool	has_generated_precond

Protected Attributes inherited from mfem::Operator
int	height
	Dimension of the output / number of rows in the matrix. More...

int	width
	Dimension of the input / number of columns in the matrix. More...

Detailed Description

An implementation of the preconditioner interface using the Ginkgo Incomplete LU-Incomplete Sparse Approximate Inverse preconditioner. The Ilu-ISAI preconditioner differs from the Ilu preconditioner in that Incomplete Sparse Approximate Inverses (ISAIs) are formed to approximate solving the triangular systems defined by L and U. When the preconditioner is applied, these ISAI matrices are applied through matrix-vector multiplication.

Definition at line 1129 of file ginkgo.hpp.

Constructor & Destructor Documentation

mfem::Ginkgo::IluIsaiPreconditioner::IluIsaiPreconditioner	(	GinkgoExecutor &	exec,
		const std::string &	factorization_type = `"exact"`,
		const int	sweeps = `0`,
		const int	sparsity_power = `1`,
		const bool	skip_sort = `false`
	)

Constructor.

Parameters

[in]	exec	The execution paradigm for the preconditioner.
[in]	factorization_type	The factorization type: "exact" or "parilu".
[in]	sweeps	The number of sweeps to do in the ParIlu factorization algorithm. A value of 0 tells Ginkgo to use its internal default value. This parameter is ignored in the case of an exact factorization.
[in]	sparsity_power	Parameter determining the sparsity pattern of the ISAI approximations.
[in]	skip_sort	Only set this to true if the input matrix that will be used to generate this preconditioner is guaranteed to be sorted by column. See the Ginkgo documentation for more information on these parameters.

Note: The use of this preconditioner will sort any input matrix given to it, potentially changing the order of the stored values.

Definition at line 984 of file ginkgo.cpp.

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

linalg/ginkgo.hpp
linalg/ginkgo.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation