Operator that converts FiniteElementSpace L-vectors to E-vectors. More...

#include <restriction.hpp>

Inheritance diagram for mfem::ElementRestriction:

Collaboration diagram for mfem::ElementRestriction:

Public Member Functions
	ElementRestriction (const FiniteElementSpace &, ElementDofOrdering)

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

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	AddMultTranspose (const Vector &x, Vector &y, const real_t a=1.0) const override
	Add the E-vector degrees of freedom x to the L-vector degrees of freedom y.

void	MultUnsigned (const Vector &x, Vector &y) const
	Compute Mult without applying signs based on DOF orientations.

void	MultTransposeUnsigned (const Vector &x, Vector &y) const
	Compute MultTranspose without applying signs based on DOF orientations.

void	MultLeftInverse (const Vector &x, Vector &y) const

void	BooleanMask (Vector &y) const
	Fills the E-vector y with `boolean` values 0.0 and 1.0 such that each each entry of the L-vector is uniquely represented in `y`.

void	FillSparseMatrix (const Vector &mat_ea, SparseMatrix &mat) const
	Fill a Sparse Matrix with Element Matrices.

int	FillI (SparseMatrix &mat) const

void	FillJAndData (const Vector &ea_data, SparseMatrix &mat) const

Low-level access to the underlying element-dof mappings
const Array< int > &	GatherMap () const

const Array< int > &	Indices () const

const Array< int > &	Offsets () const

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 MemoryClass	GetMemoryClass () const
	Return the MemoryClass preferred by the Operator.

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	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 Attributes
const FiniteElementSpace &	fes

const int	ne

const int	vdim

const bool	byvdim

const int	ndofs

const int	dof

const int	nedofs

Array< int >	offsets

Array< int >	indices

Array< int >	gather_map

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

Operator that converts FiniteElementSpace L-vectors to E-vectors.

Objects of this type are typically created and owned by FiniteElementSpace objects, see FiniteElementSpace::GetElementRestriction().

Definition at line 40 of file restriction.hpp.

Constructor & Destructor Documentation

◆ ElementRestriction()

mfem::ElementRestriction::ElementRestriction	(	const FiniteElementSpace &	f,
		ElementDofOrdering	e_ordering )

Definition at line 26 of file restriction.cpp.

Member Function Documentation

◆ AddMultTranspose()

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

overridevirtual

Add the E-vector degrees of freedom x to the L-vector degrees of freedom y.

Implements mfem::ElementRestrictionOperator.

Definition at line 185 of file restriction.cpp.

◆ BooleanMask()

void mfem::ElementRestriction::BooleanMask ( Vector & y ) const

Fills the E-vector y with boolean values 0.0 and 1.0 such that each each entry of the L-vector is uniquely represented in y.

This means, the sum of the E-vector y is equal to the sum of the corresponding L-vector filled with ones. The boolean mask is required to emulate SetSubVector and its transpose on GPUs. This method is running on the host, since the processed array requires a large shared memory.

Definition at line 245 of file restriction.cpp.

◆ FillI()

int mfem::ElementRestriction::FillI ( SparseMatrix & mat ) const

Fill the I array of SparseMatrix corresponding to the sparsity pattern given by this ElementRestriction.

Definition at line 321 of file restriction.cpp.

◆ FillJAndData()

void mfem::ElementRestriction::FillJAndData	(	const Vector &	ea_data,
		SparseMatrix &	mat ) const

Fill the J and Data arrays of SparseMatrix corresponding to the sparsity pattern given by this ElementRestriction, and the values of ea_data.

Definition at line 402 of file restriction.cpp.

◆ FillSparseMatrix()

void mfem::ElementRestriction::FillSparseMatrix	(	const Vector &	mat_ea,
		SparseMatrix &	mat ) const

Fill a Sparse Matrix with Element Matrices.

Definition at line 282 of file restriction.cpp.

◆ GatherMap()

const Array< int > & mfem::ElementRestriction::GatherMap ( ) const

inline

Definition at line 100 of file restriction.hpp.

◆ Indices()

const Array< int > & mfem::ElementRestriction::Indices ( ) const

inline

Definition at line 101 of file restriction.hpp.

◆ Mult()

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

overridevirtual

Operator application: y=A(x).

Implements mfem::Operator.

Definition at line 106 of file restriction.cpp.

◆ MultLeftInverse()

void mfem::ElementRestriction::MultLeftInverse	(	const Vector &	x,
		Vector &	y ) const

Compute MultTranspose by setting (rather than adding) element contributions; this is a left inverse of the Mult() operation

Definition at line 220 of file restriction.cpp.

◆ MultTranspose()

void mfem::ElementRestriction::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 179 of file restriction.cpp.

◆ MultTransposeUnsigned()

void mfem::ElementRestriction::MultTransposeUnsigned	(	const Vector &	x,
		Vector &	y ) const

Compute MultTranspose without applying signs based on DOF orientations.

Definition at line 193 of file restriction.cpp.

◆ MultUnsigned()

void mfem::ElementRestriction::MultUnsigned	(	const Vector &	x,
		Vector &	y ) const

Compute Mult without applying signs based on DOF orientations.

Definition at line 128 of file restriction.cpp.

◆ Offsets()

const Array< int > & mfem::ElementRestriction::Offsets ( ) const

inline

Definition at line 102 of file restriction.hpp.

Member Data Documentation

◆ byvdim

const bool mfem::ElementRestriction::byvdim

protected

Definition at line 51 of file restriction.hpp.

◆ dof

const int mfem::ElementRestriction::dof

protected

Definition at line 53 of file restriction.hpp.

◆ fes

const FiniteElementSpace& mfem::ElementRestriction::fes

protected

Definition at line 48 of file restriction.hpp.

◆ gather_map

Array<int> mfem::ElementRestriction::gather_map

protected

Definition at line 57 of file restriction.hpp.

◆ indices

Array<int> mfem::ElementRestriction::indices

protected

Definition at line 56 of file restriction.hpp.

◆ ndofs

const int mfem::ElementRestriction::ndofs

protected

Definition at line 52 of file restriction.hpp.

◆ ne

const int mfem::ElementRestriction::ne

protected

Definition at line 49 of file restriction.hpp.

◆ nedofs

const int mfem::ElementRestriction::nedofs

protected

Definition at line 54 of file restriction.hpp.

◆ offsets

Array<int> mfem::ElementRestriction::offsets

protected

Definition at line 55 of file restriction.hpp.

◆ vdim

const int mfem::ElementRestriction::vdim

protected

Definition at line 50 of file restriction.hpp.

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

fem/restriction.hpp
fem/restriction.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ElementRestriction()

Member Function Documentation

◆ AddMultTranspose()

◆ BooleanMask()

◆ FillI()

◆ FillJAndData()

◆ FillSparseMatrix()

◆ GatherMap()

◆ Indices()

◆ Mult()

◆ MultLeftInverse()

◆ MultTranspose()

◆ MultTransposeUnsigned()

◆ MultUnsigned()

◆ Offsets()

Member Data Documentation

◆ byvdim

◆ dof

◆ fes

◆ gather_map

◆ indices

◆ ndofs

◆ ne

◆ nedofs

◆ offsets

◆ vdim