MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
mfem::ParNCH1FaceRestriction Class Reference

Operator that extracts Face degrees of freedom for NCMesh in parallel. More...

#include <prestriction.hpp>

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

Public Member Functions

 ParNCH1FaceRestriction (const ParFiniteElementSpace &fes, ElementDofOrdering f_ordering, FaceType type)
 Constructs an ParNCH1FaceRestriction.
 
void Mult (const Vector &x, Vector &y) const override
 Scatter the degrees of freedom, i.e. goes from L-Vector to face E-Vector.
 
void AddMultTranspose (const Vector &x, Vector &y, const real_t a=1.0) const override
 Gather the degrees of freedom, i.e. goes from face E-Vector to L-Vector.
 
void AddMultTransposeInPlace (Vector &x, Vector &y) const override
 Gather the degrees of freedom, i.e. goes from face E-Vector to L-Vector.
 
void NonconformingInterpolation (Vector &x) const
 Apply a change of basis from coarse element basis to fine element basis for the coarse face dofs.
 
void NonconformingTransposeInterpolation (const Vector &x) const
 Apply a change of basis from fine element basis to coarse element basis for the coarse face dofs.
 
void NonconformingTransposeInterpolationInPlace (Vector &x) const
 Apply a change of basis from fine element basis to coarse element basis for the coarse face dofs.
 
- Public Member Functions inherited from mfem::ConformingFaceRestriction
 ConformingFaceRestriction (const FiniteElementSpace &fes, const ElementDofOrdering f_ordering, const FaceType type)
 Construct a ConformingFaceRestriction.
 
void AddMultTransposeUnsigned (const Vector &x, Vector &y, const real_t a=1.0) const override
 Gather the degrees of freedom, i.e. goes from face E-Vector to L-Vector not taking into account signs from DOF orientations.
 
- 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.
 
virtual void NormalDerivativeMult (const Vector &x, Vector &y) const
 For each face, sets y to the partial derivative of x with respect to the reference coordinate whose direction is perpendicular to the face on the reference element.
 
virtual void NormalDerivativeAddMultTranspose (const Vector &x, Vector &y) const
 Add the face reference-normal derivative degrees of freedom in x to the element degrees of freedom in y.
 
- 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.
 
 Operator (int s=0)
 Construct a square Operator with given size s (default 0).
 
 Operator (int h, int w)
 Construct an Operator with the given height (output size) and width (input size).
 
int Height () const
 Get the height (size of output) of the Operator. Synonym with NumRows().
 
int NumRows () const
 Get the number of rows (size of output) of the Operator. Synonym with Height().
 
int Width () const
 Get the width (size of input) of the Operator. Synonym with NumCols().
 
int NumCols () const
 Get the number of columns (size of input) of the Operator. Synonym with Width().
 
virtual MemoryClass GetMemoryClass () const
 Return the MemoryClass preferred by the Operator.
 
virtual void AddMult (const Vector &x, Vector &y, const real_t a=1.0) const
 Operator application: y+=A(x) (default) or y+=a*A(x).
 
virtual void ArrayMult (const Array< const Vector * > &X, Array< Vector * > &Y) const
 Operator application on a matrix: Y=A(X).
 
virtual void ArrayMultTranspose (const Array< const Vector * > &X, Array< Vector * > &Y) const
 Action of the transpose operator on a matrix: Y=A^t(X).
 
virtual void ArrayAddMult (const Array< const Vector * > &X, Array< Vector * > &Y, const real_t a=1.0) const
 Operator application on a matrix: Y+=A(X) (default) or Y+=a*A(X).
 
virtual void ArrayAddMultTranspose (const Array< const Vector * > &X, Array< Vector * > &Y, const real_t a=1.0) const
 Operator transpose application on a matrix: Y+=A^t(X) (default) or Y+=a*A^t(X).
 
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.
 
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.
 
virtual const OperatorGetProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity.
 
virtual const OperatorGetRestriction () const
 Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. NULL means identity.
 
virtual const OperatorGetOutputProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. NULL means identity.
 
virtual const OperatorGetOutputRestrictionTranspose () const
 Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators.
 
virtual const OperatorGetOutputRestriction () const
 Restriction operator from output vectors for the operator to linear algebra (linear system) vectors. NULL means identity.
 
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.
 
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.
 
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().
 
void FormSystemOperator (const Array< int > &ess_tdof_list, Operator *&A)
 Return in A a parallel (on truedofs) version of this square operator.
 
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).
 
void FormDiscreteOperator (Operator *&A)
 Return in A a parallel (on truedofs) version of this rectangular operator.
 
void PrintMatlab (std::ostream &out, int n, int m=0) const
 Prints operator with input size n and output size m in Matlab format.
 
virtual void PrintMatlab (std::ostream &out) const
 Prints operator in Matlab format.
 
virtual ~Operator ()
 Virtual destructor.
 
Type GetType () const
 Return the type ID of the Operator class.
 

Protected Attributes

const FaceType type
 
InterpolationManager interpolations
 
Vector x_interp
 
- Protected Attributes inherited from mfem::ConformingFaceRestriction
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 > vol_dof_map
 
Array< int > face_map
 
- Protected Attributes inherited from mfem::Operator
int height
 Dimension of the output / number of rows in the matrix.
 
int width
 Dimension of the input / number of columns in the matrix.
 

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::ConformingFaceRestriction
 ConformingFaceRestriction (const FiniteElementSpace &fes, const ElementDofOrdering f_ordering, const FaceType type, bool build)
 Construct a ConformingFaceRestriction.
 
void CheckFESpace (const ElementDofOrdering f_ordering)
 Verify that ConformingFaceRestriction is built from a supported finite element space.
 
void SetFaceDofsScatterIndices (const Mesh::FaceInformation &face, const int face_index, const ElementDofOrdering f_ordering)
 Set the scattering indices of elem1, and increment the offsets for the face described by the face.
 
void SetFaceDofsGatherIndices (const Mesh::FaceInformation &face, const int face_index, const ElementDofOrdering f_ordering)
 Set the gathering indices of elem1 for the interior face described by the face.
 
- Protected Member Functions inherited from mfem::Operator
void FormConstrainedSystemOperator (const Array< int > &ess_tdof_list, ConstrainedOperator *&Aout)
 see FormSystemOperator()
 
void FormRectangularConstrainedSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, RectangularConstrainedOperator *&Aout)
 see FormRectangularSystemOperator()
 
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".
 

Detailed Description

Operator that extracts Face degrees of freedom for NCMesh in parallel.

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

Definition at line 30 of file prestriction.hpp.

Constructor & Destructor Documentation

◆ ParNCH1FaceRestriction()

mfem::ParNCH1FaceRestriction::ParNCH1FaceRestriction ( const ParFiniteElementSpace & fes,
ElementDofOrdering f_ordering,
FaceType type )

Constructs an ParNCH1FaceRestriction.

Parameters
[in]fesThe ParFiniteElementSpace on which this operates
[in]f_orderingRequest a specific face dof ordering
[in]typeRequest internal or boundary faces dofs

Definition at line 27 of file prestriction.cpp.

Member Function Documentation

◆ AddMultTranspose()

void mfem::ParNCH1FaceRestriction::AddMultTranspose ( const Vector & x,
Vector & y,
const real_t 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.

Reimplemented from mfem::ConformingFaceRestriction.

Definition at line 99 of file prestriction.cpp.

◆ AddMultTransposeInPlace()

void mfem::ParNCH1FaceRestriction::AddMultTransposeInPlace ( Vector & x,
Vector & y ) const
overridevirtual

Gather the degrees of freedom, i.e. goes from face E-Vector to L-Vector.

Parameters
[in,out]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.
Note
This method is an optimization of AddMultTranspose where the x Vector is used and modified to avoid memory allocation and memcpy.

Reimplemented from mfem::ConformingFaceRestriction.

Definition at line 108 of file prestriction.cpp.

◆ Mult()

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

Reimplemented from mfem::ConformingFaceRestriction.

Definition at line 48 of file prestriction.cpp.

◆ NonconformingInterpolation()

void mfem::ParNCH1FaceRestriction::NonconformingInterpolation ( Vector & x) const

Apply a change of basis from coarse element basis to fine element basis for the coarse face dofs.

Parameters
[in,out]xThe dofs vector that needs coarse dofs to be express in term of the fine basis.

Definition at line 54 of file prestriction.cpp.

◆ NonconformingTransposeInterpolation()

void mfem::ParNCH1FaceRestriction::NonconformingTransposeInterpolation ( const Vector & x) const

Apply a change of basis from fine element basis to coarse element basis for the coarse face dofs.

Parameters
[in]xThe dofs vector that needs coarse dofs to be express in term of the coarse basis, the result is stored in x_interp.

Definition at line 115 of file prestriction.cpp.

◆ NonconformingTransposeInterpolationInPlace()

void mfem::ParNCH1FaceRestriction::NonconformingTransposeInterpolationInPlace ( Vector & x) const

Apply a change of basis from fine element basis to coarse element basis for the coarse face dofs.

Parameters
[in]xThe dofs vector that needs coarse dofs to be express in term of the coarse basis, the result is stored in x_interp.

Definition at line 126 of file prestriction.cpp.

Member Data Documentation

◆ interpolations

InterpolationManager mfem::ParNCH1FaceRestriction::interpolations
protected

Definition at line 34 of file prestriction.hpp.

◆ type

const FaceType mfem::ParNCH1FaceRestriction::type
protected

Definition at line 33 of file prestriction.hpp.

◆ x_interp

Vector mfem::ParNCH1FaceRestriction::x_interp
mutableprotected

Definition at line 35 of file prestriction.hpp.


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