![]() |
MFEM
v4.6.0
Finite element discretization library
|
#include <ginkgo.hpp>
Public Member Functions | |
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 |
![]() | |
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... | |
![]() | |
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 void | AddMult (const Vector &x, Vector &y, const double a=1.0) const |
Operator application: y+=A(x) (default) or y+=a*A(x) . More... | |
virtual void | AddMultTranspose (const Vector &x, Vector &y, const double a=1.0) const |
Operator transpose application: y+=A^t(x) (default) or y+=a*A^t(x) . More... | |
virtual void | ArrayMult (const Array< const Vector *> &X, Array< Vector *> &Y) const |
Operator application on a matrix: Y=A(X) . More... | |
virtual void | ArrayMultTranspose (const Array< const Vector *> &X, Array< Vector *> &Y) const |
Action of the transpose operator on a matrix: Y=A^t(X) . More... | |
virtual void | ArrayAddMult (const Array< const Vector *> &X, Array< Vector *> &Y, const double a=1.0) const |
Operator application on a matrix: Y+=A(X) (default) or Y+=a*A(X) . More... | |
virtual void | ArrayAddMultTranspose (const Array< const Vector *> &X, Array< Vector *> &Y, const double a=1.0) const |
Operator transpose application on a matrix: Y+=A^t(X) (default) or Y+=a*A^t(X) . 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, int m=0) const |
Prints operator with input size n and output size m in Matlab format. More... | |
virtual void | PrintMatlab (std::ostream &out) const |
Prints operator in Matlab format. More... | |
virtual | ~Operator () |
Virtual destructor. More... | |
Type | GetType () const |
Return the type ID of the Operator class. More... | |
Protected Attributes | |
std::shared_ptr< gko::LinOpFactory > | precond_gen |
std::shared_ptr< gko::LinOp > | generated_precond |
std::shared_ptr< gko::Executor > | executor |
bool | has_generated_precond |
![]() | |
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 | |
![]() | |
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... | |
![]() | |
bool | iterative_mode |
If true, use the second argument of Mult() as an initial guess. More... | |
![]() | |
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... | |
This class forms the base class for all of Ginkgo's preconditioners. The various derived classes only take the additional data that is specific to them. The entire collection of preconditioners that Ginkgo implements is available at the Ginkgo documentation and manual pages, https://ginkgo-project.github.io/ginkgo/doc/develop.
Definition at line 508 of file ginkgo.hpp.
mfem::Ginkgo::GinkgoPreconditioner::GinkgoPreconditioner | ( | GinkgoExecutor & | exec | ) |
Constructor.
The exec
defines the paradigm where the solution is computed. Ginkgo currently supports four different executor types:
Definition at line 845 of file ginkgo.cpp.
|
virtualdefault |
Destructor.
|
inline |
Return a pointer to the LinOpFactory that will generate the preconditioner with the parameters set through the specific constructor.
Definition at line 553 of file ginkgo.hpp.
|
inline |
Return a pointer to the generated preconditioner for a specific matrix (that has previously been set with SetOperator
).
Definition at line 562 of file ginkgo.hpp.
|
inline |
Return whether this GinkgoPreconditioner object has an explicitly- generated preconditioner, built for a specific matrix.
Definition at line 571 of file ginkgo.hpp.
Apply the preconditioner to input vector x
, with out y
.
Implements mfem::Operator.
Definition at line 854 of file ginkgo.cpp.
|
virtual |
Generate the preconditioner for the given matrix op
, which must be of MFEM SparseMatrix type. Calling this function is only required when creating a preconditioner for use with another MFEM solver; to use with a Ginkgo solver, get the LinOpFactory pointer through GetFactory()
and pass to the Ginkgo solver constructor.
Implements mfem::Solver.
Reimplemented in mfem::Ginkgo::MFEMPreconditioner.
Definition at line 884 of file ginkgo.cpp.
|
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 594 of file ginkgo.hpp.
|
protected |
Generated Ginkgo preconditioner for a specific matrix, created through SetOperator()
, or a wrapped MFEM preconditioner. Must exist to use Mult()
.
Definition at line 587 of file ginkgo.hpp.
|
protected |
Whether or not we have generated a specific preconditioner for a matrix.
Definition at line 600 of file ginkgo.hpp.
|
protected |
The Ginkgo generated solver factory object.
Definition at line 574 of file ginkgo.hpp.