MFEM  v4.4.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mfem::L2FaceRestriction Class Reference

Operator that extracts Face degrees of freedom for L2 spaces. More...

#include <restriction.hpp>

Inheritance diagram for mfem::L2FaceRestriction:
[legend]
Collaboration diagram for mfem::L2FaceRestriction:
[legend]

Public Member Functions

 L2FaceRestriction (const FiniteElementSpace &fes, const ElementDofOrdering ordering, const FaceType type, const L2FaceValues m=L2FaceValues::DoubleValued)
 Constructs an L2FaceRestriction. More...
 
void Mult (const Vector &x, Vector &y) const override
 Scatter the degrees of freedom, i.e. goes from L-Vector to face E-Vector. More...
 
void AddMultTranspose (const Vector &x, Vector &y) const override
 Gather the degrees of freedom, i.e. goes from face E-Vector to L-Vector. More...
 
virtual void FillI (SparseMatrix &mat, const bool keep_nbr_block=false) const
 Fill the I array of SparseMatrix corresponding to the sparsity pattern given by this L2FaceRestriction. More...
 
virtual void FillJAndData (const Vector &fea_data, SparseMatrix &mat, const bool keep_nbr_block=false) const
 Fill the J and Data arrays of the SparseMatrix corresponding to the sparsity pattern given by this L2FaceRestriction, and the values of fea_data. More...
 
virtual void AddFaceMatricesToElementMatrices (const Vector &fea_data, Vector &ea_data) const
 This methods adds the DG face matrices to the element matrices. More...
 
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. More...
 
virtual void DoubleValuedConformingMult (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::DoubleValued. More...
 
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. More...
 
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. More...
 
- Public Member Functions inherited from mfem::FaceRestriction
 FaceRestriction ()
 
 FaceRestriction (int h, int w)
 
virtual ~FaceRestriction ()
 
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. More...
 
- 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. More...
 
 Operator (int s=0)
 Construct a square Operator with given size s (default 0). More...
 
 Operator (int h, int w)
 Construct an Operator with the given height (output size) and width (input size). More...
 
int Height () const
 Get the height (size of output) of the Operator. Synonym with NumRows(). More...
 
int NumRows () const
 Get the number of rows (size of output) of the Operator. Synonym with Height(). More...
 
int Width () const
 Get the width (size of input) of the Operator. Synonym with NumCols(). More...
 
int NumCols () const
 Get the number of columns (size of input) of the Operator. Synonym with Width(). More...
 
virtual MemoryClass GetMemoryClass () const
 Return the MemoryClass preferred by the Operator. More...
 
virtual OperatorGetGradient (const Vector &x) const
 Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error. More...
 
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. More...
 
virtual const OperatorGetProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity. More...
 
virtual const OperatorGetRestriction () const
 Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. NULL means identity. More...
 
virtual const OperatorGetOutputProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. NULL means identity. More...
 
virtual const OperatorGetOutputRestrictionTranspose () const
 Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators. More...
 
virtual const OperatorGetOutputRestriction () const
 Restriction operator from output vectors for the operator to linear algebra (linear system) vectors. NULL means identity. More...
 
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. More...
 
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. More...
 
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(). More...
 
void FormSystemOperator (const Array< int > &ess_tdof_list, Operator *&A)
 Return in A a parallel (on truedofs) version of this square operator. More...
 
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). More...
 
void FormDiscreteOperator (Operator *&A)
 Return in A a parallel (on truedofs) version of this rectangular operator. More...
 
void PrintMatlab (std::ostream &out, int n, int m=0) const
 Prints operator with input size n and output size m in Matlab format. More...
 
virtual void PrintMatlab (std::ostream &out) const
 Prints operator in Matlab format. More...
 
virtual ~Operator ()
 Virtual destructor. More...
 
Type GetType () const
 Return the type ID of the Operator class. More...
 

Protected Member Functions

 L2FaceRestriction (const FiniteElementSpace &fes, const ElementDofOrdering ordering, const FaceType type, const L2FaceValues m, bool build)
 Constructs an L2FaceRestriction. More...
 
void CheckFESpace (const ElementDofOrdering ordering)
 Verify that L2FaceRestriction is build from an L2 FESpace. More...
 
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. More...
 
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. More...
 
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. More...
 
void SetBoundaryDofsScatterIndices2 (const Mesh::FaceInformation &face, const int face_index)
 Set the scattering indices of elem2 for the boundary face described by the face. More...
 
void SetFaceDofsGatherIndices1 (const Mesh::FaceInformation &face, const int face_index)
 Set the gathering indices of elem1 for the interior face described by the face. More...
 
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. More...
 
- Protected Member Functions inherited from mfem::Operator
void FormConstrainedSystemOperator (const Array< int > &ess_tdof_list, ConstrainedOperator *&Aout)
 see FormSystemOperator() More...
 
void FormRectangularConstrainedSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, RectangularConstrainedOperator *&Aout)
 see FormRectangularSystemOperator() More...
 
OperatorSetupRAP (const Operator *Pi, const Operator *Po)
 Returns RAP Operator of this, using input/output Prolongation matrices Pi corresponds to "P", Po corresponds to "Rt". More...
 

Protected Attributes

const FiniteElementSpacefes
 
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
 
Array< int > face_map
 
- Protected Attributes inherited from mfem::Operator
int height
 Dimension of the output / number of rows in the matrix. More...
 
int width
 Dimension of the input / number of columns in the matrix. More...
 

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
}
 Enumeration defining IDs for some classes derived from Operator. More...
 

Detailed Description

Operator that extracts Face degrees of freedom for L2 spaces.

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

Definition at line 288 of file restriction.hpp.

Constructor & Destructor Documentation

mfem::L2FaceRestriction::L2FaceRestriction ( const FiniteElementSpace fes,
const ElementDofOrdering  ordering,
const FaceType  type,
const L2FaceValues  m,
bool  build 
)
protected

Constructs an L2FaceRestriction.

Parameters
[in]fesThe FiniteElementSpace on which this operates
[in]orderingRequest a specific ordering
[in]typeRequest internal or boundary faces dofs
[in]mRequest the face dofs for elem1, or both elem1 and elem2
[in]buildRequest the NCL2FaceRestriction to compute the scatter/gather indices. False should only be used when inheriting from L2FaceRestriction.

Definition at line 1069 of file restriction.cpp.

mfem::L2FaceRestriction::L2FaceRestriction ( const FiniteElementSpace fes,
const ElementDofOrdering  ordering,
const FaceType  type,
const L2FaceValues  m = L2FaceValues::DoubleValued 
)

Constructs an L2FaceRestriction.

Parameters
[in]fesThe FiniteElementSpace on which this operates
[in]orderingRequest a specific ordering
[in]typeRequest internal or boundary faces dofs
[in]mRequest the face dofs for elem1, or both elem1 and elem2

Definition at line 1104 of file restriction.cpp.

Member Function Documentation

void mfem::L2FaceRestriction::AddFaceMatricesToElementMatrices ( const Vector fea_data,
Vector ea_data 
) const
virtual

This methods adds the DG face matrices to the element matrices.

Parameters
[in]fea_dataThe 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 and second local matrices correspond to the contributions of elem1 and elem2 on themselves respectively.
[in,out]ea_dataThe dense matrices representing the element local contributions for each element to which will be added the face contributions. The format is: dofs x dofs x ne, where dofs is the number of dofs per element and ne the number of elements.

Reimplemented in mfem::NCL2FaceRestriction.

Definition at line 1301 of file restriction.cpp.

void mfem::L2FaceRestriction::AddMultTranspose ( const Vector x,
Vector y 
) const
overridevirtual

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

Parameters
[in]xThe 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 should be ordered according to the given ElementDofOrdering
[in,out]yThe L-vector degrees of freedom.

Implements mfem::FaceRestriction.

Reimplemented in mfem::NCL2FaceRestriction.

Definition at line 1241 of file restriction.cpp.

void mfem::L2FaceRestriction::CheckFESpace ( const ElementDofOrdering  ordering)
protected

Verify that L2FaceRestriction is build from an L2 FESpace.

Parameters
[in]orderingThe FESpace element ordering.

Definition at line 1361 of file restriction.cpp.

void mfem::L2FaceRestriction::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.

Parameters
[in]xThe 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 should be ordered according to the given ElementDofOrdering
[in,out]yThe L-vector degrees of freedom.

Definition at line 1208 of file restriction.cpp.

void mfem::L2FaceRestriction::DoubleValuedConformingMult ( const Vector x,
Vector y 
) const
virtual

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]xThe L-vector degrees of freedom.
[out]yThe 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 in mfem::ParL2FaceRestriction.

Definition at line 1136 of file restriction.cpp.

void mfem::L2FaceRestriction::FillI ( SparseMatrix mat,
const bool  keep_nbr_block = false 
) const
virtual

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

Parameters
[in,out]matThe sparse matrix for which we want to initialize the row offsets.
[in]keep_nbr_blockWhen 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 in mfem::NCL2FaceRestriction, mfem::ParNCL2FaceRestriction, and mfem::ParL2FaceRestriction.

Definition at line 1254 of file restriction.cpp.

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

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

Parameters
[in]fea_dataThe 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]matThe sparse matrix that is getting filled.
[in]keep_nbr_blockWhen 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 in mfem::NCL2FaceRestriction, mfem::ParNCL2FaceRestriction, and mfem::ParL2FaceRestriction.

Definition at line 1270 of file restriction.cpp.

void mfem::L2FaceRestriction::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]xThe L-vector degrees of freedom.
[out]yThe 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.

Implements mfem::FaceRestriction.

Reimplemented in mfem::NCL2FaceRestriction.

Definition at line 1167 of file restriction.cpp.

void mfem::L2FaceRestriction::PermuteAndSetFaceDofsGatherIndices2 ( const Mesh::FaceInformation face,
const int  face_index 
)
protected

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.

Note: This function modifies the offsets.

Parameters
[in]faceThe face information of the current face.
[in]face_indexThe interior/boundary face index.

Definition at line 1606 of file restriction.cpp.

void mfem::L2FaceRestriction::PermuteAndSetFaceDofsScatterIndices2 ( const Mesh::FaceInformation face,
const int  face_index 
)
protected

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.

Parameters
[in]faceThe face information of the current face.
[in]face_indexThe interior/boundary face index.

Definition at line 1507 of file restriction.cpp.

void mfem::L2FaceRestriction::PermuteAndSetSharedFaceDofsScatterIndices2 ( const Mesh::FaceInformation face,
const int  face_index 
)
protected

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.

Parameters
[in]faceThe face information of the current face.
[in]face_indexThe interior/boundary face index.

Definition at line 1536 of file restriction.cpp.

void mfem::L2FaceRestriction::SetBoundaryDofsScatterIndices2 ( const Mesh::FaceInformation face,
const int  face_index 
)
protected

Set the scattering indices of elem2 for the boundary face described by the face.

Parameters
[in]faceThe face information of the current face.
[in]face_indexThe interior/boundary face index.

Definition at line 1568 of file restriction.cpp.

void mfem::L2FaceRestriction::SetFaceDofsGatherIndices1 ( const Mesh::FaceInformation face,
const int  face_index 
)
protected

Set the gathering indices of elem1 for the interior face described by the face.

Note: This function modifies the offsets.

Parameters
[in]faceThe face information of the current face.
[in]face_indexThe interior/boundary face index.

Definition at line 1582 of file restriction.cpp.

void mfem::L2FaceRestriction::SetFaceDofsScatterIndices1 ( const Mesh::FaceInformation face,
const int  face_index 
)
protected

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.

Parameters
[in]faceThe face information of the current face.
[in]face_indexThe interior/boundary face index.

Definition at line 1483 of file restriction.cpp.

void mfem::L2FaceRestriction::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.

Parameters
[in]xThe face E-Vector degrees of freedom with the given format: 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 should be ordered according to the given ElementDofOrdering
[in,out]yThe L-vector degrees of freedom.

Definition at line 1180 of file restriction.cpp.

void mfem::L2FaceRestriction::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.

Parameters
[in]xThe L-vector degrees of freedom.
[out]yThe face E-Vector degrees of freedom with the given format: 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.

Definition at line 1111 of file restriction.cpp.

Member Data Documentation

const bool mfem::L2FaceRestriction::byvdim
protected

Definition at line 295 of file restriction.hpp.

const int mfem::L2FaceRestriction::elem_dofs
protected

Definition at line 297 of file restriction.hpp.

const int mfem::L2FaceRestriction::face_dofs
protected

Definition at line 296 of file restriction.hpp.

Array<int> mfem::L2FaceRestriction::face_map
mutableprotected

Definition at line 431 of file restriction.hpp.

const FiniteElementSpace& mfem::L2FaceRestriction::fes
protected

Definition at line 291 of file restriction.hpp.

Array<int> mfem::L2FaceRestriction::gather_indices
protected

Definition at line 305 of file restriction.hpp.

Array<int> mfem::L2FaceRestriction::gather_offsets
protected

Definition at line 304 of file restriction.hpp.

const L2FaceValues mfem::L2FaceRestriction::m
protected

Definition at line 301 of file restriction.hpp.

const int mfem::L2FaceRestriction::ndofs
protected

Definition at line 299 of file restriction.hpp.

const int mfem::L2FaceRestriction::ne
protected

Definition at line 293 of file restriction.hpp.

const int mfem::L2FaceRestriction::nf
protected

Definition at line 292 of file restriction.hpp.

const int mfem::L2FaceRestriction::nfdofs
protected

Definition at line 298 of file restriction.hpp.

Array<int> mfem::L2FaceRestriction::scatter_indices1
protected

Definition at line 302 of file restriction.hpp.

Array<int> mfem::L2FaceRestriction::scatter_indices2
protected

Definition at line 303 of file restriction.hpp.

const FaceType mfem::L2FaceRestriction::type
protected

Definition at line 300 of file restriction.hpp.

const int mfem::L2FaceRestriction::vdim
protected

Definition at line 294 of file restriction.hpp.


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