 |
MFEM v4.10.0
Finite element discretization library
|
Loading...
Searching...
No Matches
|
MFEM v4.10.0
Finite element discretization library
|
#include <ginkgo.hpp>
Public Member Functions | |
| SchwarzPreconditioner (GinkgoExecutor &exec, MPI_Comm comm, Solver &local_solver, const bool l1_smoother=false) | |
| void | SetOperator (const Operator &op) override |
 Public Member Functions inherited from mfem::Ginkgo::GinkgoPreconditioner | |
| GinkgoPreconditioner (GinkgoExecutor &exec) | |
| GinkgoPreconditioner (GinkgoExecutor &exec, MPI_Comm comm) | |
| virtual | ~GinkgoPreconditioner ()=default |
| void | Mult (const Vector &x, Vector &y) const override |
| 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. | |
| 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 | AbsMult (const Vector &x, Vector &y) const |
Action of the absolute-value operator: y=|A|(x). The default behavior in class Operator is to generate an error. If the Operator is a composition of several operators, the composition unfold into a product of absolute-value operators too. | |
| 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 | AbsMultTranspose (const Vector &x, Vector &y) const |
Action of the transpose absolute-value 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 void | MultMV (const MultiVector &x, MultiVector &y) const |
| Operator application, y = A(x), where the input x and the output y are MultiVector objects, i.e. they generally use non-contiguous memory representation. | |
| virtual void | MultTransposeMV (const MultiVector &x, MultiVector &y) const |
| Action of the transpose operator, y = A^t(x), where the input x and the output y are MultiVector objects, i.e. they generally use non-contiguous memory representation. | |
| 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 Operator & | GetGradientMV (const MultiVector &x) const |
| Evaluate the gradient operator at the point x. The input x is provided as a MultiVector, i.e. it generally uses non-contiguous memory representation. | |
| 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::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::GinkgoPreconditioner | |
| std::shared_ptr< gko::LinOpFactory > | precond_gen |
| std::shared_ptr< gko::LinOp > | generated_precond |
| std::shared_ptr< gko::Executor > | executor |
| std::shared_ptr< gko::experimental::mpi::communicator > | gko_comm |
| bool | has_generated_precond |
| 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. | |
An implementation of the preconditioner interface using the Ginkgo Schwarz preconditioner, a simple domain decomposition method for distributed problems. The local solver should be another GinkgoPreconditioner or GinkgoIterativeSolver type. Furthermore, the local solver should be "Ginkgo native", i.e., not an MFEM Solver wrapped with the MFEMPreconditioner.
Definition at line 1925 of file ginkgo.hpp.
| mfem::Ginkgo::SchwarzPreconditioner::SchwarzPreconditioner | ( | GinkgoExecutor & | exec, |
| MPI_Comm | comm, | ||
| Solver & | local_solver, | ||
| const bool | l1_smoother = false ) |
Constructor.
| [in] | exec | The execution paradigm for the preconditioner. |
| [in] | comm | The MPI Communicator associated with the problem. |
| [in] | local_solver | The local solver. Must be derived from GinkgoIterativeSolver or GinkgoPreconditioner. |
| [in] | l1_smoother | Whether to use L1 smoothing, where the sum of each row is added to the diagonal. Only possible if using an assembled matrix operator and if local_solver does not already have a generated solver/preconditioner for the matrix. See the Ginkgo documentation for more information on this preconditioner. |
Definition at line 1915 of file ginkgo.cpp.
|
overridevirtual |
Generate the preconditioner for the given matrix op, which must be of MFEM HypreParMatrix 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. The SchwarzPreconditioner currently needs its own override because it potentially requires sorting of the diagonal matrix in the case of L1 smoothing.
Reimplemented from mfem::Ginkgo::GinkgoPreconditioner.
Definition at line 1972 of file ginkgo.cpp.
1.11.0