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

#include <operator.hpp>

Inheritance diagram for mfem::ceed::Operator:
[legend]
Collaboration diagram for mfem::ceed::Operator:
[legend]

Public Member Functions

 Operator (CeedOperator op)
 This class takes ownership of op and will delete it.
 
void Mult (const mfem::Vector &x, mfem::Vector &y) const override
 Operator application: y=A(x).
 
void AddMult (const mfem::Vector &x, mfem::Vector &y, const real_t a=1.0) const override
 Operator application: y+=A(x) (default) or y+=a*A(x).
 
void GetDiagonal (mfem::Vector &diag) const
 
virtual ~Operator ()
 Virtual destructor.
 
CeedOperator & GetCeedOperator ()
 
- 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 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 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 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.
 
Type GetType () const
 Return the type ID of the Operator class.
 

Protected Member Functions

 Operator ()
 
- 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".
 

Protected Attributes

CeedOperator oper
 
CeedVector u
 
CeedVector v
 
- 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...
 

Detailed Description

A base class to represent a CeedOperator as an MFEM Operator.

Definition at line 25 of file operator.hpp.

Constructor & Destructor Documentation

◆ Operator() [1/2]

mfem::ceed::Operator::Operator ( )
inlineprotected

Definition at line 32 of file operator.hpp.

◆ Operator() [2/2]

mfem::ceed::Operator::Operator ( CeedOperator op)

This class takes ownership of op and will delete it.

Definition at line 27 of file operator.cpp.

◆ ~Operator()

virtual mfem::ceed::Operator::~Operator ( )
inlinevirtual

Virtual destructor.

Reimplemented from mfem::Operator.

Definition at line 45 of file operator.hpp.

Member Function Documentation

◆ AddMult()

void mfem::ceed::Operator::AddMult ( const mfem::Vector & x,
mfem::Vector & y,
const real_t a = 1.0 ) const
overridevirtual

Operator application: y+=A(x) (default) or y+=a*A(x).

Reimplemented from mfem::Operator.

Definition at line 72 of file operator.cpp.

◆ GetCeedOperator()

CeedOperator & mfem::ceed::Operator::GetCeedOperator ( )
inline

Definition at line 55 of file operator.hpp.

◆ GetDiagonal()

void mfem::ceed::Operator::GetDiagonal ( mfem::Vector & diag) const

Definition at line 104 of file operator.cpp.

◆ Mult()

void mfem::ceed::Operator::Mult ( const mfem::Vector & x,
mfem::Vector & y ) const
overridevirtual

Operator application: y=A(x).

Implements mfem::Operator.

Definition at line 42 of file operator.cpp.

Member Data Documentation

◆ oper

CeedOperator mfem::ceed::Operator::oper
protected

Definition at line 29 of file operator.hpp.

◆ u

CeedVector mfem::ceed::Operator::u
protected

Definition at line 30 of file operator.hpp.

◆ v

CeedVector mfem::ceed::Operator::v
protected

Definition at line 30 of file operator.hpp.


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