MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
mfem::Solver Class Referenceabstract

Base class for solvers. More...

#include <operator.hpp>

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

Public Member Functions

 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.
 
virtual void SetOperator (const Operator &op)=0
 Set/update the solver for the given operator.
 
- 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 Mult (const Vector &x, Vector &y) const =0
 Operator application: y=A(x).
 
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 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.
 

Public Attributes

bool iterative_mode
 If true, use the second argument of Mult() as an initial guess.
 

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...
 
- 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::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

Base class for solvers.

Definition at line 682 of file operator.hpp.

Constructor & Destructor Documentation

◆ Solver() [1/2]

mfem::Solver::Solver ( int  s = 0,
bool  iter_mode = false 
)
inlineexplicit

Initialize a square Solver with size s.

Warning
Use a Boolean expression for the second parameter (not an int) to distinguish this call from the general rectangular constructor.

Definition at line 692 of file operator.hpp.

◆ Solver() [2/2]

mfem::Solver::Solver ( int  h,
int  w,
bool  iter_mode = false 
)
inline

Initialize a Solver with height h and width w.

Definition at line 696 of file operator.hpp.

Member Function Documentation

◆ SetOperator()

virtual void mfem::Solver::SetOperator ( const Operator op)
pure virtual

Set/update the solver for the given operator.

Implemented in mfem::ceed::AlgebraicSolver, mfem::ceed::AlgebraicMultigrid, mfem::SparseSmoother, mfem::DGMassInverse, mfem::LORSolver< SolverType >, mfem::LORSolver< HypreAMS >, mfem::LORSolver< HypreADS >, mfem::AmgXSolver, mfem::MatrixFreeAuxiliarySpace, mfem::GeneralAMS, mfem::MatrixFreeAMS, mfem::BlockDiagonalPreconditioner, mfem::BlockLowerTriangularPreconditioner, mfem::ComplexUMFPackSolver, mfem::DenseMatrixInverse, mfem::Ginkgo::GinkgoPreconditioner, mfem::Ginkgo::GinkgoIterativeSolver, mfem::Ginkgo::MFEMPreconditioner, mfem::HypreSmoother, mfem::HypreSolver, mfem::HyprePCG, mfem::HypreGMRES, mfem::HypreFGMRES, mfem::HypreDiagScale, mfem::HypreParaSails, mfem::HypreEuclid, mfem::HypreILU, mfem::HypreBoomerAMG, mfem::HypreAMS, mfem::HypreADS, mfem::MUMPSSolver, mfem::PetscLinearSolver, mfem::PetscPreconditioner, mfem::PetscNonlinearSolver, mfem::OperatorJacobiSmoother, mfem::SLISolver, mfem::CGSolver, mfem::BiCGSTABSolver, mfem::MINRESSolver, mfem::NewtonSolver, mfem::LBFGSSolver, mfem::OptimizationSolver, mfem::BlockILU, mfem::UMFPackSolver, mfem::KLUSolver, mfem::DirectSubBlockSolver, mfem::ProductSolver, mfem::OrthoSolver, mfem::AuxSpaceSmoother, mfem::STRUMPACKSolverBase< STRUMPACKSolverType >, mfem::STRUMPACKSolverBase< strumpack::SparseSolverMixedPrecisionMPIDist< float, double, HYPRE_BigInt > >, mfem::STRUMPACKSolverBase< strumpack::SparseSolverMPIDist< double, HYPRE_BigInt > >, mfem::KINSolver, mfem::SuperLUSolver, mfem::blocksolvers::BPCGSolver, mfem::blocksolvers::BramblePasciakSolver, mfem::blocksolvers::BDPMinresSolver, mfem::blocksolvers::BBTSolver, mfem::blocksolvers::SaddleSchwarzSmoother, mfem::blocksolvers::LocalSolver, mfem::blocksolvers::DivFreeSolver, mfem::MultigridBase, mfem::ConstrainedSolver, mfem::EliminationSolver, mfem::PenaltyConstrainedSolver, mfem::CPardisoSolver, mfem::PardisoSolver, mfem::IterativeSolver, mfem::NNLSSolver, mfem::HdivSaddlePointSolver, mfem::ElasticityDiagonalPreconditioner, and mfem::OperatorChebyshevSmoother.

Member Data Documentation

◆ iterative_mode

bool mfem::Solver::iterative_mode

If true, use the second argument of Mult() as an initial guess.

Definition at line 686 of file operator.hpp.


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