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

#include <bilinearform_ext.hpp>

Inheritance diagram for mfem::PAMixedBilinearFormExtension:

Collaboration diagram for mfem::PAMixedBilinearFormExtension:

Public Member Functions
	PAMixedBilinearFormExtension (MixedBilinearForm *form)

void	Assemble ()
	Partial assembly of all internal integrators.

void	FormRectangularSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, OperatorHandle &A)
	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)

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

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

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

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

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

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

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

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

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

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

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

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 mixed bilinear forms.

Definition at line 258 of file bilinearform_ext.hpp.

Constructor & Destructor Documentation

◆ PAMixedBilinearFormExtension()

mfem::PAMixedBilinearFormExtension::PAMixedBilinearFormExtension ( MixedBilinearForm * form )

Definition at line 1516 of file bilinearform_ext.cpp.

Member Function Documentation

◆ AddMult()

void mfem::PAMixedBilinearFormExtension::AddMult	(	const Vector &	x,
		Vector &	y,
		const real_t	c = 1.0 ) const

virtual

y += c*A*x

Reimplemented from mfem::Operator.

Definition at line 1636 of file bilinearform_ext.cpp.

◆ AddMultTranspose()

void mfem::PAMixedBilinearFormExtension::AddMultTranspose	(	const Vector &	x,
		Vector &	y,
		const real_t	c = 1.0 ) const

virtual

y += c*A^T*x

Reimplemented from mfem::Operator.

Definition at line 1668 of file bilinearform_ext.cpp.

◆ Assemble()

void mfem::PAMixedBilinearFormExtension::Assemble ( )

virtual

Partial assembly of all internal integrators.

Implements mfem::MixedBilinearFormExtension.

Definition at line 1527 of file bilinearform_ext.cpp.

◆ AssembleDiagonal_ADAt()

void mfem::PAMixedBilinearFormExtension::AssembleDiagonal_ADAt	(	const Vector &	D,
		Vector &	diag ) const

virtual

Assemble the diagonal of ADA^T for a diagonal vector D.

Implements mfem::MixedBilinearFormExtension.

Definition at line 1693 of file bilinearform_ext.cpp.

◆ FormRectangularLinearSystem()

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

virtual

Setup OperatorHandle A to contain constrained linear operator and eliminate columns corresponding to essential dofs from system, updating RHS B vector with the results.

Implements mfem::MixedBilinearFormExtension.

Definition at line 1577 of file bilinearform_ext.cpp.

◆ FormRectangularSystemOperator()

void mfem::PAMixedBilinearFormExtension::FormRectangularSystemOperator	(	const Array< int > &	trial_tdof_list,
		const Array< int > &	test_tdof_list,
		OperatorHandle &	A )

virtual

Setup OperatorHandle A to contain constrained linear operator.

OperatorHandle A contains matrix-free constrained operator formed for RAP system where ess_tdof_list are in trial space and eliminated from "columns" of A.

Implements mfem::MixedBilinearFormExtension.

Definition at line 1566 of file bilinearform_ext.cpp.

◆ Mult()

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

virtual

y = A*x

Implements mfem::Operator.

Definition at line 1630 of file bilinearform_ext.cpp.

◆ MultTranspose()

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

virtual

y = A^T*x

Reimplemented from mfem::Operator.

Definition at line 1661 of file bilinearform_ext.cpp.

◆ SetupMultInputs()

void mfem::PAMixedBilinearFormExtension::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

protected

Helper function to set up inputs/outputs for Mult or MultTranspose.

Definition at line 1590 of file bilinearform_ext.cpp.

◆ Update()

void mfem::PAMixedBilinearFormExtension::Update ( )

virtual

Update internals for when a new MixedBilinearForm is given to this class.

Implements mfem::MixedBilinearFormExtension.

Definition at line 1543 of file bilinearform_ext.cpp.

Member Data Documentation

◆ elem_restrict_test

const Operator* mfem::PAMixedBilinearFormExtension::elem_restrict_test

protected

Definition at line 264 of file bilinearform_ext.hpp.

◆ elem_restrict_trial

const Operator* mfem::PAMixedBilinearFormExtension::elem_restrict_trial

protected

Definition at line 263 of file bilinearform_ext.hpp.

◆ localTest

Vector mfem::PAMixedBilinearFormExtension::localTest

protected

Definition at line 262 of file bilinearform_ext.hpp.

◆ localTrial

Vector mfem::PAMixedBilinearFormExtension::localTrial

mutableprotected

Definition at line 262 of file bilinearform_ext.hpp.

◆ tempY

Vector mfem::PAMixedBilinearFormExtension::tempY

protected

Definition at line 262 of file bilinearform_ext.hpp.

◆ test_fes

const FiniteElementSpace * mfem::PAMixedBilinearFormExtension::test_fes

protected

Definition at line 261 of file bilinearform_ext.hpp.

◆ trial_fes

const FiniteElementSpace* mfem::PAMixedBilinearFormExtension::trial_fes

protected

Definition at line 261 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

◆ PAMixedBilinearFormExtension()

Member Function Documentation

◆ AddMult()

◆ AddMultTranspose()

◆ Assemble()

◆ AssembleDiagonal_ADAt()

◆ FormRectangularLinearSystem()

◆ FormRectangularSystemOperator()

◆ Mult()

◆ MultTranspose()

◆ SetupMultInputs()

◆ Update()

Member Data Documentation

◆ elem_restrict_test

◆ elem_restrict_trial

◆ localTest

◆ localTrial

◆ tempY

◆ test_fes

◆ trial_fes