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

Data and methods for unassembled nonlinear forms. More...

#include <nonlinearform_ext.hpp>

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

Public Member Functions

 MFNonlinearFormExtension (const NonlinearForm *)
 
void Assemble () override
 Prepare the MFNonlinearFormExtension for evaluation with Mult().
 
void Mult (const Vector &x, Vector &y) const override
 Perform the action of the MFNonlinearFormExtension.
 
OperatorGetGradient (const Vector &x) const override
 Return the gradient as an L-to-L Operator. The input x must be an L-vector (i.e. GridFunction-size vector).
 
real_t GetGridFunctionEnergy (const Vector &x) const override
 Compute the local (to the MPI rank) energy of the L-vector state x.
 
void Update () override
 Called by NonlinearForm::Update() to reflect changes in the FE space.
 
- Public Member Functions inherited from mfem::NonlinearFormExtension
 NonlinearFormExtension (const NonlinearForm *)
 
- 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 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 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 FiniteElementSpacefes
 
Vector localX
 
Vector localY
 
const Operatorelem_restrict_lex
 
- Protected Attributes inherited from mfem::NonlinearFormExtension
const NonlinearFormnlf
 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

Data and methods for unassembled nonlinear forms.

Definition at line 129 of file nonlinearform_ext.hpp.

Constructor & Destructor Documentation

◆ MFNonlinearFormExtension()

mfem::MFNonlinearFormExtension::MFNonlinearFormExtension ( const NonlinearForm * form)

Definition at line 139 of file nonlinearform_ext.cpp.

Member Function Documentation

◆ Assemble()

void mfem::MFNonlinearFormExtension::Assemble ( )
overridevirtual

Prepare the MFNonlinearFormExtension for evaluation with Mult().

Implements mfem::NonlinearFormExtension.

Definition at line 155 of file nonlinearform_ext.cpp.

◆ GetGradient()

Operator & mfem::MFNonlinearFormExtension::GetGradient ( const Vector & x) const
inlineoverridevirtual

Return the gradient as an L-to-L Operator. The input x must be an L-vector (i.e. GridFunction-size vector).

Essential boundary conditions are NOT applied to the returned operator.

The returned gradient Operator defines the virtual method GetProlongation which enables support for the method FormSystemOperator to define the matrix-free global true-dof gradient with imposed boundary conditions.

Implements mfem::NonlinearFormExtension.

Definition at line 147 of file nonlinearform_ext.hpp.

◆ GetGridFunctionEnergy()

real_t mfem::MFNonlinearFormExtension::GetGridFunctionEnergy ( const Vector & x) const
inlineoverridevirtual

Compute the local (to the MPI rank) energy of the L-vector state x.

Implements mfem::NonlinearFormExtension.

Definition at line 153 of file nonlinearform_ext.hpp.

◆ Mult()

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

Perform the action of the MFNonlinearFormExtension.

Both the input, x, and output, y, vectors are L-vectors, i.e. GridFunction-size vectors.

Implements mfem::Operator.

Definition at line 165 of file nonlinearform_ext.cpp.

◆ Update()

void mfem::MFNonlinearFormExtension::Update ( )
overridevirtual

Called by NonlinearForm::Update() to reflect changes in the FE space.

Implements mfem::NonlinearFormExtension.

Definition at line 191 of file nonlinearform_ext.cpp.

Member Data Documentation

◆ elem_restrict_lex

const Operator* mfem::MFNonlinearFormExtension::elem_restrict_lex
protected

Definition at line 134 of file nonlinearform_ext.hpp.

◆ fes

const FiniteElementSpace& mfem::MFNonlinearFormExtension::fes
protected

Definition at line 132 of file nonlinearform_ext.hpp.

◆ localX

Vector mfem::MFNonlinearFormExtension::localX
mutableprotected

Definition at line 133 of file nonlinearform_ext.hpp.

◆ localY

Vector mfem::MFNonlinearFormExtension::localY
protected

Definition at line 133 of file nonlinearform_ext.hpp.


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