Operator that extracts face degrees of freedom for L2 interface spaces. More...

#include <restriction.hpp>

Inheritance diagram for mfem::L2InterfaceFaceRestriction:

Collaboration diagram for mfem::L2InterfaceFaceRestriction:

Public Member Functions
	L2InterfaceFaceRestriction (const FiniteElementSpace &fes_, const ElementDofOrdering ordering_, const FaceType type_)
	Constructs an L2InterfaceFaceRestriction.

void	Mult (const Vector &x, Vector &y) const override
	Scatter the degrees of freedom, i.e. goes from L-Vector to face E-Vector.

void	AddMultTranspose (const Vector &x, Vector &y, const real_t a=1.0) const override
	Gather the degrees of freedom, i.e. goes from face E-Vector to L-Vector.

const Array< int > &	GatherMap () const override
	Low-level access to the underlying gather map.

Public Member Functions inherited from mfem::FaceRestriction
	FaceRestriction ()

	FaceRestriction (int h, int w)

virtual	~FaceRestriction ()

virtual void	AddMultTransposeUnsigned (const Vector &x, Vector &y, const real_t a=1.0) const
	Add the face degrees of freedom x to the element degrees of freedom y ignoring the signs from DOF orientation.

virtual void	AddMultTransposeInPlace (Vector &x, Vector &y) const
	Add the face degrees of freedom x to the element degrees of freedom y. Perform the same computation as AddMultTranspose, but x is invalid after calling this method.

void	MultTranspose (const Vector &x, Vector &y) const override
	Set the face degrees of freedom in the element degrees of freedom y to the values given in x.

virtual void	NormalDerivativeMult (const Vector &x, Vector &y) const
	For each face, sets y to the partial derivative of x with respect to the reference coordinate whose direction is perpendicular to the face on the reference element.

virtual void	NormalDerivativeAddMultTranspose (const Vector &x, Vector &y) const
	Add the face reference-normal derivative degrees of freedom in x to the element degrees of freedom in y.

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
	The finite element space.

const ElementDofOrdering	ordering
	Requested ordering.

const FaceType	type
	Face type (interior or boundary)

const int	nfaces
	Number of faces of the requested type.

const int	vdim
	vdim of the space

const bool	byvdim
	DOF ordering (by nodes or by vdim)

const int	face_dofs
	Number of dofs on each face.

const int	nfdofs
	Total number of dofs on the faces (E-vector size)

const int	ndofs
	Number of dofs in the space (L-vector size)

Array< int >	gather_map
	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 extracts face degrees of freedom for L2 interface spaces.

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

Definition at line 1073 of file restriction.hpp.

Constructor & Destructor Documentation

◆ L2InterfaceFaceRestriction()

mfem::L2InterfaceFaceRestriction::L2InterfaceFaceRestriction	(	const FiniteElementSpace &	fes_,
		const ElementDofOrdering	ordering_,
		const FaceType	type_ )

Constructs an L2InterfaceFaceRestriction.

Parameters

[in]	fes_	The FiniteElementSpace on which this operates
[in]	ordering_	Request a specific face dof ordering
[in]	type_	Request internal or boundary faces dofs

Definition at line 2280 of file restriction.cpp.

Member Function Documentation

◆ AddMultTranspose()

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

overridevirtual

Gather the degrees of freedom, i.e. goes from face E-Vector to L-Vector.

Parameters

[in]	x	The face E-Vector degrees of freedom with size (face_dofs, vdim, nf), where nf is the number of interior or boundary faces requested by type in the constructor. The face_dofs should be ordered according to the given ElementDofOrdering
[in,out]	y	The L-vector degrees of freedom.
[in]	a	Scalar coefficient for addition.

Implements mfem::FaceRestriction.

Definition at line 2335 of file restriction.cpp.

◆ GatherMap()

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

overridevirtual

Low-level access to the underlying gather map.

Reimplemented from mfem::FaceRestriction.

Definition at line 2358 of file restriction.cpp.

◆ Mult()

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

overridevirtual

Scatter the degrees of freedom, i.e. goes from L-Vector to face E-Vector.

Parameters

[in]	x	The L-vector degrees of freedom.
[out]	y	The face E-Vector degrees of freedom with size (face_dofs, vdim, nf), where nf is the number of interior or boundary faces requested by type in the constructor. The face_dofs are ordered according to the given ElementDofOrdering.

Implements mfem::FaceRestriction.

Definition at line 2314 of file restriction.cpp.

Member Data Documentation

◆ byvdim

const bool mfem::L2InterfaceFaceRestriction::byvdim

protected

DOF ordering (by nodes or by vdim)

Definition at line 1081 of file restriction.hpp.

◆ face_dofs

const int mfem::L2InterfaceFaceRestriction::face_dofs

protected

Number of dofs on each face.

Definition at line 1082 of file restriction.hpp.

◆ fes

const FiniteElementSpace& mfem::L2InterfaceFaceRestriction::fes

protected

The finite element space.

Definition at line 1076 of file restriction.hpp.

◆ gather_map

Array<int> mfem::L2InterfaceFaceRestriction::gather_map

protected

Gather map.

Definition at line 1085 of file restriction.hpp.

◆ ndofs

const int mfem::L2InterfaceFaceRestriction::ndofs

protected

Number of dofs in the space (L-vector size)

Definition at line 1084 of file restriction.hpp.

◆ nfaces

const int mfem::L2InterfaceFaceRestriction::nfaces

protected

Number of faces of the requested type.

Definition at line 1079 of file restriction.hpp.

◆ nfdofs

const int mfem::L2InterfaceFaceRestriction::nfdofs

protected

Total number of dofs on the faces (E-vector size)

Definition at line 1083 of file restriction.hpp.

◆ ordering

const ElementDofOrdering mfem::L2InterfaceFaceRestriction::ordering

protected

Requested ordering.

Definition at line 1077 of file restriction.hpp.

◆ type

const FaceType mfem::L2InterfaceFaceRestriction::type

protected

Face type (interior or boundary)

Definition at line 1078 of file restriction.hpp.

◆ vdim

const int mfem::L2InterfaceFaceRestriction::vdim

protected

vdim of the space

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

◆ L2InterfaceFaceRestriction()

Member Function Documentation

◆ AddMultTranspose()

◆ GatherMap()

◆ Mult()

Member Data Documentation

◆ byvdim

◆ face_dofs

◆ fes

◆ gather_map

◆ ndofs

◆ nfaces

◆ nfdofs

◆ ordering

◆ type

◆ vdim