A class representing a general block nonlinear operator defined on the Cartesian product of multiple FiniteElementSpaces. More...

#include <nonlinearform.hpp>

Inheritance diagram for mfem::BlockNonlinearForm:

[legend]

Collaboration diagram for mfem::BlockNonlinearForm:

[legend]

Public Member Functions
	BlockNonlinearForm ()
	Construct an empty BlockNonlinearForm. Initialize with SetSpaces().

	BlockNonlinearForm (Array< FiniteElementSpace * > &f)
	Construct a BlockNonlinearForm on the given set of FiniteElementSpaces.

FiniteElementSpace *	FESpace (int k)
	Return the k-th FE space of the BlockNonlinearForm.

const FiniteElementSpace *	FESpace (int k) const
	Return the k-th FE space of the BlockNonlinearForm (const version).

void	SetSpaces (Array< FiniteElementSpace * > &f)
	(Re)initialize the BlockNonlinearForm.

const Array< int > &	GetBlockOffsets () const
	Return the regular dof offsets.

const Array< int > &	GetBlockTrueOffsets () const
	Return the true-dof offsets.

void	AddDomainIntegrator (BlockNonlinearFormIntegrator *nlfi)
	Adds new Domain Integrator.

void	AddDomainIntegrator (BlockNonlinearFormIntegrator *nlfi, Array< int > &elem_marker)
	Adds new Domain Integrator, restricted to specific attributes.

void	AddBoundaryIntegrator (BlockNonlinearFormIntegrator *nlfi)
	Adds new Boundary Integrator.

void	AddBoundaryIntegrator (BlockNonlinearFormIntegrator *nlfi, Array< int > &elem_marker)
	Adds new Boundary Integrator, restricted to specific attributes.

void	AddInteriorFaceIntegrator (BlockNonlinearFormIntegrator *nlfi)
	Adds new Interior Face Integrator.

void	AddBdrFaceIntegrator (BlockNonlinearFormIntegrator *nlfi)
	Adds new Boundary Face Integrator.

void	AddBdrFaceIntegrator (BlockNonlinearFormIntegrator *nlfi, Array< int > &bdr_marker)
	Adds new Boundary Face Integrator, restricted to specific boundary attributes.

virtual void	SetEssentialBC (const Array< Array< int > * > &bdr_attr_is_ess, Array< Vector * > &rhs)
	Set essential boundary conditions to each finite element space using boundary attribute markers.

virtual void	SetEssentialTrueDofs (const Array< Array< int > * > &ess_tdof_list, Array< Vector * > &rhs)
	Set essential boundary conditions to each finite element space using essential true dof lists.

virtual real_t	GetEnergy (const Vector &x) const

void	Mult (const Vector &x, Vector &y) const override

Operator &	GetGradient (const Vector &x) const override

virtual	~BlockNonlinearForm ()
	Destructor.

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	AbsMult (const Vector &x, Vector &y) const
	Action of the absolute-value operator: `y=\|A\|(x)`. The default behavior in class Operator is to generate an error. If the Operator is a composition of several operators, the composition unfold into a product of absolute-value operators too.

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	AbsMultTranspose (const Vector &x, Vector &y) const
	Action of the transpose absolute-value 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 Member Functions
const BlockVector &	Prolongate (const BlockVector &bx) const

real_t	GetEnergyBlocked (const BlockVector &bx) const
	Specialized version of GetEnergy() for BlockVectors.

void	MultBlocked (const BlockVector &bx, BlockVector &by) const

void	ComputeGradientBlocked (const BlockVector &bx, bool finalize=true) const
	Specialized version of GetGradient() for BlockVector.

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".

Protected Attributes
Array< FiniteElementSpace * >	fes
	FE spaces on which the form lives.

Array< BlockNonlinearFormIntegrator * >	dnfi
	Set of Domain Integrators to be assembled (added).

Array< Array< int > * >	dnfi_marker

Array< BlockNonlinearFormIntegrator * >	bnfi
	Set of Boundary Integrators to be assembled (added).

Array< Array< int > * >	bnfi_marker

Array< BlockNonlinearFormIntegrator * >	fnfi
	Set of interior face Integrators to be assembled (added).

Array< BlockNonlinearFormIntegrator * >	bfnfi
	Set of Boundary Face Integrators to be assembled (added).

Array< Array< int > * >	bfnfi_marker

BlockVector	xs

BlockVector	ys

Array2D< SparseMatrix * >	Grads

Array2D< SparseMatrix * >	cGrads

BlockOperator *	BlockGrad

Array< int >	block_offsets

Array< int >	block_trueOffsets

Array< Array< int > * >	ess_tdofs

Array< const Operator * >	P
	Array of pointers to the prolongation matrix of fes, may be NULL.

Array< const SparseMatrix * >	cP
	Array of results of dynamic-casting P to SparseMatrix pointer.

bool	is_serial = true
	Indicator if the Operator is part of a parallel run.

bool	needs_prolongation = false
	Indicator if the Operator needs prolongation on assembly.

BlockVector	aux1

BlockVector	aux2

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 class representing a general block nonlinear operator defined on the Cartesian product of multiple FiniteElementSpaces.

Definition at line 257 of file nonlinearform.hpp.

Constructor & Destructor Documentation

◆ BlockNonlinearForm() [1/2]

mfem::BlockNonlinearForm::BlockNonlinearForm ( )

Construct an empty BlockNonlinearForm. Initialize with SetSpaces().

Definition at line 709 of file nonlinearform.cpp.

◆ BlockNonlinearForm() [2/2]

mfem::BlockNonlinearForm::BlockNonlinearForm ( Array< FiniteElementSpace * > & f )

Construct a BlockNonlinearForm on the given set of FiniteElementSpaces.

Definition at line 786 of file nonlinearform.cpp.

◆ ~BlockNonlinearForm()

mfem::BlockNonlinearForm::~BlockNonlinearForm ( )

virtual

Destructor.

Definition at line 1600 of file nonlinearform.cpp.

Member Function Documentation

◆ AddBdrFaceIntegrator() [1/2]

void mfem::BlockNonlinearForm::AddBdrFaceIntegrator ( BlockNonlinearFormIntegrator * nlfi )

inline

Adds new Boundary Face Integrator.

Definition at line 362 of file nonlinearform.hpp.

◆ AddBdrFaceIntegrator() [2/2]

void mfem::BlockNonlinearForm::AddBdrFaceIntegrator	(	BlockNonlinearFormIntegrator *	nlfi,
		Array< int > &	bdr_marker )

inline

Adds new Boundary Face Integrator, restricted to specific boundary attributes.

Definition at line 367 of file nonlinearform.hpp.

◆ AddBoundaryIntegrator() [1/2]

void mfem::BlockNonlinearForm::AddBoundaryIntegrator ( BlockNonlinearFormIntegrator * nlfi )

inline

Adds new Boundary Integrator.

Definition at line 349 of file nonlinearform.hpp.

◆ AddBoundaryIntegrator() [2/2]

void mfem::BlockNonlinearForm::AddBoundaryIntegrator	(	BlockNonlinearFormIntegrator *	nlfi,
		Array< int > &	elem_marker )

inline

Adds new Boundary Integrator, restricted to specific attributes.

Definition at line 353 of file nonlinearform.hpp.

◆ AddDomainIntegrator() [1/2]

void mfem::BlockNonlinearForm::AddDomainIntegrator ( BlockNonlinearFormIntegrator * nlfi )

inline

Adds new Domain Integrator.

Definition at line 340 of file nonlinearform.hpp.

◆ AddDomainIntegrator() [2/2]

void mfem::BlockNonlinearForm::AddDomainIntegrator	(	BlockNonlinearFormIntegrator *	nlfi,
		Array< int > &	elem_marker )

inline

Adds new Domain Integrator, restricted to specific attributes.

Definition at line 344 of file nonlinearform.hpp.

◆ AddInteriorFaceIntegrator()

void mfem::BlockNonlinearForm::AddInteriorFaceIntegrator ( BlockNonlinearFormIntegrator * nlfi )

inline

Adds new Interior Face Integrator.

Definition at line 358 of file nonlinearform.hpp.

◆ ComputeGradientBlocked()

void mfem::BlockNonlinearForm::ComputeGradientBlocked	(	const BlockVector &	bx,
		bool	finalize = true ) const

protected

Specialized version of GetGradient() for BlockVector.

Definition at line 1252 of file nonlinearform.cpp.

◆ FESpace() [1/2]

FiniteElementSpace * mfem::BlockNonlinearForm::FESpace ( int k )

inline

Return the k-th FE space of the BlockNonlinearForm.

Definition at line 326 of file nonlinearform.hpp.

◆ FESpace() [2/2]

const FiniteElementSpace * mfem::BlockNonlinearForm::FESpace ( int k ) const

inline

Return the k-th FE space of the BlockNonlinearForm (const version).

Definition at line 328 of file nonlinearform.hpp.

◆ GetBlockOffsets()

const Array< int > & mfem::BlockNonlinearForm::GetBlockOffsets ( ) const

inline

Return the regular dof offsets.

Definition at line 335 of file nonlinearform.hpp.

◆ GetBlockTrueOffsets()

const Array< int > & mfem::BlockNonlinearForm::GetBlockTrueOffsets ( ) const

inline

Return the true-dof offsets.

Definition at line 337 of file nonlinearform.hpp.

◆ GetEnergy()

real_t mfem::BlockNonlinearForm::GetEnergy ( const Vector & x ) const

virtual

Reimplemented in mfem::ParBlockNonlinearForm.

Definition at line 951 of file nonlinearform.cpp.

◆ GetEnergyBlocked()

real_t mfem::BlockNonlinearForm::GetEnergyBlocked ( const BlockVector & bx ) const

protected

Specialized version of GetEnergy() for BlockVectors.

Definition at line 819 of file nonlinearform.cpp.

◆ GetGradient()

Operator & mfem::BlockNonlinearForm::GetGradient ( const Vector & x ) const

overridevirtual

Method is only called in serial, the parallel version calls GetGradientBlocked directly.

Reimplemented from mfem::Operator.

Reimplemented in mfem::ParBlockNonlinearForm.

Definition at line 1530 of file nonlinearform.cpp.

◆ Mult()

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

overridevirtual

Method is only called in serial, the parallel version calls MultBlocked directly.

Implements mfem::Operator.

Reimplemented in mfem::ParBlockNonlinearForm.

Definition at line 1222 of file nonlinearform.cpp.

◆ MultBlocked()

void mfem::BlockNonlinearForm::MultBlocked	(	const BlockVector &	bx,
		BlockVector &	by ) const

protected

Specialized version of Mult() for BlockVectors Block L-Vector to Block L-Vector

Definition at line 957 of file nonlinearform.cpp.

◆ Prolongate()

const BlockVector & mfem::BlockNonlinearForm::Prolongate ( const BlockVector & bx ) const

protected

Definition at line 1199 of file nonlinearform.cpp.

◆ SetEssentialBC()

void mfem::BlockNonlinearForm::SetEssentialBC	(	const Array< Array< int > * > &	bdr_attr_is_ess,
		Array< Vector * > &	rhs )

virtual

Set essential boundary conditions to each finite element space using boundary attribute markers.

This method calls FiniteElementSpace::GetEssentialTrueDofs() for each space and stores ess_tdof_lists internally.

If rhs vectors are non-null, the entries corresponding to these essential DoFs are set to zero. This ensures compatibility with the output of the Mult() method, which also zeroes out these entries.

Parameters

[in]	bdr_attr_is_ess	A list of boundary attribute markers for each space.
[in,out]	rhs	An array of optional right-hand side vectors. If a vector at `rhs[i]` is non-null, its essential DoFs will be set to zero.

Reimplemented in mfem::ParBlockNonlinearForm.

Definition at line 792 of file nonlinearform.cpp.

◆ SetEssentialTrueDofs()

void mfem::BlockNonlinearForm::SetEssentialTrueDofs	(	const Array< Array< int > * > &	ess_tdof_list,
		Array< Vector * > &	rhs )

virtual

Set essential boundary conditions to each finite element space using essential true dof lists.

This method stores a copy of the provided essential true dof lists.

If rhs vectors are non-null, the entries corresponding to these essential DoFs are set to zero. This ensures compatibility with the output of the Mult() method, which also zeroes out these entries.

Parameters

[in]	ess_tdof_list	A list of essential true dofs for each space.
[in,out]	rhs	An array of optional right-hand side vectors. If a vector at `rhs[i]` is non-null, its essential DoFs will be set to zero.

Reimplemented in mfem::ParBlockNonlinearForm.

Definition at line 806 of file nonlinearform.cpp.

◆ SetSpaces()

void mfem::BlockNonlinearForm::SetSpaces ( Array< FiniteElementSpace * > & f )

(Re)initialize the BlockNonlinearForm.

After a call to SetSpaces(), the essential b.c. must be set again.

Definition at line 716 of file nonlinearform.cpp.

Member Data Documentation

◆ aux1

BlockVector mfem::BlockNonlinearForm::aux1

mutableprotected

Definition at line 304 of file nonlinearform.hpp.

◆ aux2

BlockVector mfem::BlockNonlinearForm::aux2

protected

Definition at line 304 of file nonlinearform.hpp.

◆ bfnfi

Array<BlockNonlinearFormIntegrator*> mfem::BlockNonlinearForm::bfnfi

protected

Set of Boundary Face Integrators to be assembled (added).

Definition at line 275 of file nonlinearform.hpp.

◆ bfnfi_marker

Array<Array<int>*> mfem::BlockNonlinearForm::bfnfi_marker

protected

Definition at line 276 of file nonlinearform.hpp.

◆ block_offsets

Array<int> mfem::BlockNonlinearForm::block_offsets

protected

Definition at line 286 of file nonlinearform.hpp.

◆ block_trueOffsets

Array<int> mfem::BlockNonlinearForm::block_trueOffsets

protected

Definition at line 287 of file nonlinearform.hpp.

◆ BlockGrad

BlockOperator* mfem::BlockNonlinearForm::BlockGrad

mutableprotected

Definition at line 283 of file nonlinearform.hpp.

◆ bnfi

Array<BlockNonlinearFormIntegrator*> mfem::BlockNonlinearForm::bnfi

protected

Set of Boundary Integrators to be assembled (added).

Definition at line 268 of file nonlinearform.hpp.

◆ bnfi_marker

Array<Array<int>*> mfem::BlockNonlinearForm::bnfi_marker

protected

Definition at line 269 of file nonlinearform.hpp.

◆ cGrads

Array2D<SparseMatrix*> mfem::BlockNonlinearForm::cGrads

protected

Definition at line 282 of file nonlinearform.hpp.

◆ cP

Array<const SparseMatrix *> mfem::BlockNonlinearForm::cP

protected

Array of results of dynamic-casting P to SparseMatrix pointer.

Definition at line 296 of file nonlinearform.hpp.

◆ dnfi

Array<BlockNonlinearFormIntegrator*> mfem::BlockNonlinearForm::dnfi

protected

Set of Domain Integrators to be assembled (added).

Definition at line 264 of file nonlinearform.hpp.

◆ dnfi_marker

Array<Array<int>*> mfem::BlockNonlinearForm::dnfi_marker

protected

Definition at line 265 of file nonlinearform.hpp.

◆ ess_tdofs

Array<Array<int> *> mfem::BlockNonlinearForm::ess_tdofs

protected

Definition at line 290 of file nonlinearform.hpp.

◆ fes

Array<FiniteElementSpace*> mfem::BlockNonlinearForm::fes

protected

FE spaces on which the form lives.

Definition at line 261 of file nonlinearform.hpp.

◆ fnfi

Array<BlockNonlinearFormIntegrator*> mfem::BlockNonlinearForm::fnfi

protected

Set of interior face Integrators to be assembled (added).

Definition at line 272 of file nonlinearform.hpp.

◆ Grads

Array2D<SparseMatrix*> mfem::BlockNonlinearForm::Grads

mutableprotected

Definition at line 282 of file nonlinearform.hpp.

◆ is_serial

bool mfem::BlockNonlinearForm::is_serial = true

protected

Indicator if the Operator is part of a parallel run.

Definition at line 299 of file nonlinearform.hpp.

◆ needs_prolongation

bool mfem::BlockNonlinearForm::needs_prolongation = false

protected

Indicator if the Operator needs prolongation on assembly.

Definition at line 302 of file nonlinearform.hpp.

◆ P

Array<const Operator *> mfem::BlockNonlinearForm::P

protected

Array of pointers to the prolongation matrix of fes, may be NULL.

Definition at line 293 of file nonlinearform.hpp.

◆ xs

BlockVector mfem::BlockNonlinearForm::xs

mutableprotected

Auxiliary block-vectors for wrapping input and output vectors or holding GridFunction-like block-vector data (e.g. in parallel).

Definition at line 280 of file nonlinearform.hpp.

◆ ys

BlockVector mfem::BlockNonlinearForm::ys

protected

Definition at line 280 of file nonlinearform.hpp.

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

fem/nonlinearform.hpp
fem/nonlinearform.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BlockNonlinearForm() [1/2]

◆ BlockNonlinearForm() [2/2]

◆ ~BlockNonlinearForm()

Member Function Documentation

◆ AddBdrFaceIntegrator() [1/2]

◆ AddBdrFaceIntegrator() [2/2]

◆ AddBoundaryIntegrator() [1/2]

◆ AddBoundaryIntegrator() [2/2]

◆ AddDomainIntegrator() [1/2]

◆ AddDomainIntegrator() [2/2]

◆ AddInteriorFaceIntegrator()

◆ ComputeGradientBlocked()

◆ FESpace() [1/2]

◆ FESpace() [2/2]

◆ GetBlockOffsets()

◆ GetBlockTrueOffsets()

◆ GetEnergy()

◆ GetEnergyBlocked()

◆ GetGradient()

◆ Mult()

◆ MultBlocked()

◆ Prolongate()

◆ SetEssentialBC()

◆ SetEssentialTrueDofs()

◆ SetSpaces()

Member Data Documentation

◆ aux1

◆ aux2

◆ bfnfi

◆ bfnfi_marker

◆ block_offsets

◆ block_trueOffsets

◆ BlockGrad

◆ bnfi

◆ bnfi_marker

◆ cGrads

◆ cP

◆ dnfi

◆ dnfi_marker

◆ ess_tdofs

◆ fes

◆ fnfi

◆ Grads

◆ is_serial

◆ needs_prolongation

◆ P

◆ xs

◆ ys