Operator that extracts Face degrees of freedom in parallel. More...

#include <prestriction.hpp>

Inheritance diagram for mfem::ParL2FaceRestriction:

Collaboration diagram for mfem::ParL2FaceRestriction:

Public Member Functions
	ParL2FaceRestriction (const ParFiniteElementSpace &fes, ElementDofOrdering f_ordering, FaceType type, L2FaceValues m=L2FaceValues::DoubleValued)
	Constructs an ParL2FaceRestriction.

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	FillI (SparseMatrix &mat, const bool keep_nbr_block=false) const override

void	FillI (SparseMatrix &mat, SparseMatrix &face_mat) const

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

void	FillJAndData (const Vector &fea_data, SparseMatrix &mat, const bool keep_nbr_block=false) const override
	Fill the J and Data arrays of the SparseMatrix corresponding to the sparsity pattern given by this ParL2FaceRestriction, and the values of fea_data.

void	DoubleValuedConformingMult (const Vector &x, Vector &y) const override
	Scatter the degrees of freedom, i.e. goes from L-Vector to face E-Vector. Should only be used with conforming faces and when: m == L2FacesValues::DoubleValued.

Public Member Functions inherited from mfem::L2FaceRestriction
	L2FaceRestriction (const FiniteElementSpace &fes, const ElementDofOrdering f_ordering, const FaceType type, const L2FaceValues m=L2FaceValues::DoubleValued)
	Constructs an L2FaceRestriction.

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.

virtual void	AddFaceMatricesToElementMatrices (const Vector &fea_data, Vector &ea_data) const
	This methods adds the DG face matrices to the element matrices.

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

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

void	SingleValuedConformingMult (const Vector &x, Vector &y) const
	Scatter the degrees of freedom, i.e. goes from L-Vector to face E-Vector. Should only be used with conforming faces and when: m == L2FacesValues::SingleValued.

void	SingleValuedConformingAddMultTranspose (const Vector &x, Vector &y) const
	Gather the degrees of freedom, i.e. goes from face E-Vector to L-Vector. Should only be used with conforming faces and when: m == L2FacesValues::SingleValued.

void	DoubleValuedConformingAddMultTranspose (const Vector &x, Vector &y) const
	Gather the degrees of freedom, i.e. goes from face E-Vector to L-Vector. Should only be used with conforming faces and when: m == L2FacesValues::DoubleValued.

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.

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 Member Functions
	ParL2FaceRestriction (const ParFiniteElementSpace &pfes_, ElementDofOrdering f_ordering, FaceType type, L2FaceValues m, bool build)
	Constructs an ParL2FaceRestriction.

Protected Member Functions inherited from mfem::L2FaceRestriction
	L2FaceRestriction (const FiniteElementSpace &fes, const ElementDofOrdering f_ordering, const FaceType type, const L2FaceValues m, bool build)
	Constructs an L2FaceRestriction.

void	CheckFESpace ()
	Verify that L2FaceRestriction is built from an L2 FESpace.

void	SetFaceDofsScatterIndices1 (const Mesh::FaceInformation &face, const int face_index)
	Set the scattering indices of elem1, and increment the offsets for the face described by the face. The ordering of the face dofs of elem1 is lexicographic relative to elem1.

void	PermuteAndSetFaceDofsScatterIndices2 (const Mesh::FaceInformation &face, const int face_index)
	Permute and set the scattering indices of elem2, and increment the offsets for the face described by the face. The permutation orders the dofs of elem2 lexicographically as the ones of elem1.

void	PermuteAndSetSharedFaceDofsScatterIndices2 (const Mesh::FaceInformation &face, const int face_index)
	Permute and set the scattering indices of elem2 for the shared face described by the face. The permutation orders the dofs of elem2 as the ones of elem1.

void	SetBoundaryDofsScatterIndices2 (const Mesh::FaceInformation &face, const int face_index)
	Set the scattering indices of elem2 for the boundary face described by the face.

void	SetFaceDofsGatherIndices1 (const Mesh::FaceInformation &face, const int face_index)
	Set the gathering indices of elem1 for the interior face described by the face.

void	PermuteAndSetFaceDofsGatherIndices2 (const Mesh::FaceInformation &face, const int face_index)
	Permute and set the gathering indices of elem2 for the interior face described by the face. The permutation orders the dofs of elem2 as the ones of elem1.

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 ParFiniteElementSpace &	pfes

Protected Attributes inherited from mfem::L2FaceRestriction
const FiniteElementSpace &	fes

const ElementDofOrdering	ordering

const int	nf

const int	ne

const int	vdim

const bool	byvdim

const int	face_dofs

const int	elem_dofs

const int	nfdofs

const int	ndofs

const FaceType	type

const L2FaceValues	m

Array< int >	scatter_indices1

Array< int >	scatter_indices2

Array< int >	gather_offsets

Array< int >	gather_indices

std::unique_ptr< L2NormalDerivativeFaceRestriction >	normal_deriv_restr

Array< int >	face_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...

Detailed Description

Operator that extracts Face degrees of freedom in parallel.

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

Definition at line 139 of file prestriction.hpp.

Constructor & Destructor Documentation

◆ ParL2FaceRestriction() [1/2]

mfem::ParL2FaceRestriction::ParL2FaceRestriction	(	const ParFiniteElementSpace &	pfes_,
		ElementDofOrdering	f_ordering,
		FaceType	type,
		L2FaceValues	m,
		bool	build )

protected

Constructs an ParL2FaceRestriction.

Parameters

[in]	pfes_	The ParFiniteElementSpace on which this operates
[in]	f_ordering	Request a specific face dof ordering
[in]	type	Request internal or boundary faces dofs
[in]	m	Request the face dofs for elem1, or both elem1 and elem2
[in]	build	Request the ParL2FaceRestriction to compute the scatter/gather indices. False should only be used when inheriting from ParL2FaceRestriction.

Definition at line 281 of file prestriction.cpp.

◆ ParL2FaceRestriction() [2/2]

mfem::ParL2FaceRestriction::ParL2FaceRestriction	(	const ParFiniteElementSpace &	fes,
		ElementDofOrdering	f_ordering,
		FaceType	type,
		L2FaceValues	m = L2FaceValues::DoubleValued )

Constructs an ParL2FaceRestriction.

Parameters

[in]	fes	The ParFiniteElementSpace on which this operates
[in]	f_ordering	Request a specific face dof ordering
[in]	type	Request internal or boundary faces dofs
[in]	m	Request the face dofs for elem1, or both elem1 and elem2

Definition at line 299 of file prestriction.cpp.

Member Function Documentation

◆ DoubleValuedConformingMult()

void mfem::ParL2FaceRestriction::DoubleValuedConformingMult	(	const Vector &	x,
		Vector &	y ) const

overridevirtual

Scatter the degrees of freedom, i.e. goes from L-Vector to face E-Vector. Should only be used with conforming faces and when: m == L2FacesValues::DoubleValued.

Parameters

[in]	x	The L-vector degrees of freedom.
[out]	y	The face E-Vector degrees of freedom with the given format: face_dofs x vdim x 2 x 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.

Reimplemented from mfem::L2FaceRestriction.

Definition at line 306 of file prestriction.cpp.

◆ FillI() [1/2]

void mfem::ParL2FaceRestriction::FillI	(	SparseMatrix &	mat,
		const bool	keep_nbr_block = false ) const

overridevirtual

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

Parameters

[in,out]	mat	The sparse matrix for which we want to initialize the row offsets.
[in]	keep_nbr_block	When set to true the SparseMatrix will include the rows (in addition to the columns) corresponding to face-neighbor dofs. The default behavior is to disregard those rows.

Reimplemented from mfem::L2FaceRestriction.

Reimplemented in mfem::ParNCL2FaceRestriction.

Definition at line 378 of file prestriction.cpp.

◆ FillI() [2/2]

void mfem::ParL2FaceRestriction::FillI	(	SparseMatrix &	mat,
		SparseMatrix &	face_mat ) const

Fill the I array of SparseMatrix corresponding to the sparsity pattern given by this ParL2FaceRestriction. mat contains the interior dofs contribution, the face_mat contains the shared dofs contribution.

Definition at line 407 of file prestriction.cpp.

◆ FillJAndData() [1/2]

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

Fill the J and Data arrays of SparseMatrix corresponding to the sparsity pattern given by this ParL2FaceRestriction, and the values of ea_data. mat contains the interior dofs contribution, the face_mat contains the shared dofs contribution.

Definition at line 504 of file prestriction.cpp.

◆ FillJAndData() [2/2]

void mfem::ParL2FaceRestriction::FillJAndData	(	const Vector &	fea_data,
		SparseMatrix &	mat,
		const bool	keep_nbr_block = false ) const

overridevirtual

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

Parameters

[in]	fea_data	The dense matrices representing the local operators on each face. The format is: face_dofs x face_dofs x 2 x nf. On each face the first local matrix corresponds to the contribution of elem1 on elem2, and the second to the contribution of elem2 on elem1.
[in,out]	mat	The sparse matrix that is getting filled.
[in]	keep_nbr_block	When set to true the SparseMatrix will include the rows (in addition to the columns) corresponding to face-neighbor dofs. The default behavior is to disregard those rows.

Reimplemented from mfem::L2FaceRestriction.

Reimplemented in mfem::ParNCL2FaceRestriction.

Definition at line 459 of file prestriction.cpp.

◆ Mult()

void mfem::ParL2FaceRestriction::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 the given format: if L2FacesValues::DoubleValued (face_dofs x vdim x 2 x nf), if L2FacesValues::SingleValued (face_dofs x vdim x 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.

Reimplemented from mfem::L2FaceRestriction.

Reimplemented in mfem::ParNCL2FaceRestriction.

Definition at line 360 of file prestriction.cpp.

Member Data Documentation

◆ pfes

const ParFiniteElementSpace& mfem::ParL2FaceRestriction::pfes

protected

Definition at line 142 of file prestriction.hpp.

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

fem/prestriction.hpp
fem/prestriction.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ParL2FaceRestriction() [1/2]

◆ ParL2FaceRestriction() [2/2]

Member Function Documentation

◆ DoubleValuedConformingMult()

◆ FillI() [1/2]

◆ FillI() [2/2]

◆ FillJAndData() [1/2]

◆ FillJAndData() [2/2]

◆ Mult()

Member Data Documentation

◆ pfes