#include <ginkgo.hpp>

Inheritance diagram for mfem::Ginkgo::EnableGinkgoSolver< SolverType >:

Collaboration diagram for mfem::Ginkgo::EnableGinkgoSolver< SolverType >:

Public Member Functions
	EnableGinkgoSolver (GinkgoExecutor &exec, bool use_implicit_res_norm)

void	SetRelTol (real_t rtol)

void	SetAbsTol (real_t atol)

void	SetMaxIter (int max_it)

Public Member Functions inherited from mfem::Ginkgo::GinkgoIterativeSolver
const std::shared_ptr< gko::LinOpFactory >	GetFactory () const

void	SetPrintLevel (int print_lvl)

int	GetNumIterations () const

int	GetConverged () const

real_t	GetFinalNorm () const

virtual void	SetOperator (const Operator &op)

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

bool	UsesVectorWrappers () const

virtual	~GinkgoIterativeSolver ()=default

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

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

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.

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

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

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

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

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

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

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

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.

virtual void	AddMult (const Vector &x, Vector &y, const real_t a=1.0) const
	Operator application: `y+=A(x)` (default) or `y+=a*A(x)`.

virtual void	AddMultTranspose (const Vector &x, Vector &y, const real_t a=1.0) const
	Operator transpose application: `y+=A^t(x)` (default) or `y+=a*A^t(x)`.

virtual void	ArrayMult (const Array< const Vector * > &X, Array< Vector * > &Y) const
	Operator application on a matrix: `Y=A(X)`.

virtual void	ArrayMultTranspose (const Array< const Vector * > &X, Array< Vector * > &Y) const
	Action of the transpose operator on a matrix: `Y=A^t(X)`.

virtual void	ArrayAddMult (const Array< const Vector * > &X, Array< Vector * > &Y, const real_t a=1.0) const
	Operator application on a matrix: `Y+=A(X)` (default) or `Y+=a*A(X)`.

virtual void	ArrayAddMultTranspose (const Array< const Vector * > &X, Array< Vector * > &Y, const real_t a=1.0) const
	Operator transpose application on a matrix: `Y+=A^t(X)` (default) or `Y+=a*A^t(X)`.

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.

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.

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

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

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

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

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

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.

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.

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

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

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

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

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

virtual void	PrintMatlab (std::ostream &out) const
	Prints operator in Matlab format.

virtual	~Operator ()
	Virtual destructor.

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

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 , Complex_DenseMat , MFEM_Block_Matrix , MFEM_Block_Operator }
	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.

Protected Member Functions inherited from mfem::Ginkgo::GinkgoIterativeSolver
	GinkgoIterativeSolver (GinkgoExecutor &exec, bool use_implicit_res_norm)

void	update_stop_factory ()

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

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

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".

Protected Attributes inherited from mfem::Ginkgo::GinkgoIterativeSolver
bool	use_implicit_res_norm

int	print_level

int	max_iter

real_t	rel_tol

real_t	abs_tol

real_t	final_norm

int	final_iter

int	converged

std::shared_ptr< gko::LinOpFactory >	solver_gen

std::shared_ptr< gko::LinOp >	solver

std::shared_ptr< gko::stop::ResidualNorm<>::Factory >	rel_criterion

std::shared_ptr< gko::stop::ResidualNorm<>::Factory >	abs_criterion

std::shared_ptr< gko::stop::ImplicitResidualNorm<>::Factory >	imp_rel_criterion

std::shared_ptr< gko::stop::ImplicitResidualNorm<>::Factory >	imp_abs_criterion

std::shared_ptr< gko::log::Convergence<> >	convergence_logger

std::shared_ptr< ResidualLogger<> >	residual_logger

std::shared_ptr< gko::stop::Combined::Factory >	combined_factory

std::shared_ptr< gko::Executor >	executor

bool	needs_wrapped_vecs

bool	sub_op_needs_wrapped_vecs

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

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

Detailed Description

template<typename SolverType>
class mfem::Ginkgo::EnableGinkgoSolver< SolverType >

This class adds helper functions for updating Ginkgo factories and solvers, when the full class type is needed. The derived classes should inherit from this class, rather than from GinkgoIterativeSolver directly.

Definition at line 855 of file ginkgo.hpp.

Constructor & Destructor Documentation

◆ EnableGinkgoSolver()

template<typename SolverType >

mfem::Ginkgo::EnableGinkgoSolver< SolverType >::EnableGinkgoSolver	(	GinkgoExecutor &	exec,
		bool	use_implicit_res_norm )

inline

Definition at line 858 of file ginkgo.hpp.

Member Function Documentation

◆ SetAbsTol()

template<typename SolverType >

void mfem::Ginkgo::EnableGinkgoSolver< SolverType >::SetAbsTol ( real_t atol )

inline

Definition at line 875 of file ginkgo.hpp.

◆ SetMaxIter()

template<typename SolverType >

void mfem::Ginkgo::EnableGinkgoSolver< SolverType >::SetMaxIter ( int max_it )

inline

Definition at line 889 of file ginkgo.hpp.

◆ SetRelTol()

template<typename SolverType >

void mfem::Ginkgo::EnableGinkgoSolver< SolverType >::SetRelTol ( real_t rtol )

inline

Definition at line 861 of file ginkgo.hpp.

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

linalg/ginkgo.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EnableGinkgoSolver()

Member Function Documentation

◆ SetAbsTol()

◆ SetMaxIter()

◆ SetRelTol()