MFEM  v4.1.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
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
 Operator application: y=A(x). More...
 
void MultTranspose (const Vector &x, Vector &y) const
 Action of the transpose operator: y=A^t(x). The default behavior in class Operator is to generate an error. More...
 
void MultTransposeUnsigned (const Vector &x, Vector &y) const
 Compute MultTranspose without applying signs based on DOF orientations. 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 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 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 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 > gatherMap
 
- 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  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...
 
- 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, taking in input/output Prolongation matrices. 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 31 of file restriction.hpp.

Constructor & Destructor Documentation

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

Definition at line 69 of file restriction.cpp.

Member Function Documentation

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

Operator application: y=A(x).

Implements mfem::Operator.

Definition at line 149 of file restriction.cpp.

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

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 171 of file restriction.cpp.

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

Compute MultTranspose without applying signs based on DOF orientations.

Definition at line 199 of file restriction.cpp.

Member Data Documentation

const bool mfem::ElementRestriction::byvdim
protected

Definition at line 37 of file restriction.hpp.

const int mfem::ElementRestriction::dof
protected

Definition at line 39 of file restriction.hpp.

const FiniteElementSpace& mfem::ElementRestriction::fes
protected

Definition at line 34 of file restriction.hpp.

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

Definition at line 43 of file restriction.hpp.

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

Definition at line 42 of file restriction.hpp.

const int mfem::ElementRestriction::ndofs
protected

Definition at line 38 of file restriction.hpp.

const int mfem::ElementRestriction::ne
protected

Definition at line 35 of file restriction.hpp.

const int mfem::ElementRestriction::nedofs
protected

Definition at line 40 of file restriction.hpp.

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

Definition at line 41 of file restriction.hpp.

const int mfem::ElementRestriction::vdim
protected

Definition at line 36 of file restriction.hpp.


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