MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
mfem::BilinearFormExtension Class Referenceabstract

Class extending the BilinearForm class to support different AssemblyLevels. More...

#include <bilinearform_ext.hpp>

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

Public Member Functions

 BilinearFormExtension (BilinearForm *form)
 
virtual MemoryClass GetMemoryClass () const
 Return the MemoryClass preferred by the Operator.
 
virtual const OperatorGetProlongation () const
 Get the finite element space prolongation matrix.
 
virtual const OperatorGetRestriction () const
 Get the finite element space restriction matrix.
 
virtual void Assemble ()=0
 Assemble at the level given for the BilinearFormExtension subclass.
 
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 void FormSystemMatrix (const Array< int > &ess_tdof_list, OperatorHandle &A)=0
 
virtual void FormLinearSystem (const Array< int > &ess_tdof_list, Vector &x, Vector &b, OperatorHandle &A, Vector &X, Vector &B, int copy_interior=0)=0
 
virtual void Update ()=0
 
- 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 void Mult (const Vector &x, Vector &y) const =0
 Operator application: y=A(x).
 
virtual 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.
 
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 AddMultTranspose (const Vector &x, Vector &y, const real_t a=1.0) const
 Operator transpose application: y+=A^t(x) (default) or y+=a*A^t(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 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

BilinearForma
 Not owned.
 
- 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::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

Class extending the BilinearForm class to support different AssemblyLevels.

FA - Full Assembly PA - Partial Assembly EA - Element Assembly MF - Matrix Free

Definition at line 32 of file bilinearform_ext.hpp.

Constructor & Destructor Documentation

◆ BilinearFormExtension()

mfem::BilinearFormExtension::BilinearFormExtension ( BilinearForm * form)

Definition at line 24 of file bilinearform_ext.cpp.

Member Function Documentation

◆ Assemble()

virtual void mfem::BilinearFormExtension::Assemble ( )
pure virtual

◆ AssembleDiagonal()

virtual void mfem::BilinearFormExtension::AssembleDiagonal ( Vector & diag) const
inlinevirtual

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.

Reimplemented from mfem::Operator.

Reimplemented in mfem::MFBilinearFormExtension, and mfem::PABilinearFormExtension.

Definition at line 52 of file bilinearform_ext.hpp.

◆ FormLinearSystem()

virtual void mfem::BilinearFormExtension::FormLinearSystem ( const Array< int > & ess_tdof_list,
Vector & x,
Vector & b,
OperatorHandle & A,
Vector & X,
Vector & B,
int copy_interior = 0 )
pure virtual

◆ FormSystemMatrix()

virtual void mfem::BilinearFormExtension::FormSystemMatrix ( const Array< int > & ess_tdof_list,
OperatorHandle & A )
pure virtual

◆ GetMemoryClass()

virtual MemoryClass mfem::BilinearFormExtension::GetMemoryClass ( ) const
inlinevirtual

Return the MemoryClass preferred by the Operator.

This is the MemoryClass that will be used to access the input and output vectors in the Mult() and MultTranspose() methods.

For example, classes using the mfem::forall macro for implementation can return the value returned by Device::GetMemoryClass().

The default implementation of this method in class Operator returns MemoryClass::HOST.

Reimplemented from mfem::Operator.

Definition at line 40 of file bilinearform_ext.hpp.

◆ GetProlongation()

const Operator * mfem::BilinearFormExtension::GetProlongation ( ) const
virtual

Get the finite element space prolongation matrix.

Reimplemented from mfem::Operator.

Definition at line 30 of file bilinearform_ext.cpp.

◆ GetRestriction()

const Operator * mfem::BilinearFormExtension::GetRestriction ( ) const
virtual

Get the finite element space restriction matrix.

Reimplemented from mfem::Operator.

Definition at line 35 of file bilinearform_ext.cpp.

◆ Update()

virtual void mfem::BilinearFormExtension::Update ( )
pure virtual

Member Data Documentation

◆ a

BilinearForm* mfem::BilinearFormExtension::a
protected

Not owned.

Definition at line 35 of file bilinearform_ext.hpp.


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