MFEM  v4.3.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 on L2 FiniteElementSpaces. More...

#include <restriction.hpp>

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

Public Member Functions

 L2FaceRestriction (const FiniteElementSpace &, const ElementDofOrdering, const FaceType, const L2FaceValues m=L2FaceValues::DoubleValued)
 
void Mult (const Vector &x, Vector &y) const override
 Extract the face degrees of freedom from x into y. More...
 
void AddMultTranspose (const Vector &x, Vector &y) const override
 Add the face degrees of freedom x to the element degrees of freedom y. More...
 
virtual void FillI (SparseMatrix &mat, const bool keep_nbr_block=false) const
 
virtual void FillJAndData (const Vector &ea_data, SparseMatrix &mat, const bool keep_nbr_block=false) const
 
void AddFaceMatricesToElementMatrices (Vector &fea_data, Vector &ea_data) const
 This methods adds the DG face matrices to the element matrices. 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=0, int m=0) const
 Prints operator with input size n and output size m 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 &, const FaceType, const L2FaceValues m=L2FaceValues::DoubleValued)
 
- 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 ndofs
 
const int dof
 
const int elemDofs
 
const L2FaceValues m
 
const int nfdofs
 
Array< int > scatter_indices1
 
Array< int > scatter_indices2
 
Array< int > offsets
 
Array< int > gather_indices
 
- 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 on L2 FiniteElementSpaces.

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

Definition at line 221 of file restriction.hpp.

Constructor & Destructor Documentation

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

Definition at line 993 of file restriction.cpp.

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

Definition at line 1015 of file restriction.cpp.

Member Function Documentation

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

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

Definition at line 1364 of file restriction.cpp.

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

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

Parameters
[in]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.

Implements mfem::FaceRestriction.

Definition at line 1261 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.

Reimplemented in mfem::ParL2FaceRestriction.

Definition at line 1317 of file restriction.cpp.

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

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

Reimplemented in mfem::ParL2FaceRestriction.

Definition at line 1333 of file restriction.cpp.

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

Extract the face degrees of freedom from x into y.

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

Implements mfem::FaceRestriction.

Definition at line 1214 of file restriction.cpp.

Member Data Documentation

const bool mfem::L2FaceRestriction::byvdim
protected

Definition at line 228 of file restriction.hpp.

const int mfem::L2FaceRestriction::dof
protected

Definition at line 230 of file restriction.hpp.

const int mfem::L2FaceRestriction::elemDofs
protected

Definition at line 231 of file restriction.hpp.

const FiniteElementSpace& mfem::L2FaceRestriction::fes
protected

Definition at line 224 of file restriction.hpp.

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

Definition at line 237 of file restriction.hpp.

const L2FaceValues mfem::L2FaceRestriction::m
protected

Definition at line 232 of file restriction.hpp.

const int mfem::L2FaceRestriction::ndofs
protected

Definition at line 229 of file restriction.hpp.

const int mfem::L2FaceRestriction::ne
protected

Definition at line 226 of file restriction.hpp.

const int mfem::L2FaceRestriction::nf
protected

Definition at line 225 of file restriction.hpp.

const int mfem::L2FaceRestriction::nfdofs
protected

Definition at line 233 of file restriction.hpp.

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

Definition at line 236 of file restriction.hpp.

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

Definition at line 234 of file restriction.hpp.

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

Definition at line 235 of file restriction.hpp.

const int mfem::L2FaceRestriction::vdim
protected

Definition at line 227 of file restriction.hpp.


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