MFEM  v4.5.2
Finite element discretization library
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mfem::H1FaceRestriction Class Reference

Operator that extracts Face degrees of freedom for H1 FiniteElementSpaces. More...

#include <restriction.hpp>

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

Public Member Functions

 H1FaceRestriction (const FiniteElementSpace &fes, const ElementDofOrdering ordering, const FaceType type)
 Construct an H1FaceRestriction. 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 double a=1.0) const override
 Gather the degrees of freedom, i.e. goes from face E-Vector to L-Vector. More...
 
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. More...
 
- Public Member Functions inherited from mfem::FaceRestriction
 FaceRestriction ()
 
 FaceRestriction (int h, int w)
 
virtual ~FaceRestriction ()
 
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. More...
 
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 void AddMult (const Vector &x, Vector &y, const double a=1.0) const
 Operator application: y+=A(x) (default) or y+=a*A(x). More...
 
virtual void ArrayMult (const Array< const Vector *> &X, Array< Vector *> &Y) const
 Operator application on a matrix: Y=A(X). More...
 
virtual void ArrayMultTranspose (const Array< const Vector *> &X, Array< Vector *> &Y) const
 Action of the transpose operator on a matrix: Y=A^t(X). More...
 
virtual void ArrayAddMult (const Array< const Vector *> &X, Array< Vector *> &Y, const double a=1.0) const
 Operator application on a matrix: Y+=A(X) (default) or Y+=a*A(X). More...
 
virtual void ArrayAddMultTranspose (const Array< const Vector *> &X, Array< Vector *> &Y, const double a=1.0) const
 Operator transpose application on a matrix: Y+=A^t(X) (default) or Y+=a*A^t(X). 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

 H1FaceRestriction (const FiniteElementSpace &fes, const ElementDofOrdering ordering, const FaceType type, bool build)
 Construct an H1FaceRestriction. More...
 
void CheckFESpace (const ElementDofOrdering ordering)
 Verify that H1FaceRestriction is build from an H1 FESpace. More...
 
void SetFaceDofsScatterIndices (const Mesh::FaceInformation &face, const int face_index, const ElementDofOrdering ordering)
 Set the scattering indices of elem1, and increment the offsets for the face described by the face. More...
 
void SetFaceDofsGatherIndices (const Mesh::FaceInformation &face, const int face_index, const ElementDofOrdering ordering)
 Set the gathering indices of elem1 for the interior face described by the face. 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 vdim
 
const bool byvdim
 
const int face_dofs
 
const int elem_dofs
 
const int nfdofs
 
const int ndofs
 
Array< int > scatter_indices
 
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,
  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 for H1 FiniteElementSpaces.

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

Definition at line 224 of file restriction.hpp.

Constructor & Destructor Documentation

◆ H1FaceRestriction() [1/2]

mfem::H1FaceRestriction::H1FaceRestriction ( const FiniteElementSpace fes,
const ElementDofOrdering  ordering,
const FaceType  type,
bool  build 
)
protected

Construct an H1FaceRestriction.

Parameters
[in]fesThe FiniteElementSpace on which this operates
[in]orderingRequest a specific element ordering
[in]typeRequest internal or boundary faces dofs
[in]buildRequest the NCL2FaceRestriction to compute the scatter/gather indices. False should only be used when inheriting from H1FaceRestriction.

Definition at line 710 of file restriction.cpp.

◆ H1FaceRestriction() [2/2]

mfem::H1FaceRestriction::H1FaceRestriction ( const FiniteElementSpace fes,
const ElementDofOrdering  ordering,
const FaceType  type 
)

Construct an H1FaceRestriction.

Parameters
[in]fesThe FiniteElementSpace on which this operates
[in]orderingRequest a specific element ordering
[in]typeRequest internal or boundary faces dofs

Definition at line 739 of file restriction.cpp.

Member Function Documentation

◆ AddMultTranspose()

void mfem::H1FaceRestriction::AddMultTranspose ( const Vector x,
Vector y,
const double  a = 1.0 
) 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: 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.
[in]aScalar coefficient for addition.

Implements mfem::FaceRestriction.

Definition at line 767 of file restriction.cpp.

◆ AddMultTransposeInPlace()

virtual void mfem::FaceRestriction::AddMultTransposeInPlace
inline

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.

Parameters
[in,out]xThe face degrees of freedom on the face.
[in,out]yThe L-vector of degrees of freedom to which we add the face degrees of freedom.
Note
This method is an optimization of AddMultTranspose where the x Vector is used and modified to avoid memory allocation and memcpy.

Definition at line 202 of file restriction.hpp.

◆ CheckFESpace()

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

Verify that H1FaceRestriction is build from an H1 FESpace.

Parameters
[in]orderingThe FESpace element ordering.

Definition at line 797 of file restriction.cpp.

◆ Mult()

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

Definition at line 745 of file restriction.cpp.

◆ SetFaceDofsGatherIndices()

void mfem::H1FaceRestriction::SetFaceDofsGatherIndices ( const Mesh::FaceInformation face,
const int  face_index,
const ElementDofOrdering  ordering 
)
protected

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

Parameters
[in]faceThe face information of the current face.
[in]face_indexThe interior/boundary face index.
[in]orderingRequest a specific element ordering.

Definition at line 948 of file restriction.cpp.

◆ SetFaceDofsScatterIndices()

void mfem::H1FaceRestriction::SetFaceDofsScatterIndices ( const Mesh::FaceInformation face,
const int  face_index,
const ElementDofOrdering  ordering 
)
protected

Set the scattering indices of elem1, and increment the offsets for the face described by the face.

Parameters
[in]faceThe face information of the current face.
[in]face_indexThe interior/boundary face index.
[in]orderingRequest a specific element ordering.

Definition at line 913 of file restriction.cpp.

Member Data Documentation

◆ byvdim

const bool mfem::H1FaceRestriction::byvdim
protected

Definition at line 230 of file restriction.hpp.

◆ elem_dofs

const int mfem::H1FaceRestriction::elem_dofs
protected

Definition at line 232 of file restriction.hpp.

◆ face_dofs

const int mfem::H1FaceRestriction::face_dofs
protected

Definition at line 231 of file restriction.hpp.

◆ face_map

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

Definition at line 311 of file restriction.hpp.

◆ fes

const FiniteElementSpace& mfem::H1FaceRestriction::fes
protected

Definition at line 227 of file restriction.hpp.

◆ gather_indices

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

Definition at line 237 of file restriction.hpp.

◆ gather_offsets

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

Definition at line 236 of file restriction.hpp.

◆ ndofs

const int mfem::H1FaceRestriction::ndofs
protected

Definition at line 234 of file restriction.hpp.

◆ nf

const int mfem::H1FaceRestriction::nf
protected

Definition at line 228 of file restriction.hpp.

◆ nfdofs

const int mfem::H1FaceRestriction::nfdofs
protected

Definition at line 233 of file restriction.hpp.

◆ scatter_indices

Array<int> mfem::H1FaceRestriction::scatter_indices
protected

Definition at line 235 of file restriction.hpp.

◆ vdim

const int mfem::H1FaceRestriction::vdim
protected

Definition at line 229 of file restriction.hpp.


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