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

Abstract operator. More...

#include <operator.hpp>

Inherited by BackwardEulerOperator, BackwardEulerOperator, mfem::BlockOperator, mfem::HypreParMatrix, mfem::IdentityOperator, mfem::Matrix, mfem::miniapps::IrrotationalProjector, mfem::NonlinearForm, mfem::RAPOperator, mfem::Solver, mfem::SuperLURowLocMatrix, mfem::TBilinearForm< meshType, solFESpace, IR, IntegratorType, solVecLayout_t, complex_t, real_t >, mfem::TimeDependentOperator, mfem::TransposeOperator, and mfem::TripleProductOperator.

Public Member Functions

 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 ()
 

Protected Attributes

int height
 
int width
 

Detailed Description

Abstract operator.

Definition at line 21 of file operator.hpp.

Constructor & Destructor Documentation

mfem::Operator::Operator ( int  s = 0)
inlineexplicit

Construct a square Operator with given size s (default 0)

Definition at line 28 of file operator.hpp.

mfem::Operator::Operator ( int  h,
int  w 
)
inline

Construct an Operator with the given height (output size) and width (input size).

Definition at line 32 of file operator.hpp.

virtual mfem::Operator::~Operator ( )
inlinevirtual

Definition at line 63 of file operator.hpp.

Member Function Documentation

virtual Operator& mfem::Operator::GetGradient ( const Vector x) const
inlinevirtual

Evaluate the gradient operator at the point x.

Reimplemented in mfem::NonlinearForm, and mfem::ParNonlinearForm.

Definition at line 54 of file operator.hpp.

int mfem::Operator::Height ( ) const
inline

Get the height (size of output) of the Operator. Synonym with NumRows.

Definition at line 35 of file operator.hpp.

virtual void mfem::Operator::Mult ( const Vector x,
Vector y 
) const
pure virtual
virtual void mfem::Operator::MultTranspose ( const Vector x,
Vector y 
) const
inlinevirtual
int mfem::Operator::NumCols ( ) const
inline

Get the number of columns (size of input) of the Operator. Synonym with Width.

Definition at line 44 of file operator.hpp.

int mfem::Operator::NumRows ( ) const
inline

Get the number of rows (size of output) of the Operator. Synonym with Height.

Definition at line 38 of file operator.hpp.

void mfem::Operator::PrintMatlab ( std::ostream &  out,
int  n = 0,
int  m = 0 
) const

Prints operator with input size n and output size m in matlab format.

Definition at line 21 of file operator.cpp.

int mfem::Operator::Width ( ) const
inline

Get the width (size of input) of the Operator. Synonym with NumCols.

Definition at line 41 of file operator.hpp.

Member Data Documentation

int mfem::Operator::height
protected

Definition at line 24 of file operator.hpp.

int mfem::Operator::width
protected

Definition at line 24 of file operator.hpp.


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