MFEM v4.7.0 Finite element discretization library
Searching...
No Matches
mfem::ComplexSparseMatrix Class Reference

Specialization of the ComplexOperator built from a pair of Sparse Matrices. More...

#include <complex_operator.hpp>

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

## Public Member Functions

ComplexSparseMatrix (SparseMatrix *A_Real, SparseMatrix *A_Imag, bool ownReal, bool ownImag, Convention convention=HERMITIAN)

virtual SparseMatrixreal ()
Real or imaginary part accessor methods.

virtual SparseMatriximag ()

virtual const SparseMatrixreal () const

virtual const SparseMatriximag () const

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

virtual ~ComplexOperator ()

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

bool hasImagPart () const

virtual void Mult (const Vector &x, Vector &y) const
Operator application: y=A(x).

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.

Convention GetConvention () const

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.

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

Operator (int h, int w)
Construct an Operator with the given height (output size) and width (input size).

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

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

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

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

virtual MemoryClass GetMemoryClass () const
Return the MemoryClass preferred by the Operator.

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

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

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

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

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

virtual void ArrayAddMultTranspose (const Array< const Vector * > &X, Array< Vector * > &Y, const real_t a=1.0) const
Operator transpose application on a matrix: Y+=A^t(X) (default) or Y+=a*A^t(X).

virtual OperatorGetGradient (const Vector &x) const
Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error.

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.

virtual const OperatorGetProlongation () const
Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity.

virtual const OperatorGetRestriction () const
Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. NULL means identity.

virtual const OperatorGetOutputProlongation () const
Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. NULL means identity.

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

virtual const OperatorGetOutputRestriction () const
Restriction operator from output vectors for the operator to linear algebra (linear system) vectors. NULL means identity.

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.

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.

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

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

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

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

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

virtual void PrintMatlab (std::ostream &out) const
Prints operator in Matlab format.

virtual ~Operator ()
Virtual destructor.

Type GetType () const
Return the type ID of the Operator class.

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

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

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

Protected Attributes inherited from mfem::ComplexOperator
OperatorOp_Real_

OperatorOp_Imag_

bool ownReal_

bool ownImag_

Convention convention_

Vector x_r_

Vector x_i_

Vector y_r_

Vector y_i_

Vectoru_

Vectorv_

Protected Attributes inherited from mfem::Operator
int height
Dimension of the output / number of rows in the matrix.

int width
Dimension of the input / number of columns in the matrix.

## Detailed Description

Specialization of the ComplexOperator built from a pair of Sparse Matrices.

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

Definition at line 154 of file complex_operator.hpp.

## ◆ ComplexSparseMatrix()

 mfem::ComplexSparseMatrix::ComplexSparseMatrix ( SparseMatrix * A_Real, SparseMatrix * A_Imag, bool ownReal, bool ownImag, Convention convention = HERMITIAN )
inline

Definition at line 157 of file complex_operator.hpp.

## ◆ GetSystemMatrix()

 SparseMatrix * mfem::ComplexSparseMatrix::GetSystemMatrix ( ) const

Combine the blocks making up this complex operator into a single SparseMatrix. The resulting matrix can be passed to solvers which require access to the matrix entries themselves, such as sparse direct solvers, 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 192 of file complex_operator.cpp.

## ◆ GetType()

 virtual Type mfem::ComplexSparseMatrix::GetType ( ) const
inlinevirtual

Reimplemented from mfem::ComplexOperator.

Definition at line 177 of file complex_operator.hpp.

## ◆ imag() [1/2]

 SparseMatrix & mfem::ComplexSparseMatrix::imag ( )
virtual

Reimplemented from mfem::ComplexOperator.

Definition at line 174 of file complex_operator.cpp.

## ◆ imag() [2/2]

 const SparseMatrix & mfem::ComplexSparseMatrix::imag ( ) const
virtual

Reimplemented from mfem::ComplexOperator.

Definition at line 186 of file complex_operator.cpp.

## ◆ real() [1/2]

 SparseMatrix & mfem::ComplexSparseMatrix::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 168 of file complex_operator.cpp.

## ◆ real() [2/2]

 const SparseMatrix & mfem::ComplexSparseMatrix::real ( ) const
virtual

Reimplemented from mfem::ComplexOperator.

Definition at line 180 of file complex_operator.cpp.

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