Partial assembly extension for DiscreteLinearOperator. More...

#include <bilinearform_ext.hpp>

Inheritance diagram for mfem::PADiscreteLinearOperatorExtension:

Collaboration diagram for mfem::PADiscreteLinearOperatorExtension:

Public Member Functions
	PADiscreteLinearOperatorExtension (DiscreteLinearOperator *linop)

void	Assemble () override
	Partial assembly of all internal integrators.

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

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

void	FormRectangularSystemOperator (const Array< int > &, const Array< int > &, OperatorHandle &A) override

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

Public Member Functions inherited from mfem::PAMixedBilinearFormExtension
	PAMixedBilinearFormExtension (MixedBilinearForm *form)

void	Assemble () override
	Partial assembly of all internal integrators.

void	FormRectangularSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, OperatorHandle &A) override
	Setup OperatorHandle A to contain constrained linear operator.

void	FormRectangularLinearSystem (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Vector &x, Vector &b, OperatorHandle &A, Vector &X, Vector &B) override

void	Mult (const Vector &x, Vector &y) const override
	y = A*x

void	AddMult (const Vector &x, Vector &y, const real_t c=1.0) const override
	y += cAx

void	MultTranspose (const Vector &x, Vector &y) const override
	y = A^T*x

void	AddMultTranspose (const Vector &x, Vector &y, const real_t c=1.0) const override
	y += cA^Tx

void	AssembleDiagonal_ADAt (const Vector &D, Vector &diag) const override
	Assemble the diagonal of ADA^T for a diagonal vector D.

void	Update () override
	Update internals for when a new MixedBilinearForm is given to this class.

Public Member Functions inherited from mfem::MixedBilinearFormExtension
	MixedBilinearFormExtension (MixedBilinearForm *form)

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

const Operator *	GetProlongation () const override
	Get the finite element space prolongation matrix.

const Operator *	GetRestriction () const override
	Get the finite element space restriction matrix.

const Operator *	GetOutputProlongation () const override
	Get the output finite element space restriction matrix.

const Operator *	GetOutputRestriction () const override
	Get the output finite element space restriction matrix.

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

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.

Additional Inherited Members
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::PAMixedBilinearFormExtension
void	SetupMultInputs (const Operator elem_restrict_x, const Vector &x, Vector &localX, const Operator elem_restrict_y, Vector &y, Vector &localY, const real_t c) const
	Helper function to set up inputs/outputs for Mult or MultTranspose.

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

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 inherited from mfem::PAMixedBilinearFormExtension
const FiniteElementSpace *	trial_fes

const FiniteElementSpace *	test_fes

Vector	localTrial

Vector	localTest

Vector	tempY

const Operator *	elem_restrict_trial

const Operator *	elem_restrict_test

Protected Attributes inherited from mfem::MixedBilinearFormExtension
MixedBilinearForm *	a
	Not owned.

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

Partial assembly extension for DiscreteLinearOperator.

This acts very much like PAMixedBilinearFormExtension, but its FormRectangularSystemOperator implementation emulates 'Set' rather than 'Add' in the assembly case.

Definition at line 334 of file bilinearform_ext.hpp.

Constructor & Destructor Documentation

◆ PADiscreteLinearOperatorExtension()

mfem::PADiscreteLinearOperatorExtension::PADiscreteLinearOperatorExtension ( DiscreteLinearOperator * linop )

Definition at line 1965 of file bilinearform_ext.cpp.

Member Function Documentation

◆ AddMult()

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

overridevirtual

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

Reimplemented from mfem::Operator.

Definition at line 2010 of file bilinearform_ext.cpp.

◆ AddMultTranspose()

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

overridevirtual

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

Reimplemented from mfem::Operator.

Definition at line 2043 of file bilinearform_ext.cpp.

◆ Assemble()

void mfem::PADiscreteLinearOperatorExtension::Assemble ( )

overridevirtual

Partial assembly of all internal integrators.

Implements mfem::MixedBilinearFormExtension.

Definition at line 1978 of file bilinearform_ext.cpp.

◆ FormRectangularSystemOperator()

void mfem::PADiscreteLinearOperatorExtension::FormRectangularSystemOperator	(	const Array< int > &	ess1,
		const Array< int > &	ess2,
		OperatorHandle &	A )

overridevirtual

Implements mfem::MixedBilinearFormExtension.

Definition at line 2082 of file bilinearform_ext.cpp.

◆ GetOutputRestrictionTranspose()

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

overridevirtual

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

NULL means identity.

Reimplemented from mfem::Operator.

Definition at line 1972 of file bilinearform_ext.cpp.

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

fem/bilinearform_ext.hpp
fem/bilinearform_ext.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PADiscreteLinearOperatorExtension()

Member Function Documentation

◆ AddMult()

◆ AddMultTranspose()

◆ Assemble()

◆ FormRectangularSystemOperator()

◆ GetOutputRestrictionTranspose()