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

Operator that converts FiniteElementSpace L-vectors to E-vectors. More...

#include <restriction.hpp>

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

Public Member Functions

 ElementRestriction (const FiniteElementSpace &, ElementDofOrdering)
 
void Mult (const Vector &x, Vector &y) const override
 Operator application: y=A(x). More...
 
void MultTranspose (const Vector &x, Vector &y) const override
 Action of the transpose operator: y=A^t(x). The default behavior in class Operator is to generate an error. More...
 
void AddMultTranspose (const Vector &x, Vector &y, const double a=1.0) const override
 Add the E-vector degrees of freedom x to the L-vector degrees of freedom y. More...
 
void MultUnsigned (const Vector &x, Vector &y) const
 Compute Mult without applying signs based on DOF orientations. More...
 
void MultTransposeUnsigned (const Vector &x, Vector &y) const
 Compute MultTranspose without applying signs based on DOF orientations. More...
 
void MultLeftInverse (const Vector &x, Vector &y) const
 
void BooleanMask (Vector &y) const
 Fills the E-vector y with boolean values 0.0 and 1.0 such that each each entry of the L-vector is uniquely represented in y. More...
 
void FillSparseMatrix (const Vector &mat_ea, SparseMatrix &mat) const
 Fill a Sparse Matrix with Element Matrices. More...
 
int FillI (SparseMatrix &mat) const
 
void FillJAndData (const Vector &ea_data, SparseMatrix &mat) const
 
Low-level access to the underlying element-dof mappings
const Array< int > & GatherMap () const
 
const Array< int > & Indices () const
 
const Array< int > & Offsets () const
 
- 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 Attributes

const FiniteElementSpacefes
 
const int ne
 
const int vdim
 
const bool byvdim
 
const int ndofs
 
const int dof
 
const int nedofs
 
Array< int > offsets
 
Array< int > indices
 
Array< int > gather_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...
 
- 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...
 

Detailed Description

Operator that converts FiniteElementSpace L-vectors to E-vectors.

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

Definition at line 37 of file restriction.hpp.

Constructor & Destructor Documentation

◆ ElementRestriction()

mfem::ElementRestriction::ElementRestriction ( const FiniteElementSpace f,
ElementDofOrdering  e_ordering 
)

Definition at line 27 of file restriction.cpp.

Member Function Documentation

◆ AddMultTranspose()

void mfem::ElementRestriction::AddMultTranspose ( const Vector x,
Vector y,
const double  a = 1.0 
) const
overridevirtual

Add the E-vector degrees of freedom x to the L-vector degrees of freedom y.

Implements mfem::ElementRestrictionOperator.

Definition at line 186 of file restriction.cpp.

◆ BooleanMask()

void mfem::ElementRestriction::BooleanMask ( Vector y) const

Fills the E-vector y with boolean values 0.0 and 1.0 such that each each entry of the L-vector is uniquely represented in y.

This means, the sum of the E-vector y is equal to the sum of the corresponding L-vector filled with ones. The boolean mask is required to emulate SetSubVector and its transpose on GPUs. This method is running on the host, since the processed array requires a large shared memory.

Definition at line 246 of file restriction.cpp.

◆ FillI()

int mfem::ElementRestriction::FillI ( SparseMatrix mat) const

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

Definition at line 322 of file restriction.cpp.

◆ FillJAndData()

void mfem::ElementRestriction::FillJAndData ( const Vector ea_data,
SparseMatrix mat 
) const

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

Definition at line 399 of file restriction.cpp.

◆ FillSparseMatrix()

void mfem::ElementRestriction::FillSparseMatrix ( const Vector mat_ea,
SparseMatrix mat 
) const

Fill a Sparse Matrix with Element Matrices.

Definition at line 283 of file restriction.cpp.

◆ GatherMap()

const Array<int>& mfem::ElementRestriction::GatherMap ( ) const
inline

Definition at line 97 of file restriction.hpp.

◆ Indices()

const Array<int>& mfem::ElementRestriction::Indices ( ) const
inline

Definition at line 98 of file restriction.hpp.

◆ Mult()

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

Operator application: y=A(x).

Implements mfem::Operator.

Definition at line 107 of file restriction.cpp.

◆ MultLeftInverse()

void mfem::ElementRestriction::MultLeftInverse ( const Vector x,
Vector y 
) const

Compute MultTranspose by setting (rather than adding) element contributions; this is a left inverse of the Mult() operation

Definition at line 221 of file restriction.cpp.

◆ MultTranspose()

void mfem::ElementRestriction::MultTranspose ( const Vector x,
Vector y 
) const
overridevirtual

Action of the transpose operator: y=A^t(x). The default behavior in class Operator is to generate an error.

Reimplemented from mfem::Operator.

Definition at line 180 of file restriction.cpp.

◆ MultTransposeUnsigned()

void mfem::ElementRestriction::MultTransposeUnsigned ( const Vector x,
Vector y 
) const

Compute MultTranspose without applying signs based on DOF orientations.

Definition at line 194 of file restriction.cpp.

◆ MultUnsigned()

void mfem::ElementRestriction::MultUnsigned ( const Vector x,
Vector y 
) const

Compute Mult without applying signs based on DOF orientations.

Definition at line 129 of file restriction.cpp.

◆ Offsets()

const Array<int>& mfem::ElementRestriction::Offsets ( ) const
inline

Definition at line 99 of file restriction.hpp.

Member Data Documentation

◆ byvdim

const bool mfem::ElementRestriction::byvdim
protected

Definition at line 48 of file restriction.hpp.

◆ dof

const int mfem::ElementRestriction::dof
protected

Definition at line 50 of file restriction.hpp.

◆ fes

const FiniteElementSpace& mfem::ElementRestriction::fes
protected

Definition at line 45 of file restriction.hpp.

◆ gather_map

Array<int> mfem::ElementRestriction::gather_map
protected

Definition at line 54 of file restriction.hpp.

◆ indices

Array<int> mfem::ElementRestriction::indices
protected

Definition at line 53 of file restriction.hpp.

◆ ndofs

const int mfem::ElementRestriction::ndofs
protected

Definition at line 49 of file restriction.hpp.

◆ ne

const int mfem::ElementRestriction::ne
protected

Definition at line 46 of file restriction.hpp.

◆ nedofs

const int mfem::ElementRestriction::nedofs
protected

Definition at line 51 of file restriction.hpp.

◆ offsets

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

Definition at line 52 of file restriction.hpp.

◆ vdim

const int mfem::ElementRestriction::vdim
protected

Definition at line 47 of file restriction.hpp.


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