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

Abstract data type matrix. More...

#include <matrix.hpp>

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

Public Member Functions

 Matrix (int s)
 Creates a square matrix of size s. More...
 
 Matrix (int h, int w)
 Creates a matrix of the given height and width. More...
 
virtual double & Elem (int i, int j)=0
 Returns reference to a_{ij}. More...
 
virtual const double & Elem (int i, int j) const =0
 Returns constant reference to a_{ij}. More...
 
virtual MatrixInverseInverse () const =0
 Returns a pointer to (an approximation) of the matrix inverse. More...
 
virtual void Finalize (int)
 Finalizes the matrix initialization. More...
 
virtual void Print (std::ostream &out=std::cout, int width_=4) const
 Prints matrix to stream out. More...
 
virtual ~Matrix ()
 Destroys matrix. 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)
 Prints operator with input size n and output size m in matlab format. More...
 
virtual ~Operator ()
 

Friends

class MatrixInverse
 

Additional Inherited Members

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

Detailed Description

Abstract data type matrix.

Definition at line 27 of file matrix.hpp.

Constructor & Destructor Documentation

mfem::Matrix::Matrix ( int  s)
inlineexplicit

Creates a square matrix of size s.

Definition at line 32 of file matrix.hpp.

mfem::Matrix::Matrix ( int  h,
int  w 
)
inlineexplicit

Creates a matrix of the given height and width.

Definition at line 35 of file matrix.hpp.

virtual mfem::Matrix::~Matrix ( )
inlinevirtual

Destroys matrix.

Definition at line 53 of file matrix.hpp.

Member Function Documentation

virtual double& mfem::Matrix::Elem ( int  i,
int  j 
)
pure virtual
virtual const double& mfem::Matrix::Elem ( int  i,
int  j 
) const
pure virtual

Returns constant reference to a_{ij}.

Implemented in mfem::MixedBilinearForm, mfem::SparseMatrix, mfem::BilinearForm, mfem::DenseMatrix, and mfem::BlockMatrix.

virtual void mfem::Matrix::Finalize ( int  )
inlinevirtual

Finalizes the matrix initialization.

Reimplemented in mfem::MixedBilinearForm, mfem::SparseMatrix, and mfem::BilinearForm.

Definition at line 47 of file matrix.hpp.

virtual MatrixInverse* mfem::Matrix::Inverse ( ) const
pure virtual

Returns a pointer to (an approximation) of the matrix inverse.

Implemented in mfem::MixedBilinearForm, mfem::SparseMatrix, mfem::BilinearForm, mfem::DenseMatrix, and mfem::BlockMatrix.

void mfem::Matrix::Print ( std::ostream &  out = std::cout,
int  width_ = 4 
) const
virtual

Prints matrix to stream out.

Reimplemented in mfem::SparseMatrix, and mfem::DenseMatrix.

Definition at line 22 of file matrix.cpp.

Friends And Related Function Documentation

friend class MatrixInverse
friend

Definition at line 29 of file matrix.hpp.


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