Abstract operator. More...

#include <operator.hpp>

Inheritance diagram for mfem::Operator:

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

Public Member Functions
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	Mult (const Vector &x, Vector &y) const =0
	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.

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

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 Operator *	GetProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. `NULL` means identity.

virtual const Operator *	GetRestriction () const
	Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. `NULL` means identity.

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

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

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

Protected Member Functions
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()

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

Protected Attributes
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

Abstract operator.

Definition at line 24 of file operator.hpp.

Member Enumeration Documentation

◆ DiagonalPolicy

enum mfem::Operator::DiagonalPolicy

Defines operator diagonal policy upon elimination of rows and/or columns.

Enumerator
DIAG_ZERO	Set the diagonal value to zero.
DIAG_ONE	Set the diagonal value to one.
DIAG_KEEP	Keep the diagonal value.

Definition at line 47 of file operator.hpp.

◆ Type

enum mfem::Operator::Type

Enumeration defining IDs for some classes derived from Operator.

This enumeration is primarily used with class OperatorHandle.

Enumerator
ANY_TYPE	ID for the base class Operator, i.e. any type.
MFEM_SPARSEMAT	ID for class SparseMatrix.
Hypre_ParCSR	ID for class HypreParMatrix.
PETSC_MATAIJ	ID for class PetscParMatrix, MATAIJ format.
PETSC_MATIS	ID for class PetscParMatrix, MATIS format.
PETSC_MATSHELL	ID for class PetscParMatrix, MATSHELL format.
PETSC_MATNEST	ID for class PetscParMatrix, MATNEST format.
PETSC_MATHYPRE	ID for class PetscParMatrix, MATHYPRE format.
PETSC_MATGENERIC	ID for class PetscParMatrix, unspecified format.
Complex_Operator	ID for class ComplexOperator.
MFEM_ComplexSparseMat	ID for class ComplexSparseMatrix.
Complex_Hypre_ParCSR	ID for class ComplexHypreParMatrix.
Complex_DenseMat	ID for class ComplexDenseMatrix.
MFEM_Block_Matrix	ID for class BlockMatrix.
MFEM_Block_Operator	ID for the base class BlockOperator.

Definition at line 283 of file operator.hpp.

Constructor & Destructor Documentation

◆ Operator() [1/2]

mfem::Operator::Operator ( int s = 0 )

inlineexplicit

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

Definition at line 59 of file operator.hpp.

◆ Operator() [2/2]

mfem::Operator::Operator	(	int	h,
		int	w )

inline

Construct an Operator with the given height (output size) and width (input size).

Definition at line 63 of file operator.hpp.

◆ ~Operator()

virtual mfem::Operator::~Operator ( )

inlinevirtual

Virtual destructor.

Reimplemented in mfem::ceed::Operator.

Definition at line 279 of file operator.hpp.

Member Function Documentation

◆ AddMult()

void mfem::Operator::AddMult	(	const Vector &	x,
		Vector &	y,
		const real_t	a = 1.0 ) const

virtual

Operator application: y+=A(x) (default) or y+=a*A(x).

Reimplemented in mfem::AbstractSparseMatrix, mfem::BilinearForm, mfem::BlockMatrix, mfem::ceed::Operator, mfem::ConstrainedOperator, mfem::DenseMatrix, mfem::HypreParMatrix, mfem::MixedBilinearForm, mfem::PADiscreteLinearOperatorExtension, mfem::PAMixedBilinearFormExtension, mfem::PetscParMatrix, mfem::SparseMatrix, and mfem::TBilinearForm< meshType, solFESpace, IR, IntegratorType, solVecLayout_t, complex_t, real_t, impl_traits_t >.

Definition at line 51 of file operator.cpp.

◆ AddMultTranspose()

void mfem::Operator::AddMultTranspose	(	const Vector &	x,
		Vector &	y,
		const real_t	a = 1.0 ) const

virtual

Operator transpose application: y+=A^t(x) (default) or y+=a*A^t(x).

Reimplemented in mfem::AbstractSparseMatrix, mfem::BilinearForm, mfem::BlockMatrix, mfem::ConformingFaceRestriction, mfem::DenseMatrix, mfem::ElementRestriction, mfem::ElementRestrictionOperator, mfem::FaceRestriction, mfem::HypreParMatrix, mfem::L2ElementRestriction, mfem::L2FaceRestriction, mfem::MixedBilinearForm, mfem::NCL2FaceRestriction, mfem::PADiscreteLinearOperatorExtension, mfem::PAMixedBilinearFormExtension, mfem::ParNCH1FaceRestriction, mfem::ParNCL2FaceRestriction, mfem::PetscParMatrix, and mfem::SparseMatrix.

Definition at line 58 of file operator.cpp.

◆ ArrayAddMult()

void mfem::Operator::ArrayAddMult	(	const Array< const Vector * > &	X,
		Array< Vector * > &	Y,
		const real_t	a = 1.0 ) const

virtual

Operator application on a matrix: Y+=A(X) (default) or Y+=a*A(X).

Definition at line 90 of file operator.cpp.

◆ ArrayAddMultTranspose()

void mfem::Operator::ArrayAddMultTranspose	(	const Array< const Vector * > &	X,
		Array< Vector * > &	Y,
		const real_t	a = 1.0 ) const

virtual

Operator transpose application on a matrix: Y+=A^t(X) (default) or Y+=a*A^t(X).

Definition at line 102 of file operator.cpp.

◆ ArrayMult()

void mfem::Operator::ArrayMult	(	const Array< const Vector * > &	X,
		Array< Vector * > &	Y ) const

virtual

Operator application on a matrix: Y=A(X).

Reimplemented in mfem::MultigridBase, mfem::MUMPSSolver, mfem::STRUMPACKSolverBase< STRUMPACKSolverType >, mfem::STRUMPACKSolverBase< strumpack::SparseSolverMixedPrecisionMPIDist< float, double, HYPRE_BigInt > >, mfem::STRUMPACKSolverBase< strumpack::SparseSolverMPIDist< double, HYPRE_BigInt > >, and mfem::SuperLUSolver.

Definition at line 66 of file operator.cpp.

◆ ArrayMultTranspose()

void mfem::Operator::ArrayMultTranspose	(	const Array< const Vector * > &	X,
		Array< Vector * > &	Y ) const

virtual

Action of the transpose operator on a matrix: Y=A^t(X).

Reimplemented in mfem::MUMPSSolver, and mfem::SuperLUSolver.

Definition at line 78 of file operator.cpp.

◆ AssembleDiagonal()

virtual void mfem::Operator::AssembleDiagonal ( Vector & diag ) const

inlinevirtual

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.

Reimplemented in mfem::BilinearForm, mfem::BilinearFormExtension, mfem::ConstrainedOperator, mfem::HypreParMatrix, mfem::MFBilinearFormExtension, mfem::PABilinearFormExtension, mfem::ParBilinearForm, and mfem::RAPOperator.

Definition at line 131 of file operator.hpp.

◆ FormConstrainedSystemOperator()

void mfem::Operator::FormConstrainedSystemOperator	(	const Array< int > &	ess_tdof_list,
		ConstrainedOperator *&	Aout )

protected

see FormSystemOperator()

Note: Uses DiagonalPolicy::DIAG_ONE.

Definition at line 197 of file operator.cpp.

◆ FormDiscreteOperator()

void mfem::Operator::FormDiscreteOperator ( Operator *& A )

Return in A a parallel (on truedofs) version of this rectangular operator.

This is similar to FormSystemOperator(), but for dof-to-dof mappings (discrete linear operators), which can also correspond to rectangular matrices. The user should provide specializations of GetProlongation() for the input dofs and GetOutputRestriction() for the output dofs in their Operator implementation that are appropriate for the two spaces the Operator maps between. These are e.g. available through the (parallel) finite element space of any (parallel) bilinear form operator. We have: A(X)=[Rout (*this) Pin](X).

Definition at line 244 of file operator.cpp.

◆ FormLinearSystem()

void mfem::Operator::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.

Assuming square operator, form the operator linear system A(X)=B, corresponding to it and the right-hand side b, by applying any necessary transformations such as: parallel assembly, conforming constraints for non-conforming AMR and eliminating boundary conditions.

Note: Static condensation and hybridization are not supported for general operators (cf. the analogous methods BilinearForm::FormLinearSystem() and ParBilinearForm::FormLinearSystem()).

The constraints are specified through the prolongation P from GetProlongation(), and restriction R from GetRestriction() methods, which are e.g. available through the (parallel) finite element space of any (parallel) bilinear form operator. We assume that the operator is square, using the same input and output space, so we have: A(X)=[P^t (*this) P](X), B=P^t(b), and X=R(x).

The vector x must contain the essential boundary condition values. These are eliminated through the ConstrainedOperator class and the vector X is initialized by setting its essential entries to the boundary conditions and all other entries to zero (copy_interior == 0) or copied from x (copy_interior != 0).

After solving the system A(X)=B, the (finite element) solution x can be recovered by calling Operator::RecoverFEMSolution() with the same vectors X, b, and x.

Note: The caller is responsible for destroying the output operator A!; If there are no transformations, X simply reuses the data of x.

Definition at line 114 of file operator.cpp.

◆ FormRectangularConstrainedSystemOperator()

void mfem::Operator::FormRectangularConstrainedSystemOperator	(	const Array< int > &	trial_tdof_list,
		const Array< int > &	test_tdof_list,
		RectangularConstrainedOperator *&	Aout )

protected

see FormRectangularSystemOperator()

Definition at line 210 of file operator.cpp.

◆ FormRectangularLinearSystem()

void mfem::Operator::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.

Form the operator linear system A(X)=B corresponding to the operator and the right-hand side b, by applying any necessary transformations such as: parallel assembly, conforming constraints for non-conforming AMR and eliminating boundary conditions.

Note: Static condensation and hybridization are not supported for general operators (cf. the method MixedBilinearForm::FormRectangularLinearSystem())

The constraints are specified through the input prolongation Pi from GetProlongation(), and output restriction Ro from GetOutputRestriction() methods, which are e.g. available through the (parallel) finite element spaces of any (parallel) mixed bilinear form operator. So we have: A(X)=[Ro (*this) Pi](X), B=Ro(b), and X=Pi^T(x).

The vector x must contain the essential boundary condition values. The "columns" in this operator corresponding to these values are eliminated through the RectangularConstrainedOperator class.

After solving the system A(X)=B, the (finite element) solution x can be recovered by calling Operator::RecoverFEMSolution() with the same vectors X, b, and x.

Note: The caller is responsible for destroying the output operator A!; If there are no transformations, X simply reuses the data of x.

Definition at line 131 of file operator.cpp.

◆ FormRectangularSystemOperator()

void mfem::Operator::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).

This returns the same operator as FormRectangularLinearSystem(), but does without the transformations of the right-hand side.

Definition at line 235 of file operator.cpp.

◆ FormSystemOperator()

void mfem::Operator::FormSystemOperator	(	const Array< int > &	ess_tdof_list,
		Operator *&	A )

Return in A a parallel (on truedofs) version of this square operator.

This returns the same operator as FormLinearSystem(), but does without the transformations of the right-hand side and initial guess.

Definition at line 227 of file operator.cpp.

◆ GetGradient()

virtual Operator & mfem::Operator::GetGradient ( const Vector & x ) const

inlinevirtual

Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error.

Reimplemented in mfem::BlockNonlinearForm, mfem::ElasticityOperator, mfem::MFNonlinearFormExtension, mfem::NonlinearForm, mfem::NonlinearFormExtension, mfem::PANonlinearFormExtension, mfem::ParametricBNLForm, mfem::ParBlockNonlinearForm, mfem::ParNonlinearForm, and mfem::ParParametricBNLForm.

Definition at line 122 of file operator.hpp.

◆ GetMemoryClass()

virtual MemoryClass mfem::Operator::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 in mfem::BilinearFormExtension, mfem::ConstrainedOperator, mfem::HypreParMatrix, mfem::HypreSolver, mfem::MixedBilinearFormExtension, mfem::RAPOperator, mfem::RectangularConstrainedOperator, mfem::SparseMatrix, and mfem::TripleProductOperator.

Definition at line 86 of file operator.hpp.

◆ GetOutputProlongation()

virtual const Operator * mfem::Operator::GetOutputProlongation ( ) const

inlinevirtual

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

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

Definition at line 147 of file operator.hpp.

◆ GetOutputRestriction()

virtual const Operator * mfem::Operator::GetOutputRestriction ( ) const

inlinevirtual

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

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

Definition at line 160 of file operator.hpp.

◆ GetOutputRestrictionTranspose()

virtual const Operator * mfem::Operator::GetOutputRestrictionTranspose ( ) const

inlinevirtual

Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators.

NULL means identity.

Reimplemented in mfem::BilinearForm, mfem::DiscreteLinearOperator, and mfem::PADiscreteLinearOperatorExtension.

Definition at line 156 of file operator.hpp.

◆ GetProlongation()

virtual const Operator * mfem::Operator::GetProlongation ( ) const

inlinevirtual

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

Reimplemented in mfem::BilinearForm, mfem::BilinearFormExtension, mfem::BlockFESpaceOperator, mfem::MixedBilinearForm, mfem::MixedBilinearFormExtension, mfem::NonlinearForm, mfem::ParBilinearForm, and mfem::TBilinearForm< meshType, solFESpace, IR, IntegratorType, solVecLayout_t, complex_t, real_t, impl_traits_t >.

Definition at line 139 of file operator.hpp.

◆ GetRestriction()

virtual const Operator * mfem::Operator::GetRestriction ( ) const

inlinevirtual

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

Reimplemented in mfem::BilinearForm, mfem::BilinearFormExtension, mfem::BlockFESpaceOperator, mfem::MixedBilinearForm, mfem::MixedBilinearFormExtension, mfem::NonlinearForm, mfem::ParBilinearForm, and mfem::TBilinearForm< meshType, solFESpace, IR, IntegratorType, solVecLayout_t, complex_t, real_t, impl_traits_t >.

Definition at line 143 of file operator.hpp.

◆ GetType()

Type mfem::Operator::GetType ( ) const

inline

Return the type ID of the Operator class.

This method is intentionally non-virtual, so that it returns the ID of the specific pointer or reference type used when calling this method. If not overridden by derived classes, they will automatically use the type ID of the base Operator class, ANY_TYPE.

Definition at line 307 of file operator.hpp.

◆ Height()

int mfem::Operator::Height ( ) const

inline

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

Definition at line 66 of file operator.hpp.

◆ InitTVectors()

void mfem::Operator::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.

Definition at line 22 of file operator.cpp.

◆ Mult()

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

pure virtual

Operator application: y=A(x).

Implemented in mfem::AbstractSparseMatrix, mfem::AdvectionOper, mfem::AmgXSolver, mfem::AuxSpaceSmoother, mfem::BiCGSTABSolver, mfem::BilinearForm, mfem::BlockDiagonalPreconditioner, mfem::BlockFESpaceOperator, mfem::BlockILU, mfem::BlockLowerTriangularPreconditioner, mfem::BlockMatrix, mfem::BlockNonlinearForm, mfem::BlockOperator, mfem::blocksolvers::BBTSolver, mfem::blocksolvers::BDPMinresSolver, mfem::blocksolvers::BPCGSolver, mfem::blocksolvers::BramblePasciakSolver, mfem::blocksolvers::DivFreeSolver, mfem::blocksolvers::LocalSolver, mfem::blocksolvers::SaddleSchwarzSmoother, mfem::ceed::AlgebraicInterpolation, mfem::ceed::AlgebraicSolver, mfem::ceed::Operator, mfem::CGSolver, mfem::ChangeOfBasis_L2, mfem::ChangeOfBasis_RT, mfem::common::DivergenceFreeProjector, mfem::common::IrrotationalProjector, mfem::ComplexOperator, mfem::ComplexUMFPackSolver, mfem::ConformingFaceRestriction, mfem::ConformingProlongationOperator, mfem::ConstrainedOperator, mfem::ConstrainedSolver, mfem::CPardisoSolver, mfem::DenseMatrix, mfem::DenseMatrixInverse, mfem::DenseSymmetricMatrix, mfem::DeviceConformingProlongationOperator, mfem::DGHyperbolicConservationLaws, mfem::DGMassInverse, mfem::DirectSubBlockSolver, mfem::DSmoother, mfem::EABilinearFormExtension, mfem::ElasticityDiagonalPreconditioner, mfem::ElasticityGradientOperator, mfem::ElasticityOperator, mfem::electromagnetics::MagneticDiffusionEOperator, mfem::electromagnetics::MaxwellSolver, mfem::ElementRestriction, mfem::EliminationProjection, mfem::EliminationSolver, mfem::FABilinearFormExtension, mfem::FaceRestriction, mfem::FGMRESSolver, mfem::FiniteElementSpace::DerefinementOperator, mfem::FiniteElementSpace::RefinementOperator, mfem::GeneralAMS, mfem::Ginkgo::GinkgoIterativeSolver, mfem::Ginkgo::GinkgoPreconditioner, mfem::GMRESSolver, mfem::GSSmoother, mfem::HdivSaddlePointSolver, mfem::HiopNlpOptimizer, mfem::HypreBoomerAMG, mfem::HypreFGMRES, mfem::HypreGMRES, mfem::HypreParMatrix, mfem::HyprePCG, mfem::HypreSmoother, mfem::HypreSolver, mfem::IdentityOperator, mfem::KINSolver, mfem::KLUSolver, mfem::L2ElementRestriction, mfem::L2FaceRestriction, mfem::L2ProjectionGridTransfer::L2ProjectionH1Space, mfem::L2ProjectionGridTransfer::L2ProjectionL2Space, mfem::L2ProjectionGridTransfer::L2Prolongation, mfem::LBFGSSolver, mfem::LORSolver< SolverType >, mfem::LORSolver< HypreADS >, mfem::LORSolver< HypreAMS >, mfem::MatrixFreeAMS, mfem::MatrixFreeAuxiliarySpace, mfem::MFBilinearFormExtension, mfem::MFNonlinearFormExtension, mfem::MINRESSolver, mfem::MixedBilinearForm, mfem::MultigridBase, mfem::MUMPSSolver, mfem::NCL2FaceRestriction, mfem::NewtonSolver, mfem::NNLSSolver, mfem::NonlinearForm, mfem::OperatorChebyshevSmoother, mfem::OperatorJacobiSmoother, mfem::OptimizationSolver, mfem::OrthoSolver, mfem::PABilinearFormExtension, mfem::PAMixedBilinearFormExtension, mfem::PANonlinearFormExtension, mfem::ParAdvectorCGOper, mfem::ParametricBNLForm, mfem::ParBlockNonlinearForm, mfem::PardisoSolver, mfem::ParL2FaceRestriction, mfem::ParNCH1FaceRestriction, mfem::ParNCL2FaceRestriction, mfem::ParNonlinearForm, mfem::ParParametricBNLForm, mfem::PenaltyConstrainedSolver, mfem::PetscLinearSolver, mfem::PetscNonlinearSolver, mfem::PetscParMatrix, mfem::PetscPreconditioner, mfem::PRefinementTransferOperator, mfem::ProductOperator, mfem::ProductSolver, mfem::RAPOperator, mfem::RectangularConstrainedOperator, mfem::ScaledOperator, mfem::SecondOrderTimeDependentOperator, mfem::SerialAdvectorCGOper, mfem::SLBQPOptimizer, mfem::SLISolver, mfem::SparseMatrix, mfem::STRUMPACKRowLocMatrix, mfem::STRUMPACKSolverBase< STRUMPACKSolverType >, mfem::STRUMPACKSolverBase< strumpack::SparseSolverMixedPrecisionMPIDist< float, double, HYPRE_BigInt > >, mfem::STRUMPACKSolverBase< strumpack::SparseSolverMPIDist< double, HYPRE_BigInt > >, mfem::SumOperator, mfem::SuperLURowLocMatrix, mfem::SuperLUSolver, mfem::TBilinearForm< meshType, solFESpace, IR, IntegratorType, solVecLayout_t, complex_t, real_t, impl_traits_t >, mfem::TensorProductPRefinementTransferOperator, mfem::TimeDependentOperator, mfem::TMOPNewtonSolver, mfem::TransferOperator, mfem::TransposeOperator, mfem::TripleProductOperator, mfem::TrueTransferOperator, and mfem::UMFPackSolver.

◆ MultTranspose()

virtual void mfem::Operator::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 in mfem::AbstractSparseMatrix, mfem::AuxSpaceSmoother, mfem::BilinearForm, mfem::BlockDiagonalPreconditioner, mfem::BlockLowerTriangularPreconditioner, mfem::BlockMatrix, mfem::BlockOperator, mfem::blocksolvers::SaddleSchwarzSmoother, mfem::blocksolvers::SymDirectSubBlockSolver, mfem::ceed::AlgebraicInterpolation, mfem::ChangeOfBasis_L2, mfem::ChangeOfBasis_RT, mfem::ComplexOperator, mfem::ComplexUMFPackSolver, mfem::ConformingProlongationOperator, mfem::ConstrainedOperator, mfem::DenseMatrix, mfem::DeviceConformingProlongationOperator, mfem::DGMassInverse, mfem::EABilinearFormExtension, mfem::ElementRestriction, mfem::EliminationProjection, mfem::FABilinearFormExtension, mfem::FaceRestriction, mfem::FiniteElementSpace::RefinementOperator, mfem::HypreParMatrix, mfem::HypreSmoother, mfem::IdentityOperator, mfem::KLUSolver, mfem::L2ElementRestriction, mfem::L2ProjectionGridTransfer::L2ProjectionH1Space, mfem::L2ProjectionGridTransfer::L2ProjectionL2Space, mfem::L2ProjectionGridTransfer::L2Prolongation, mfem::MFBilinearFormExtension, mfem::MixedBilinearForm, mfem::MUMPSSolver, mfem::OperatorChebyshevSmoother, mfem::OperatorJacobiSmoother, mfem::PABilinearFormExtension, mfem::PAMixedBilinearFormExtension, mfem::PetscLinearSolver, mfem::PetscParMatrix, mfem::PetscPreconditioner, mfem::PRefinementTransferOperator, mfem::ProductOperator, mfem::ProductSolver, mfem::RAPOperator, mfem::RectangularConstrainedOperator, mfem::ScaledOperator, mfem::SparseMatrix, mfem::SumOperator, mfem::SuperLUSolver, mfem::TensorProductPRefinementTransferOperator, mfem::TransferOperator, mfem::TransposeOperator, mfem::TripleProductOperator, mfem::TrueTransferOperator, and mfem::UMFPackSolver.

Definition at line 93 of file operator.hpp.

◆ NumCols()

int mfem::Operator::NumCols ( ) const

inline

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

Definition at line 75 of file operator.hpp.

◆ NumRows()

int mfem::Operator::NumRows ( ) const

inline

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

Definition at line 69 of file operator.hpp.

◆ PrintMatlab() [1/2]

void mfem::Operator::PrintMatlab ( std::ostream & out ) const

virtual

Prints operator in Matlab format.

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

Definition at line 276 of file operator.cpp.

◆ PrintMatlab() [2/2]

void mfem::Operator::PrintMatlab	(	std::ostream &	out,
		int	n,
		int	m = 0 ) const

Prints operator with input size n and output size m in Matlab format.

Definition at line 251 of file operator.cpp.

◆ RecoverFEMSolution()

void mfem::Operator::RecoverFEMSolution	(	const Vector &	X,
		const Vector &	b,
		Vector &	x )

virtual

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

Call this method after solving a linear system constructed using Operator::FormLinearSystem() to recover the solution as an input vector, x, for this Operator (presumably a finite element grid function). This method has identical signature to the analogous method for bilinear forms, though currently b is not used in the implementation.

Reimplemented in mfem::BilinearForm, and mfem::ParBilinearForm.

Definition at line 148 of file operator.cpp.

◆ SetupRAP()

Operator * mfem::Operator::SetupRAP	(	const Operator *	Pi,
		const Operator *	Po )

protected

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

Definition at line 168 of file operator.cpp.

◆ Width()

int mfem::Operator::Width ( ) const

inline

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

Definition at line 72 of file operator.hpp.

Member Data Documentation

◆ height

int mfem::Operator::height

protected

Dimension of the output / number of rows in the matrix.

Definition at line 27 of file operator.hpp.

◆ width

int mfem::Operator::width

protected

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

Definition at line 28 of file operator.hpp.

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

linalg/operator.hpp
linalg/operator.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ DiagonalPolicy

◆ Type

Constructor & Destructor Documentation

◆ Operator() [1/2]

◆ Operator() [2/2]

◆ ~Operator()

Member Function Documentation

◆ AddMult()

◆ AddMultTranspose()

◆ ArrayAddMult()

◆ ArrayAddMultTranspose()

◆ ArrayMult()

◆ ArrayMultTranspose()

◆ AssembleDiagonal()

◆ FormConstrainedSystemOperator()

◆ FormDiscreteOperator()

◆ FormLinearSystem()

◆ FormRectangularConstrainedSystemOperator()

◆ FormRectangularLinearSystem()

◆ FormRectangularSystemOperator()

◆ FormSystemOperator()

◆ GetGradient()

◆ GetMemoryClass()

◆ GetOutputProlongation()

◆ GetOutputRestriction()

◆ GetOutputRestrictionTranspose()

◆ GetProlongation()

◆ GetRestriction()

◆ GetType()

◆ Height()

◆ InitTVectors()

◆ Mult()

◆ MultTranspose()

◆ NumCols()

◆ NumRows()

◆ PrintMatlab() [1/2]

◆ PrintMatlab() [2/2]

◆ RecoverFEMSolution()

◆ SetupRAP()

◆ Width()

Member Data Documentation

◆ height

◆ width