 |
MFEM v4.7.0
Finite element discretization library
|
Loading...
Searching...
No Matches
|
MFEM v4.7.0
Finite element discretization library
|
The ParaSails preconditioner in hypre. More...
#include <hypre.hpp>
Public Member Functions | |
| HypreParaSails (MPI_Comm comm) | |
| HypreParaSails (const HypreParMatrix &A) | |
| virtual void | SetOperator (const Operator &op) |
| Set/update the solver for the given operator. | |
| void | SetParams (real_t thresh, int nlevels) |
| Set the threshold and levels parameters. | |
| void | SetFilter (real_t filter) |
| Set the filter parameter. | |
| void | SetSymmetry (int sym) |
| Set symmetry parameter. | |
| void | SetLoadBal (real_t loadbal) |
| Set the load balance parameter. | |
| void | SetReuse (int reuse) |
| Set the pattern reuse parameter. | |
| void | SetLogging (int logging) |
| Set the logging parameter. | |
| virtual | operator HYPRE_Solver () const |
| The typecast to HYPRE_Solver returns the internal sai_precond. | |
| virtual HYPRE_PtrToParSolverFcn | SetupFcn () const |
| hypre's internal Setup function | |
| virtual HYPRE_PtrToParSolverFcn | SolveFcn () const |
| hypre's internal Solve function | |
| virtual | ~HypreParaSails () |
 Public Member Functions inherited from mfem::HypreSolver | |
| HypreSolver () | |
| HypreSolver (const HypreParMatrix *A_) | |
| virtual MemoryClass | GetMemoryClass () const |
| Return the MemoryClass preferred by the Operator. | |
| void | SetErrorMode (ErrorMode err_mode) const |
| Set the behavior for treating hypre errors, see the ErrorMode enum. The default mode in the base class is ABORT_HYPRE_ERRORS. | |
| virtual | ~HypreSolver () |
| virtual void | Setup (const HypreParVector &b, HypreParVector &x) const |
| Set up the solver (if not set up already, also called automatically by HypreSolver::Mult). | |
| virtual void | Setup (const Vector &b, Vector &x) const |
| Set up the solver (if not set up already, also called automatically by HypreSolver::Mult). | |
| virtual void | Mult (const HypreParVector &b, HypreParVector &x) const |
| Solve the linear system Ax=b. | |
| virtual void | Mult (const Vector &b, Vector &x) const |
| Solve the linear system Ax=b. | |
| 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 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::HypreSolver | |
| enum | ErrorMode { IGNORE_HYPRE_ERRORS , WARN_HYPRE_ERRORS , ABORT_HYPRE_ERRORS } |
| How to treat errors returned by hypre function calls. More... | |
| 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::HypreSolver | |
| bool | WrapVectors (const Vector &b, Vector &x) const |
| Makes the internal HypreParVectors B and X wrap the input vectors b and x. | |
| 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::HypreSolver | |
| const HypreParMatrix * | A |
| The linear system matrix. | |
| HypreParVector * | B |
| Right-hand side and solution vector. | |
| HypreParVector * | X |
| Memory< real_t > | auxB |
| Memory< real_t > | auxX |
| int | setup_called |
| Was hypre's Setup function called already? | |
| ErrorMode | error_mode |
| How to treat hypre errors. | |
| 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. | |
| mfem::HypreParaSails::HypreParaSails | ( | const HypreParMatrix & | A | ) |
|
inlinevirtual |
The typecast to HYPRE_Solver returns the internal sai_precond.
Implements mfem::HypreSolver.
| void mfem::HypreParaSails::SetFilter | ( | real_t | filter | ) |
| void mfem::HypreParaSails::SetLoadBal | ( | real_t | loadbal | ) |
Set the load balance parameter.
A zero value indicates that no load balance is attempted; a value of unity indicates that perfect load balance will be attempted. The recommended value is 0.9 to balance the overhead of data exchanges for load balancing. No load balancing is needed if the preconditioner is very sparse and fast to construct. The default value is 0.
| void mfem::HypreParaSails::SetLogging | ( | int | logging | ) |
|
virtual |
Set/update the solver for the given operator.
Reimplemented from mfem::HypreSolver.
| void mfem::HypreParaSails::SetParams | ( | real_t | thresh, |
| int | nlevels ) |
Set the threshold and levels parameters.
The accuracy and cost of ParaSails are parametrized by the real thresh and integer nlevels parameters (0<=thresh<=1, 0<=nlevels). Lower values of thresh and higher values of nlevels lead to more accurate, but more expensive preconditioners. More accurate preconditioners are also more expensive per iteration. The default values are thresh = 0.1 and nlevels = 1.
| void mfem::HypreParaSails::SetReuse | ( | int | reuse | ) |
Set the pattern reuse parameter.
A nonzero value indicates that the pattern of the preconditioner should be reused for subsequent constructions of the proconditioner. A zero value inicates that the peconditioner should be constructed from scratch. The default value is 0.
| void mfem::HypreParaSails::SetSymmetry | ( | int | sym | ) |
|
inlinevirtual |
hypre's internal Setup function
Implements mfem::HypreSolver.
|
inlinevirtual |
hypre's internal Solve function
Implements mfem::HypreSolver.
1.11.0