MFEM  v4.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Public Attributes | List of all members
mfem::Solver Class Referenceabstract

Base class for solvers. More...

#include <operator.hpp>

Inherits mfem::Operator.

Inherited by JacobianPreconditioner, JacobianPreconditioner, mfem::BlockDiagonalPreconditioner, mfem::BlockLowerTriangularPreconditioner, mfem::HypreSmoother, mfem::HypreSolver, mfem::IterativeSolver, mfem::KLUSolver, mfem::MatrixInverse, mfem::PetscLinearSolver, mfem::PetscNonlinearSolver, mfem::PetscPreconditioner, mfem::STRUMPACKSolver, mfem::SuperLUSolver, and mfem::UMFPackSolver.

Collaboration diagram for mfem::Solver:

Public Member Functions

 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...
virtual void SetOperator (const Operator &op)=0
 Set/update the solver for the given operator. More...
- Public Member Functions inherited from mfem::Operator
 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 Mult (const Vector &x, Vector &y) const =0
 Operator application: y=A(x). 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 OperatorGetGradient (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 const OperatorGetProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity. More...
virtual const OperatorGetRestriction () const
 Restriction operator from input 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...
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(). More...
void PrintMatlab (std::ostream &out, int n=0, int m=0) const
 Prints operator with input size n and output size m in Matlab format. More...
virtual ~Operator ()
 Virtual destructor. More...
Type GetType () const
 Return the type ID of the Operator class. More...

Public Attributes

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

Additional Inherited Members

- Public Types inherited from mfem::Operator
enum  Type {
 Enumeration defining IDs for some classes derived from Operator. More...
- Protected Attributes inherited from mfem::Operator
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...

Detailed Description

Base class for solvers.

Definition at line 279 of file operator.hpp.

Constructor & Destructor Documentation

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

Initialize a square Solver with size s.

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

Definition at line 289 of file operator.hpp.

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

Initialize a Solver with height h and width w.

Definition at line 293 of file operator.hpp.

Member Function Documentation

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

Member Data Documentation

bool mfem::Solver::iterative_mode

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

Definition at line 283 of file operator.hpp.

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