mfem::TripleProductOperator Class Reference

General triple product operator x -> A*B*C*x, with ownership of the factors. More...

#include <operator.hpp>

Inheritance diagram for mfem::TripleProductOperator:

Collaboration diagram for mfem::TripleProductOperator:

Public Member Functions
	TripleProductOperator (const Operator *A, const Operator *B, const Operator *C, bool ownA, bool ownB, bool ownC)
virtual MemoryClass	GetMemoryClass () const
	Return the MemoryClass preferred by the Operator. More...
virtual void	Mult (const Vector &x, Vector &y) const
	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	~TripleProductOperator ()
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 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...
Type	GetType () const
	Return the type ID of the Operator class. More...

Additional Inherited Members
Public Types inherited from mfem::Operator
enum	Type {   ANY_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

General triple product operator x -> A*B*C*x, with ownership of the factors.

Definition at line 390 of file operator.hpp.

Constructor & Destructor Documentation

mfem::TripleProductOperator::TripleProductOperator	(	const Operator *	A,
		const Operator *	B,
		const Operator *	C,
		bool	ownA,
		bool	ownB,
		bool	ownC
	)

Definition at line 139 of file operator.cpp.

mfem::TripleProductOperator::~TripleProductOperator ( )

virtual

Definition at line 159 of file operator.cpp.

Member Function Documentation

virtual MemoryClass mfem::TripleProductOperator::GetMemoryClass ( ) const

inlinevirtual

Return the MemoryClass preferred by the Operator.

This is the MemoryClass that will be used to access the input and output vectors in the Mult() and MultTranspose() methods.

For example, classes using the MFEM_FORALL macro for implementation can return the value returned by Device::GetMemoryClass().

The default implementation of this method in class Operator returns MemoryClass::HOST.

Reimplemented from mfem::Operator.

Definition at line 403 of file operator.hpp.

virtual void mfem::TripleProductOperator::Mult ( const Vector &  x, Vector &  y  ) const

inlinevirtual

Operator application: y=A(x).

Implements mfem::Operator.

Definition at line 405 of file operator.hpp.

virtual void mfem::TripleProductOperator::MultTranspose ( const Vector &  x, Vector &  y  ) const

inlinevirtual

Action of the transpose operator: y=A^t(x). The default behavior in class Operator is to generate an error.

Reimplemented from mfem::Operator.

Definition at line 408 of file operator.hpp.

---

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

• linalg/operator.hpp
• linalg/operator.cpp