MFEM  v4.5.1 Finite element discretization library
mfem::FaceRestriction Class Referenceabstract

Base class for operators that extracts Face degrees of freedom. More...

#include <restriction.hpp>

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

## Public Member Functions

FaceRestriction ()

FaceRestriction (int h, int w)

virtual ~FaceRestriction ()

void Mult (const Vector &x, Vector &y) const override=0
Extract the face degrees of freedom from x into y. More...

virtual void AddMultTranspose (const Vector &x, Vector &y) const =0
Add the face degrees of freedom x to the element degrees of freedom y. 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...

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...

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() 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 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...

## Detailed Description

Base class for operators that extracts Face degrees of freedom.

In order to compute quantities on the faces of a mesh, it is often useful to extract the degrees of freedom on the faces of the elements. This class provides an interface for such operations.

If the FiniteElementSpace is ordered by Ordering::byVDIM, then the expected format for the L-vector is (vdim x ndofs), otherwise if Ordering::byNODES the expected format is (ndofs x vdim), where ndofs is the total number of degrees of freedom. Since FiniteElementSpace can either be continuous or discontinuous, the degrees of freedom on a face can either be single valued or double valued, this is what we refer to as the multiplicity and is represented by the L2FaceValues enum type. The format of the output face E-vector of degrees of freedom is (face_dofs x vdim x multiplicity x nfaces), where face_dofs is the number of degrees of freedom on each face, and nfaces the number of faces of the requested FaceType (see FiniteElementSpace::GetNFbyType).

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

Definition at line 160 of file restriction.hpp.

## Constructor & Destructor Documentation

 mfem::FaceRestriction::FaceRestriction ( )
inline

Definition at line 163 of file restriction.hpp.

 mfem::FaceRestriction::FaceRestriction ( int h, int w )
inline

Definition at line 165 of file restriction.hpp.

 virtual mfem::FaceRestriction::~FaceRestriction ( )
inlinevirtual

Definition at line 167 of file restriction.hpp.

## Member Function Documentation

 virtual void mfem::FaceRestriction::AddMultTranspose ( const Vector & x, Vector & y ) const
pure virtual

Add the face degrees of freedom x to the element degrees of freedom y.

Parameters
 [in] x The face degrees of freedom on the face. [in,out] y The L-vector of degrees of freedom to which we add the face degrees of freedom.
 virtual void mfem::FaceRestriction::AddMultTransposeInPlace ( Vector & x, Vector & y ) const
inlinevirtual

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] x The face degrees of freedom on the face. [in,out] y The 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.

Reimplemented in mfem::NCL2FaceRestriction, mfem::ParNCL2FaceRestriction, and mfem::ParNCH1FaceRestriction.

Definition at line 197 of file restriction.hpp.

 void mfem::FaceRestriction::Mult ( const Vector & x, Vector & y ) const
overridepure virtual

Extract the face degrees of freedom from x into y.

Parameters
 [in] x The L-vector of degrees of freedom. [out] y The degrees of freedom on the face, corresponding to a face E-vector.

Implements mfem::Operator.

 void mfem::FaceRestriction::MultTranspose ( const Vector & x, Vector & y ) const
inlineoverridevirtual

Set the face degrees of freedom in the element degrees of freedom y to the values given in x.

Parameters
 [in] x The face degrees of freedom on the face. [in,out] y The L-vector of degrees of freedom to which we add the face degrees of freedom.

Reimplemented from mfem::Operator.

Definition at line 209 of file restriction.hpp.

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