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

#include <nonlinearform_ext.hpp>

Inheritance diagram for mfem::NonlinearFormExtension:

Collaboration diagram for mfem::NonlinearFormExtension:

Public Member Functions
	NonlinearFormExtension (const NonlinearForm *)

virtual void	Assemble ()=0
	Assemble at the AssemblyLevel of the subclass.

virtual Operator &	GetGradient (const Vector &x) const =0
	Return the gradient as an L-to-L Operator. The input x must be an L-vector (i.e. GridFunction-size vector).

virtual real_t	GetGridFunctionEnergy (const Vector &x) const =0
	Compute the local (to the MPI rank) energy of the L-vector state x.

virtual void	Update ()=0
	Called by NonlinearForm::Update() to reflect changes in the FE space.

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	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 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 Operator *	GetProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. `NULL` means identity.

virtual const Operator *	GetRestriction () const
	Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. `NULL` means identity.

virtual const Operator *	GetOutputProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. `NULL` means identity.

virtual const Operator *	GetOutputRestrictionTranspose () const
	Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators.

virtual const Operator *	GetOutputRestriction () 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 NonlinearForm *	nlf
	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()

Operator *	SetupRAP (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 NonlinearForm class to support the different AssemblyLevels.

This class represents the action of the NonlinearForm as an L-to-L operator, i.e. both the input and output Vectors are L-vectors (GridFunction-size vectors). Essential boundary conditions are NOT applied to the action of the operator.

Definition at line 30 of file nonlinearform_ext.hpp.

Constructor & Destructor Documentation

◆ NonlinearFormExtension()

mfem::NonlinearFormExtension::NonlinearFormExtension ( const NonlinearForm * nlf )

Definition at line 21 of file nonlinearform_ext.cpp.

Member Function Documentation

◆ Assemble()

virtual void mfem::NonlinearFormExtension::Assemble ( )

pure virtual

Assemble at the AssemblyLevel of the subclass.

Implemented in mfem::MFNonlinearFormExtension, and mfem::PANonlinearFormExtension.

◆ GetGradient()

virtual Operator & mfem::NonlinearFormExtension::GetGradient ( const Vector & x ) const

pure virtual

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.

Reimplemented from mfem::Operator.

Implemented in mfem::MFNonlinearFormExtension, and mfem::PANonlinearFormExtension.

◆ GetGridFunctionEnergy()

virtual real_t mfem::NonlinearFormExtension::GetGridFunctionEnergy ( const Vector & x ) const

pure virtual

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

Implemented in mfem::MFNonlinearFormExtension, and mfem::PANonlinearFormExtension.

◆ Update()

virtual void mfem::NonlinearFormExtension::Update ( )

pure virtual

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

Implemented in mfem::MFNonlinearFormExtension, and mfem::PANonlinearFormExtension.

Member Data Documentation

◆ nlf

const NonlinearForm* mfem::NonlinearFormExtension::nlf

protected

Not owned.

Definition at line 33 of file nonlinearform_ext.hpp.

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

fem/nonlinearform_ext.hpp
fem/nonlinearform_ext.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NonlinearFormExtension()

Member Function Documentation

◆ Assemble()

◆ GetGradient()

◆ GetGridFunctionEnergy()

◆ Update()

Member Data Documentation

◆ nlf