Abstract data type matrix. More...

#include <matrix.hpp>

Inheritance diagram for mfem::Matrix:

Collaboration diagram for mfem::Matrix:

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 MatrixInverse *	Inverse () 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=mfem::out, 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)
	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 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 Operator &	GetGradient (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 Operator *	GetProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. `NULL` means identity. More...

virtual const Operator *	GetRestriction () 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...

Friends
class	MatrixInverse

Additional Inherited Members
Public Types inherited from mfem::Operator
enum	Type { MFEM_SPARSEMAT, Hypre_ParCSR, PETSC_MATAIJ, PETSC_MATIS, PETSC_MATSHELL, PETSC_MATNEST, PETSC_MATHYPRE, PETSC_MATGENERIC }
	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

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

Returns reference to a_{ij}.

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

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 = `mfem::out`,
		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:

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation