MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
mfem::STRUMPACKMixedPrecisionSolver Class Reference

#include <strumpack.hpp>

Inheritance diagram for mfem::STRUMPACKMixedPrecisionSolver:
[legend]
Collaboration diagram for mfem::STRUMPACKMixedPrecisionSolver:
[legend]

Public Member Functions

 STRUMPACKMixedPrecisionSolver (MPI_Comm comm)
 Constructor with MPI_Comm parameter.
 
 STRUMPACKMixedPrecisionSolver (STRUMPACKRowLocMatrix &A)
 Constructor with STRUMPACK matrix object.
 
 STRUMPACKMixedPrecisionSolver (MPI_Comm comm, int argc, char *argv[])
 Constructor with MPI_Comm parameter and command line arguments.
 
 STRUMPACKMixedPrecisionSolver (STRUMPACKRowLocMatrix &A, int argc, char *argv[])
 Constructor with STRUMPACK matrix object and command line arguments.
 
 ~STRUMPACKMixedPrecisionSolver ()
 Destructor.
 
- Public Member Functions inherited from mfem::STRUMPACKSolverBase< strumpack::SparseSolverMixedPrecisionMPIDist< float, double, HYPRE_BigInt > >
virtual ~STRUMPACKSolverBase ()
 Default destructor.
 
void Mult (const Vector &x, Vector &y) const
 Factor and solve the linear system \(y = Op^{-1} x \).
 
void ArrayMult (const Array< const Vector * > &X, Array< Vector * > &Y) const
 Factor and solve the linear systems \( Y_i = Op^{-1} X_i \) across the array of vectors.
 
void SetOperator (const Operator &op)
 Set the operator/matrix.
 
void SetFromCommandLine ()
 Set options that were captured from the command line.
 
void SetPrintFactorStatistics (bool print_stat)
 Set up verbose printing during the factor step.
 
void SetPrintSolveStatistics (bool print_stat)
 Set up verbose printing during the solve step.
 
void SetRelTol (double rtol)
 Set the relative tolerance for interative solvers.
 
void SetAbsTol (double atol)
 Set the absolute tolerance for iterative solvers.
 
void SetMaxIter (int max_it)
 Set the maximum number of iterations for iterative solvers.
 
void SetReorderingReuse (bool reuse)
 Set the flag controlling reuse of the symbolic factorization for multiple operators.
 
void EnableGPU ()
 Enable GPU off-loading available if STRUMPACK was compiled with CUDA.
 
void DisableGPU ()
 Disable GPU off-loading available if STRUMPACK was compiled with CUDA.
 
void SetKrylovSolver (strumpack::KrylovSolver method)
 Set the Krylov solver method to use.
 
void SetReorderingStrategy (strumpack::ReorderingStrategy method)
 Set matrix reordering strategy.
 
void SetMatching (strumpack::MatchingJob job)
 Configure static pivoting for stability.
 
void SetCompression (strumpack::CompressionType type)
 Select compression for sparse data types.
 
void SetCompressionRelTol (double rtol)
 Set the relative tolerance for low rank compression methods.
 
void SetCompressionAbsTol (double atol)
 Set the absolute tolerance for low rank compression methods.
 
void SetCompressionLossyPrecision (int precision)
 Set the precision for the lossy compression option.
 
void SetCompressionButterflyLevels (int levels)
 Set the number of butterfly levels for the HODLR compression option.
 
- 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 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 OperatorGetGradient (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 OperatorGetProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity.
 
virtual const OperatorGetRestriction () const
 Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. NULL means identity.
 
virtual const OperatorGetOutputProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. NULL means identity.
 
virtual const OperatorGetOutputRestrictionTranspose () const
 Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators.
 
virtual const OperatorGetOutputRestriction () 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::STRUMPACKSolverBase< strumpack::SparseSolverMixedPrecisionMPIDist< float, double, HYPRE_BigInt > >
 STRUMPACKSolverBase (MPI_Comm comm, int argc, char *argv[])
 Constructor with MPI_Comm parameter and command line arguments.
 
 STRUMPACKSolverBase (STRUMPACKRowLocMatrix &A, int argc, char *argv[])
 Constructor with STRUMPACK matrix object and command line arguments.
 
- 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()
 
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".
 
- Protected Attributes inherited from mfem::STRUMPACKSolverBase< strumpack::SparseSolverMixedPrecisionMPIDist< float, double, HYPRE_BigInt > >
const STRUMPACKRowLocMatrixAPtr_
 
strumpack::SparseSolverMixedPrecisionMPIDist< float, double, HYPRE_BigInt > * solver_
 
bool factor_verbose_
 
bool solve_verbose_
 
bool reorder_reuse_
 
Vector rhs_
 
Vector sol_
 
int nrhs_
 
- 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

Definition at line 315 of file strumpack.hpp.

Constructor & Destructor Documentation

◆ STRUMPACKMixedPrecisionSolver() [1/4]

mfem::STRUMPACKMixedPrecisionSolver::STRUMPACKMixedPrecisionSolver ( MPI_Comm comm)

Constructor with MPI_Comm parameter.

Definition at line 452 of file strumpack.cpp.

◆ STRUMPACKMixedPrecisionSolver() [2/4]

mfem::STRUMPACKMixedPrecisionSolver::STRUMPACKMixedPrecisionSolver ( STRUMPACKRowLocMatrix & A)

Constructor with STRUMPACK matrix object.

Definition at line 458 of file strumpack.cpp.

◆ STRUMPACKMixedPrecisionSolver() [3/4]

mfem::STRUMPACKMixedPrecisionSolver::STRUMPACKMixedPrecisionSolver ( MPI_Comm comm,
int argc,
char * argv[] )

Constructor with MPI_Comm parameter and command line arguments.

SetFromCommandLine must be called for the command line arguments to be used.

Definition at line 464 of file strumpack.cpp.

◆ STRUMPACKMixedPrecisionSolver() [4/4]

mfem::STRUMPACKMixedPrecisionSolver::STRUMPACKMixedPrecisionSolver ( STRUMPACKRowLocMatrix & A,
int argc,
char * argv[] )

Constructor with STRUMPACK matrix object and command line arguments.

SetFromCommandLine must be called for the command line arguments to be used.

Definition at line 470 of file strumpack.cpp.

◆ ~STRUMPACKMixedPrecisionSolver()

mfem::STRUMPACKMixedPrecisionSolver::~STRUMPACKMixedPrecisionSolver ( )
inline

Destructor.

Definition at line 343 of file strumpack.hpp.


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