Data and methods for partially-assembled bilinear forms. More...

#include <bilinearform_ext.hpp>

Inheritance diagram for mfem::PABilinearFormExtension:

Collaboration diagram for mfem::PABilinearFormExtension:

Public Member Functions
	PABilinearFormExtension (BilinearForm *)

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

void	AssembleDiagonal (Vector &diag) const override
	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) override

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

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

void	AbsMult (const Vector &x, Vector &y) const override
	Action of the absolute-value operator: `y=\|A\|(x)`. The default behavior in class Operator is to generate an error. If the Operator is a composition of several operators, the composition unfold into a product of absolute-value operators too.

void	MultTranspose (const Vector &x, Vector &y) const override
	Action of the transpose operator: `y=A^t(x)`. The default behavior in class Operator is to generate an error.

void	Update () override

Public Member Functions inherited from mfem::BilinearFormExtension
	BilinearFormExtension (BilinearForm *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.

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	AbsMultTranspose (const Vector &x, Vector &y) const
	Action of the transpose absolute-value 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 void	MultMV (const MultiVector &x, MultiVector &y) const
	Operator application, y = A(x), where the input x and the output y are MultiVector objects, i.e. they generally use non-contiguous memory representation.

virtual void	MultTransposeMV (const MultiVector &x, MultiVector &y) const
	Action of the transpose operator, y = A^t(x), where the input x and the output y are MultiVector objects, i.e. they generally use non-contiguous memory representation.

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 Operator &	GetGradientMV (const MultiVector &x) const
	Evaluate the gradient operator at the point x. The input x is provided as a MultiVector, i.e. it generally uses non-contiguous memory representation.

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	SetupRestrictionOperators (const L2FaceValues m)

void	MultInternal (const Vector &x, Vector &y, const bool useAbs=false) const

void	AddMultWithMarkers (const BilinearFormIntegrator &integ, const Vector &x, const Array< int > *markers, const Array< int > &attributes, const bool transpose, Vector &y, const bool useAbs=false) const
	Accumulate the action (or transpose) of the integrator on x into y, taking into account the (possibly null) markers array.

void	AddMultNormalDerivativesWithMarkers (const BilinearFormIntegrator &integ, const Vector &x, const Vector &dxdn, const Array< int > *markers, const Array< int > &attributes, Vector &y, Vector &dydn) const
	Performs the same function as AddMultWithMarkers, but takes as input and output face normal derivatives.

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
const FiniteElementSpace *	trial_fes

const FiniteElementSpace *	test_fes

const Array< int > *	elem_attributes
	Attributes of all mesh elements.

const Array< int > *	bdr_face_attributes

Vector	tmp_evec

Vector	localX

Vector	localY

Vector	int_face_X

Vector	int_face_Y

Vector	bdr_face_X

Vector	bdr_face_Y

Vector	int_face_dXdn

Vector	int_face_dYdn

Vector	bdr_face_dXdn

Vector	bdr_face_dYdn

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

Detailed Description

Data and methods for partially-assembled bilinear forms.

Definition at line 67 of file bilinearform_ext.hpp.

Constructor & Destructor Documentation

◆ PABilinearFormExtension()

mfem::PABilinearFormExtension::PABilinearFormExtension ( BilinearForm * form )

Definition at line 246 of file bilinearform_ext.cpp.

Member Function Documentation

◆ AbsMult()

void mfem::PABilinearFormExtension::AbsMult	(	const Vector &	x,
		Vector &	y ) const

inlineoverridevirtual

Action of the absolute-value operator: y=|A|(x). The default behavior in class Operator is to generate an error. If the Operator is a composition of several operators, the composition unfold into a product of absolute-value operators too.

Reimplemented from mfem::Operator.

Definition at line 97 of file bilinearform_ext.hpp.

◆ AddMultNormalDerivativesWithMarkers()

void mfem::PABilinearFormExtension::AddMultNormalDerivativesWithMarkers	(	const BilinearFormIntegrator &	integ,
		const Vector &	x,
		const Vector &	dxdn,
		const Array< int > *	markers,
		const Array< int > &	attributes,
		Vector &	y,
		Vector &	dydn ) const

protected

Performs the same function as AddMultWithMarkers, but takes as input and output face normal derivatives.

This is required when the integrator requires face normal derivatives, for example, DGDiffusionIntegrator.

This is called when the integrator's member function BilinearFormIntegrator::RequiresFaceNormalDerivatives() returns true.

Definition at line 776 of file bilinearform_ext.cpp.

◆ AddMultWithMarkers()

void mfem::PABilinearFormExtension::AddMultWithMarkers	(	const BilinearFormIntegrator &	integ,
		const Vector &	x,
		const Array< int > *	markers,
		const Array< int > &	attributes,
		const bool	transpose,
		Vector &	y,
		const bool	useAbs = false ) const

protected

Accumulate the action (or transpose) of the integrator on x into y, taking into account the (possibly null) markers array.

If markers is non-null, then only those elements or boundary elements whose attribute is marked in the markers array will be added to y.

Parameters

integ	The integrator (domain, boundary, or boundary face).
x	Input E-vector.
markers	Marked attributes (possibly null, meaning all attributes).
attributes	Array of element or boundary element attributes.
transpose	Compute the action or transpose of the integrator .
y	Output E-vector
useAbs	Apply absolute-value operator

Definition at line 807 of file bilinearform_ext.cpp.

◆ Assemble()

void mfem::PABilinearFormExtension::Assemble ( )

overridevirtual

Assemble at the level given for the BilinearFormExtension subclass.

Implements mfem::BilinearFormExtension.

Definition at line 332 of file bilinearform_ext.cpp.

◆ AssembleDiagonal()

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

overridevirtual

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

◆ FormLinearSystem()

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

overridevirtual

Implements mfem::BilinearFormExtension.

Definition at line 476 of file bilinearform_ext.cpp.

◆ FormSystemMatrix()

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

overridevirtual

Implements mfem::BilinearFormExtension.

Definition at line 468 of file bilinearform_ext.cpp.

◆ Mult()

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

inlineoverridevirtual

Operator application: y=A(x).

Implements mfem::Operator.

Definition at line 95 of file bilinearform_ext.hpp.

◆ MultInternal()

void mfem::PABilinearFormExtension::MultInternal	(	const Vector &	x,
		Vector &	y,
		const bool	useAbs = false ) const

protected

Definition at line 487 of file bilinearform_ext.cpp.

◆ MultTranspose()

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

overridevirtual

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

◆ SetupRestrictionOperators()

void mfem::PABilinearFormExtension::SetupRestrictionOperators ( const L2FaceValues m )

protected

Definition at line 256 of file bilinearform_ext.cpp.

◆ Update()

void mfem::PABilinearFormExtension::Update ( )

overridevirtual

Implements mfem::BilinearFormExtension.

Definition at line 456 of file bilinearform_ext.cpp.

Member Data Documentation

◆ bdr_face_attributes

const Array<int>* mfem::PABilinearFormExtension::bdr_face_attributes

protected

Definition at line 73 of file bilinearform_ext.hpp.

◆ bdr_face_dXdn

Vector mfem::PABilinearFormExtension::bdr_face_dXdn

mutableprotected

Definition at line 79 of file bilinearform_ext.hpp.

◆ bdr_face_dYdn

Vector mfem::PABilinearFormExtension::bdr_face_dYdn

protected

Definition at line 79 of file bilinearform_ext.hpp.

◆ bdr_face_restrict_lex

const FaceRestriction* mfem::PABilinearFormExtension::bdr_face_restrict_lex

protected

Definition at line 82 of file bilinearform_ext.hpp.

◆ bdr_face_X

Vector mfem::PABilinearFormExtension::bdr_face_X

mutableprotected

Definition at line 77 of file bilinearform_ext.hpp.

◆ bdr_face_Y

Vector mfem::PABilinearFormExtension::bdr_face_Y

protected

Definition at line 77 of file bilinearform_ext.hpp.

◆ elem_attributes

const Array<int>* mfem::PABilinearFormExtension::elem_attributes

protected

Attributes of all mesh elements.

Definition at line 72 of file bilinearform_ext.hpp.

◆ elem_restrict

const Operator* mfem::PABilinearFormExtension::elem_restrict

protected

Definition at line 80 of file bilinearform_ext.hpp.

◆ int_face_dXdn

Vector mfem::PABilinearFormExtension::int_face_dXdn

mutableprotected

Definition at line 78 of file bilinearform_ext.hpp.

◆ int_face_dYdn

Vector mfem::PABilinearFormExtension::int_face_dYdn

protected

Definition at line 78 of file bilinearform_ext.hpp.

◆ int_face_restrict_lex

const FaceRestriction* mfem::PABilinearFormExtension::int_face_restrict_lex

protected

Definition at line 81 of file bilinearform_ext.hpp.

◆ int_face_X

Vector mfem::PABilinearFormExtension::int_face_X

mutableprotected

Definition at line 76 of file bilinearform_ext.hpp.

◆ int_face_Y

Vector mfem::PABilinearFormExtension::int_face_Y

protected

Definition at line 76 of file bilinearform_ext.hpp.

◆ localX

Vector mfem::PABilinearFormExtension::localX

mutableprotected

Definition at line 75 of file bilinearform_ext.hpp.

◆ localY

Vector mfem::PABilinearFormExtension::localY

protected

Definition at line 75 of file bilinearform_ext.hpp.

◆ test_fes

const FiniteElementSpace * mfem::PABilinearFormExtension::test_fes

protected

Definition at line 70 of file bilinearform_ext.hpp.

◆ tmp_evec

Vector mfem::PABilinearFormExtension::tmp_evec

mutableprotected

Definition at line 74 of file bilinearform_ext.hpp.

◆ trial_fes

const FiniteElementSpace* mfem::PABilinearFormExtension::trial_fes

protected

Definition at line 70 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 Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PABilinearFormExtension()

Member Function Documentation

◆ AbsMult()

◆ AddMultNormalDerivativesWithMarkers()

◆ AddMultWithMarkers()

◆ Assemble()

◆ AssembleDiagonal()

◆ FormLinearSystem()

◆ FormSystemMatrix()

◆ Mult()

◆ MultInternal()

◆ MultTranspose()

◆ SetupRestrictionOperators()

◆ Update()

Member Data Documentation

◆ bdr_face_attributes

◆ bdr_face_dXdn

◆ bdr_face_dYdn

◆ bdr_face_restrict_lex

◆ bdr_face_X

◆ bdr_face_Y

◆ elem_attributes

◆ elem_restrict

◆ int_face_dXdn

◆ int_face_dYdn

◆ int_face_restrict_lex

◆ int_face_X

◆ int_face_Y

◆ localX

◆ localY

◆ test_fes

◆ tmp_evec

◆ trial_fes