MFEM  v4.3.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mfem::Ginkgo::GinkgoIterativeSolver Class Reference

#include <ginkgo.hpp>

Inheritance diagram for mfem::Ginkgo::GinkgoIterativeSolver:
[legend]
Collaboration diagram for mfem::Ginkgo::GinkgoIterativeSolver:
[legend]

Public Member Functions

const std::shared_ptr
< gko::LinOpFactory > 
GetFactory () const
 
void SetPrintLevel (int print_lvl)
 
int GetNumIterations () const
 
int GetConverged () const
 
double 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. 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 OperatorGetGradient (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 OperatorGetProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity. More...
 
virtual const OperatorGetRestriction () const
 Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. NULL means identity. More...
 
virtual const OperatorGetOutputProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. NULL means identity. More...
 
virtual const OperatorGetOutputRestrictionTranspose () const
 Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators. More...
 
virtual const OperatorGetOutputRestriction () 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...
 

Protected Member Functions

 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() More...
 
void FormRectangularConstrainedSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, RectangularConstrainedOperator *&Aout)
 see FormRectangularSystemOperator() More...
 
OperatorSetupRAP (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

bool use_implicit_res_norm
 
int print_level
 
int max_iter
 
double rel_tol
 
double abs_tol
 
double 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. More...
 
int width
 Dimension of the input / number of columns in the matrix. 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...
 

Detailed Description

This class forms the base class for all of Ginkgo's iterative solvers. It is not intended to be used directly by MFEM applications. The various derived classes only take the additional data that is specific to them and solve the given linear system. The entire collection of solvers that Ginkgo implements is available at the Ginkgo documentation and manual pages, https://ginkgo-project.github.io/ginkgo/doc/develop.

Definition at line 597 of file ginkgo.hpp.

Constructor & Destructor Documentation

virtual mfem::Ginkgo::GinkgoIterativeSolver::~GinkgoIterativeSolver ( )
virtualdefault

Destructor.

mfem::Ginkgo::GinkgoIterativeSolver::GinkgoIterativeSolver ( GinkgoExecutor exec,
bool  use_implicit_res_norm 
)
protected

Constructor.

The exec defines the paradigm where the solution is computed. use_implicit_res_norm is for internal use by the derived classes for specific Ginkgo solvers; it indicates whether the solver makes an implicit residual norm estimate available for convergence checking. Each derived class automatically sets the correct value when calling this base class constructor.

Definition at line 121 of file ginkgo.cpp.

Member Function Documentation

int mfem::Ginkgo::GinkgoIterativeSolver::GetConverged ( ) const
inline

Definition at line 612 of file ginkgo.hpp.

const std::shared_ptr<gko::LinOpFactory> mfem::Ginkgo::GinkgoIterativeSolver::GetFactory ( ) const
inline

Return a pointer to the LinOpFactory that will generate the solver with the parameters set through the specific constructor.

Definition at line 604 of file ginkgo.hpp.

double mfem::Ginkgo::GinkgoIterativeSolver::GetFinalNorm ( ) const
inline

Definition at line 613 of file ginkgo.hpp.

int mfem::Ginkgo::GinkgoIterativeSolver::GetNumIterations ( ) const
inline

Definition at line 611 of file ginkgo.hpp.

void mfem::Ginkgo::GinkgoIterativeSolver::Mult ( const Vector x,
Vector y 
) const
virtual

Solve the linear system Ax=y. Dependent on the information provided by derived classes one of Ginkgo's linear solvers is chosen.

Implements mfem::Operator.

Definition at line 282 of file ginkgo.cpp.

void mfem::Ginkgo::GinkgoIterativeSolver::SetOperator ( const Operator op)
virtual

If the Operator is a SparseMatrix, set up a Ginkgo Csr matrix to use its data directly. If the Operator is not a matrix, create an OperatorWrapper for it and store.

Implements mfem::Solver.

Definition at line 410 of file ginkgo.cpp.

void mfem::Ginkgo::GinkgoIterativeSolver::SetPrintLevel ( int  print_lvl)
inline

Definition at line 609 of file ginkgo.hpp.

void mfem::Ginkgo::GinkgoIterativeSolver::update_stop_factory ( )
protected

Rebuild the Ginkgo stopping criterion factory with the latest values of rel_tol, abs_tol, and max_iter.

Definition at line 139 of file ginkgo.cpp.

bool mfem::Ginkgo::GinkgoIterativeSolver::UsesVectorWrappers ( ) const
inline

Return whether this GinkgoIterativeSolver object will use VectorWrapper types for input and output vectors. Note that Mult() will automatically create these wrappers if needed.

Definition at line 633 of file ginkgo.hpp.

Member Data Documentation

std::shared_ptr<gko::stop::ResidualNorm<>::Factory> mfem::Ginkgo::GinkgoIterativeSolver::abs_criterion
protected

The residual criterion object that controls the reduction of the residual based on an absolute tolerance.

Definition at line 689 of file ginkgo.hpp.

double mfem::Ginkgo::GinkgoIterativeSolver::abs_tol
protected

Definition at line 662 of file ginkgo.hpp.

std::shared_ptr<gko::stop::Combined::Factory> mfem::Ginkgo::GinkgoIterativeSolver::combined_factory
protected

The Ginkgo combined factory object is used to create a combined stopping criterion to be passed to the solver.

Definition at line 721 of file ginkgo.hpp.

int mfem::Ginkgo::GinkgoIterativeSolver::converged
mutableprotected

Definition at line 665 of file ginkgo.hpp.

std::shared_ptr<gko::log::Convergence<> > mfem::Ginkgo::GinkgoIterativeSolver::convergence_logger
mutableprotected

The Ginkgo convergence logger used to check for convergence and other solver data if needed.

Definition at line 709 of file ginkgo.hpp.

std::shared_ptr<gko::Executor> mfem::Ginkgo::GinkgoIterativeSolver::executor
protected

The execution paradigm in Ginkgo. The choices are between gko::OmpExecutor, gko::CudaExecutor and gko::ReferenceExecutor and more details can be found in Ginkgo's documentation.

Definition at line 728 of file ginkgo.hpp.

int mfem::Ginkgo::GinkgoIterativeSolver::final_iter
mutableprotected

Definition at line 664 of file ginkgo.hpp.

double mfem::Ginkgo::GinkgoIterativeSolver::final_norm
mutableprotected

Definition at line 663 of file ginkgo.hpp.

std::shared_ptr<gko::stop::ImplicitResidualNorm<>::Factory> mfem::Ginkgo::GinkgoIterativeSolver::imp_abs_criterion
protected

The implicit residual criterion object that controls the reduction of the residual based on an absolute tolerance, based on an implicit residual norm value.

Definition at line 703 of file ginkgo.hpp.

std::shared_ptr<gko::stop::ImplicitResidualNorm<>::Factory> mfem::Ginkgo::GinkgoIterativeSolver::imp_rel_criterion
protected

The implicit residual criterion object that controls the reduction of the residual relative to the initial residual, based on an implicit residual norm value.

Definition at line 696 of file ginkgo.hpp.

int mfem::Ginkgo::GinkgoIterativeSolver::max_iter
protected

Definition at line 660 of file ginkgo.hpp.

bool mfem::Ginkgo::GinkgoIterativeSolver::needs_wrapped_vecs
protected

Whether or not we need to use VectorWrapper types with this solver.

Definition at line 733 of file ginkgo.hpp.

int mfem::Ginkgo::GinkgoIterativeSolver::print_level
protected

Definition at line 659 of file ginkgo.hpp.

std::shared_ptr<gko::stop::ResidualNorm<>::Factory> mfem::Ginkgo::GinkgoIterativeSolver::rel_criterion
protected

The residual criterion object that controls the reduction of the residual relative to the initial residual.

Definition at line 682 of file ginkgo.hpp.

double mfem::Ginkgo::GinkgoIterativeSolver::rel_tol
protected

Definition at line 661 of file ginkgo.hpp.

std::shared_ptr<ResidualLogger<> > mfem::Ginkgo::GinkgoIterativeSolver::residual_logger
mutableprotected

The residual logger object used to check for convergence and other solver data if needed.

Definition at line 715 of file ginkgo.hpp.

std::shared_ptr<gko::LinOp> mfem::Ginkgo::GinkgoIterativeSolver::solver
protected

The Ginkgo solver object, generated for a specific operator.

Definition at line 675 of file ginkgo.hpp.

std::shared_ptr<gko::LinOpFactory> mfem::Ginkgo::GinkgoIterativeSolver::solver_gen
protected

The Ginkgo solver factory object, to generate specific solvers.

Definition at line 670 of file ginkgo.hpp.

bool mfem::Ginkgo::GinkgoIterativeSolver::sub_op_needs_wrapped_vecs
protected

Whether or not we need to use VectorWrapper types with the preconditioner or an inner solver. This value is set upon creation of the GinkgoIterativeSolver object and should never change.

Definition at line 740 of file ginkgo.hpp.

bool mfem::Ginkgo::GinkgoIterativeSolver::use_implicit_res_norm
protected

Definition at line 658 of file ginkgo.hpp.


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