Data and methods for matrix-free bilinear forms. More...

#include <bilinearform_ext.hpp>

Inheritance diagram for mfem::MFBilinearFormExtension:

Collaboration diagram for mfem::MFBilinearFormExtension:

Public Member Functions
	MFBilinearFormExtension (BilinearForm *form)

void	Assemble ()
	Assemble at the level given for the BilinearFormExtension subclass.

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	FormSystemMatrix (const Array< int > &ess_tdof_list, OperatorHandle &A)

void	FormLinearSystem (const Array< int > &ess_tdof_list, Vector &x, Vector &b, OperatorHandle &A, Vector &X, Vector &B, int copy_interior=0)

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

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.

void	Update ()

Public Member Functions inherited from mfem::BilinearFormExtension
	BilinearFormExtension (BilinearForm *form)

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

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

virtual const Operator *	GetRestriction () const
	Get the 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	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 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 Attributes
const FiniteElementSpace *	trial_fes

const FiniteElementSpace *	test_fes

Vector	localX

Vector	localY

Vector	int_face_X

Vector	int_face_Y

Vector	bdr_face_X

Vector	bdr_face_Y

const Operator *	elem_restrict

const FaceRestriction *	int_face_restrict_lex

const FaceRestriction *	bdr_face_restrict_lex

Protected Attributes inherited from mfem::BilinearFormExtension
BilinearForm *	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.

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

Detailed Description

Data and methods for matrix-free bilinear forms.

Definition at line 188 of file bilinearform_ext.hpp.

Constructor & Destructor Documentation

◆ MFBilinearFormExtension()

mfem::MFBilinearFormExtension::MFBilinearFormExtension ( BilinearForm * form )

Definition at line 41 of file bilinearform_ext.cpp.

Member Function Documentation

◆ Assemble()

void mfem::MFBilinearFormExtension::Assemble ( )

virtual

Assemble at the level given for the BilinearFormExtension subclass.

Implements mfem::BilinearFormExtension.

Definition at line 51 of file bilinearform_ext.cpp.

◆ AssembleDiagonal()

void mfem::MFBilinearFormExtension::AssembleDiagonal ( Vector & diag ) const

virtual

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 from mfem::BilinearFormExtension.

Definition at line 64 of file bilinearform_ext.cpp.

◆ FormLinearSystem()

void mfem::MFBilinearFormExtension::FormLinearSystem	(	const Array< int > &	ess_tdof_list,
		Vector &	x,
		Vector &	b,
		OperatorHandle &	A,
		Vector &	X,
		Vector &	B,
		int	copy_interior = 0 )

virtual

Implements mfem::BilinearFormExtension.

Definition at line 118 of file bilinearform_ext.cpp.

◆ FormSystemMatrix()

void mfem::MFBilinearFormExtension::FormSystemMatrix	(	const Array< int > &	ess_tdof_list,
		OperatorHandle &	A )

virtual

Implements mfem::BilinearFormExtension.

Definition at line 110 of file bilinearform_ext.cpp.

◆ Mult()

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

virtual

Operator application: y=A(x).

Implements mfem::Operator.

Definition at line 129 of file bilinearform_ext.cpp.

◆ MultTranspose()

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

virtual

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 187 of file bilinearform_ext.cpp.

◆ Update()

void mfem::MFBilinearFormExtension::Update ( )

virtual

Implements mfem::BilinearFormExtension.

Definition at line 98 of file bilinearform_ext.cpp.

Member Data Documentation

◆ bdr_face_restrict_lex

const FaceRestriction* mfem::MFBilinearFormExtension::bdr_face_restrict_lex

protected

Definition at line 197 of file bilinearform_ext.hpp.

◆ bdr_face_X

Vector mfem::MFBilinearFormExtension::bdr_face_X

mutableprotected

Definition at line 194 of file bilinearform_ext.hpp.

◆ bdr_face_Y

Vector mfem::MFBilinearFormExtension::bdr_face_Y

protected

Definition at line 194 of file bilinearform_ext.hpp.

◆ elem_restrict

const Operator* mfem::MFBilinearFormExtension::elem_restrict

protected

Definition at line 195 of file bilinearform_ext.hpp.

◆ int_face_restrict_lex

const FaceRestriction* mfem::MFBilinearFormExtension::int_face_restrict_lex

protected

Definition at line 196 of file bilinearform_ext.hpp.

◆ int_face_X

Vector mfem::MFBilinearFormExtension::int_face_X

mutableprotected

Definition at line 193 of file bilinearform_ext.hpp.

◆ int_face_Y

Vector mfem::MFBilinearFormExtension::int_face_Y

protected

Definition at line 193 of file bilinearform_ext.hpp.

◆ localX

Vector mfem::MFBilinearFormExtension::localX

mutableprotected

Definition at line 192 of file bilinearform_ext.hpp.

◆ localY

Vector mfem::MFBilinearFormExtension::localY

protected

Definition at line 192 of file bilinearform_ext.hpp.

◆ test_fes

const FiniteElementSpace * mfem::MFBilinearFormExtension::test_fes

protected

Definition at line 191 of file bilinearform_ext.hpp.

◆ trial_fes

const FiniteElementSpace* mfem::MFBilinearFormExtension::trial_fes

protected

Definition at line 191 of file bilinearform_ext.hpp.

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

fem/bilinearform_ext.hpp
fem/bilinearform_ext.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MFBilinearFormExtension()

Member Function Documentation

◆ Assemble()

◆ AssembleDiagonal()

◆ FormLinearSystem()

◆ FormSystemMatrix()

◆ Mult()

◆ MultTranspose()

◆ Update()

Member Data Documentation

◆ bdr_face_restrict_lex

◆ bdr_face_X

◆ bdr_face_Y

◆ elem_restrict

◆ int_face_restrict_lex

◆ int_face_X

◆ int_face_Y

◆ localX

◆ localY

◆ test_fes

◆ trial_fes