Specialization of the ComplexOperator built from a pair of HypreParMatrices. More...

#include <complex_operator.hpp>

Inheritance diagram for mfem::ComplexHypreParMatrix:

Collaboration diagram for mfem::ComplexHypreParMatrix:

Public Member Functions
	ComplexHypreParMatrix (HypreParMatrix A_Real, HypreParMatrix A_Imag, bool ownReal, bool ownImag, Convention convention=HERMITIAN)

virtual HypreParMatrix &	real ()
	Real or imaginary part accessor methods. More...

virtual HypreParMatrix &	imag ()

virtual const HypreParMatrix &	real () const

virtual const HypreParMatrix &	imag () const

HypreParMatrix *	GetSystemMatrix () const

virtual Type	GetType () const

Public Member Functions inherited from mfem::ComplexOperator
	ComplexOperator (Operator Op_Real, Operator Op_Imag, bool ownReal, bool ownImag, Convention convention=HERMITIAN)
	Constructs complex operator object. More...

virtual	~ComplexOperator ()

bool	hasRealPart () const
	Check for existence of real or imaginary part of the operator. More...

bool	hasImagPart () const

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...

Convention	GetConvention () const

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...

Public Member Functions inherited from mfem::Operator
void	InitTVectors (const Operator Po, const Operator Ri, const Operator *Pi, Vector &x, Vector &b, Vector &X, Vector &B) const
	Initializes memory for true vectors of linear system. More...

	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 MemoryClass	GetMemoryClass () const
	Return the MemoryClass preferred by the Operator. More...

virtual void	AddMult (const Vector &x, Vector &y, const double a=1.0) const
	Operator application: `y+=A(x)` (default) or `y+=a*A(x)`. More...

virtual void	AddMultTranspose (const Vector &x, Vector &y, const double a=1.0) const
	Operator transpose application: `y+=A^t(x)` (default) or `y+=a*A^t(x)`. More...

virtual void	ArrayMult (const Array< const Vector > &X, Array< Vector > &Y) const
	Operator application on a matrix: `Y=A(X)`. More...

virtual void	ArrayMultTranspose (const Array< const Vector > &X, Array< Vector > &Y) const
	Action of the transpose operator on a matrix: `Y=A^t(X)`. More...

virtual void	ArrayAddMult (const Array< const Vector > &X, Array< Vector > &Y, const double a=1.0) const
	Operator application on a matrix: `Y+=A(X)` (default) or `Y+=a*A(X)`. More...

virtual void	ArrayAddMultTranspose (const Array< const Vector > &X, Array< Vector > &Y, const double a=1.0) const
	Operator transpose application on a matrix: `Y+=A^t(X)` (default) or `Y+=a*A^t(X)`. 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 void	AssembleDiagonal (Vector &diag) const
	Computes the diagonal entries into diag. Typically, this operation only makes sense for linear Operators. In some cases, only an approximation of the diagonal is computed. 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...

virtual const Operator *	GetOutputProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. `NULL` means identity. More...

virtual const Operator *	GetOutputRestrictionTranspose () const
	Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators. More...

virtual const Operator *	GetOutputRestriction () const
	Restriction operator from output 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...

void	FormRectangularLinearSystem (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B)
	Form a column-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() or Operator::FormRectangularLinearSystem(). More...

void	FormSystemOperator (const Array< int > &ess_tdof_list, Operator *&A)
	Return in A a parallel (on truedofs) version of this square operator. More...

void	FormRectangularSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Operator *&A)
	Return in A a parallel (on truedofs) version of this rectangular operator (including constraints). More...

void	FormDiscreteOperator (Operator *&A)
	Return in A a parallel (on truedofs) version of this rectangular operator. More...

void	PrintMatlab (std::ostream &out, int n, int m=0) const
	Prints operator with input size n and output size m in Matlab format. More...

virtual void	PrintMatlab (std::ostream &out) const
	Prints operator 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::ComplexOperator
enum	Convention { HERMITIAN, BLOCK_SYMMETRIC }

Public Types inherited from mfem::Operator
enum	DiagonalPolicy { DIAG_ZERO, DIAG_ONE, DIAG_KEEP }
	Defines operator diagonal policy upon elimination of rows and/or columns. More...

enum	Type { ANY_TYPE, MFEM_SPARSEMAT, Hypre_ParCSR, PETSC_MATAIJ, PETSC_MATIS, PETSC_MATSHELL, PETSC_MATNEST, PETSC_MATHYPRE, PETSC_MATGENERIC, Complex_Operator, MFEM_ComplexSparseMat, Complex_Hypre_ParCSR, Complex_DenseMat, MFEM_Block_Matrix, MFEM_Block_Operator }
	Enumeration defining IDs for some classes derived from Operator. More...

Protected Member Functions inherited from mfem::ComplexOperator
void	Mult (const Vector &x_r, const Vector &x_i, Vector &y_r, Vector &y_i) const

void	MultTranspose (const Vector &x_r, const Vector &x_i, Vector &y_r, Vector &y_i) const

Protected Member Functions inherited from mfem::Operator
void	FormConstrainedSystemOperator (const Array< int > &ess_tdof_list, ConstrainedOperator *&Aout)
	see FormSystemOperator() More...

void	FormRectangularConstrainedSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, RectangularConstrainedOperator *&Aout)
	see FormRectangularSystemOperator() More...

Operator *	SetupRAP (const Operator Pi, const Operator Po)
	Returns RAP Operator of this, using input/output Prolongation matrices Pi corresponds to "P", Po corresponds to "Rt". More...

Protected Attributes inherited from mfem::ComplexOperator
Operator *	Op_Real_

Operator *	Op_Imag_

bool	ownReal_

bool	ownImag_

Convention	convention_

Vector	x_r_

Vector	x_i_

Vector	y_r_

Vector	y_i_

Vector *	u_

Vector *	v_

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

Specialization of the ComplexOperator built from a pair of HypreParMatrices.

The purpose of this specialization is to construct a single HypreParMatrix object which is equivalent to the 2x2 block system that the ComplexOperator mimics. The resulting HypreParMatrix can then be passed along to solvers which require access to the CSR matrix data such as SuperLU, STRUMPACK, or similar sparse linear solvers.

See ComplexOperator documentation above for more information.

Definition at line 258 of file complex_operator.hpp.

Constructor & Destructor Documentation

◆ ComplexHypreParMatrix()

mfem::ComplexHypreParMatrix::ComplexHypreParMatrix	(	HypreParMatrix *	A_Real,
		HypreParMatrix *	A_Imag,
		bool	ownReal,
		bool	ownImag,
		Convention	convention = `HERMITIAN`
	)

Definition at line 518 of file complex_operator.cpp.

Member Function Documentation

◆ GetSystemMatrix()

HypreParMatrix * mfem::ComplexHypreParMatrix::GetSystemMatrix ( ) const

Combine the blocks making up this complex operator into a single HypreParMatrix. The resulting matrix can be passed to solvers which require access to the matrix entries themselves, such as sparse direct solvers or Hypre preconditioners, rather than simply the action of the operator. Note that this combined operator requires roughly twice the memory of the block structured operator.

Definition at line 555 of file complex_operator.cpp.

◆ GetType()

virtual Type mfem::ComplexHypreParMatrix::GetType ( ) const

inlinevirtual

Reimplemented from mfem::ComplexOperator.

Definition at line 279 of file complex_operator.hpp.

◆ imag() [1/2]

HypreParMatrix & mfem::ComplexHypreParMatrix::imag ( )

virtual

Reimplemented from mfem::ComplexOperator.

Definition at line 537 of file complex_operator.cpp.

◆ imag() [2/2]

const HypreParMatrix & mfem::ComplexHypreParMatrix::imag ( ) const

virtual

Reimplemented from mfem::ComplexOperator.

Definition at line 549 of file complex_operator.cpp.

◆ real() [1/2]

HypreParMatrix & mfem::ComplexHypreParMatrix::real ( )

virtual

Real or imaginary part accessor methods.

The following accessor methods should only be called if the requested part of the operator is known to exist. This can be checked with hasRealPart() or hasImagPart().

Reimplemented from mfem::ComplexOperator.

Definition at line 531 of file complex_operator.cpp.