MFEM  v3.2
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>

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

Public Member Functions

 Solver (int s=0, bool iter_mode=false)
 
 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)
 
int Height () const
 Get the height (size of output) of the Operator. Synonym with NumRows. More...
 
int NumRows () const
 
int Width () const
 Get the width (size of input) of the Operator. Synonym with NumCols. More...
 
int NumCols () const
 
virtual void Mult (const Vector &x, Vector &y) const =0
 Operator application. More...
 
virtual void MultTranspose (const Vector &x, Vector &y) const
 Action of the transpose operator. More...
 
virtual OperatorGetGradient (const Vector &x) const
 Evaluate the gradient operator at the point x. 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 ()
 

Public Attributes

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

Additional Inherited Members

- Protected Attributes inherited from mfem::Operator
int height
 
int width
 

Detailed Description

Base class for solvers.

Definition at line 102 of file operator.hpp.

Constructor & Destructor Documentation

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 111 of file operator.hpp.

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

Initialize a Solver with height 'h' and width 'w'.

Definition at line 115 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 106 of file operator.hpp.


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