Integrator defining a sum of multiple Integrators. More...

#include <bilininteg.hpp>

Inheritance diagram for mfem::SumIntegrator:

Collaboration diagram for mfem::SumIntegrator:

Public Member Functions
	SumIntegrator (int own_integs=1)

void	SetIntRule (const IntegrationRule *ir) override
	Prescribe a fixed IntegrationRule to use, or set to null to let the integrator choose an appropriate rule.

void	AddIntegrator (BilinearFormIntegrator *integ)

void	AssembleElementMatrix (const FiniteElement &el, ElementTransformation &Trans, DenseMatrix &elmat) override
	Given a particular Finite Element computes the element matrix elmat.

void	AssembleElementMatrix2 (const FiniteElement &trial_fe, const FiniteElement &test_fe, ElementTransformation &Trans, DenseMatrix &elmat) override

void	AssembleFaceMatrix (const FiniteElement &el1, const FiniteElement &el2, FaceElementTransformations &Trans, DenseMatrix &elmat) override

void	AssembleFaceMatrix (const FiniteElement &trial_face_fe, const FiniteElement &test_fe1, const FiniteElement &test_fe2, FaceElementTransformations &Trans, DenseMatrix &elmat) override

void	AssemblePA (const FiniteElementSpace &fes) override
	Method defining partial assembly.

void	AssembleDiagonalPA (Vector &diag) override
	Assemble diagonal and add it to Vector diag.

void	AssemblePAInteriorFaces (const FiniteElementSpace &fes) override

void	AssemblePABoundaryFaces (const FiniteElementSpace &fes) override

void	AddMultTransposePA (const Vector &x, Vector &y) const override
	Method for partially assembled transposed action.

void	AddMultPA (const Vector &x, Vector &y) const override
	Method for partially assembled action.

void	AssembleMF (const FiniteElementSpace &fes) override
	Method defining matrix-free assembly.

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

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

void	AssembleDiagonalMF (Vector &diag) override
	Assemble diagonal and add it to Vector diag.

void	AssembleEA (const FiniteElementSpace &fes, Vector &emat, const bool add) override
	Method defining element assembly.

void	AssembleEAInteriorFaces (const FiniteElementSpace &fes, Vector &ea_data_int, Vector &ea_data_ext, const bool add) override

void	AssembleEABoundaryFaces (const FiniteElementSpace &fes, Vector &ea_data_bdr, const bool add) override

virtual	~SumIntegrator ()

virtual void	AssembleFaceMatrix (const FiniteElement &trial_fe1, const FiniteElement &test_fe1, const FiniteElement &trial_fe2, const FiniteElement &test_fe2, FaceElementTransformations &Trans, DenseMatrix &elmat)

void	AssemblePA (const FiniteElementSpace &trial_fes, const FiniteElementSpace &test_fes) override

virtual void	AssembleEAInteriorFaces (const FiniteElementSpace &trial_fes, const FiniteElementSpace &test_fes, Vector &emat, const bool add=true)
	Method defining element assembly for mixed trace integrators.

Public Member Functions inherited from mfem::BilinearFormIntegrator
virtual void	AssembleNURBSPA (const FiniteElementSpace &fes)
	Method defining partial assembly on NURBS patches.

virtual void	AssemblePABoundary (const FiniteElementSpace &fes)

virtual void	AssembleDiagonalPA_ADAt (const Vector &D, Vector &diag)
	Assemble diagonal of \(A D A^T\) ( \(A\) is this integrator) and add it to diag.

virtual void	AddMultNURBSPA (const Vector &x, Vector &y) const
	Method for partially assembled action on NURBS patches.

virtual void	AssembleEABoundary (const FiniteElementSpace &fes, Vector &ea_data_bdr, const bool add=true)

virtual void	AssemblePatchMatrix (const int patch, const FiniteElementSpace &fes, SparseMatrix *&smat)

virtual void	AssembleTraceFaceMatrix (int elem, const FiniteElement &trial_face_fe, const FiniteElement &test_fe, FaceElementTransformations &Trans, DenseMatrix &elmat)

void	AssembleElementVector (const FiniteElement &el, ElementTransformation &Tr, const Vector &elfun, Vector &elvect) override
	Perform the local action of the BilinearFormIntegrator. Note that the default implementation in the base class is general but not efficient.

void	AssembleFaceVector (const FiniteElement &el1, const FiniteElement &el2, FaceElementTransformations &Tr, const Vector &elfun, Vector &elvect) override
	Perform the local action of the BilinearFormIntegrator resulting from a face integral term. Note that the default implementation in the base class is general but not efficient.

void	AssembleElementGrad (const FiniteElement &el, ElementTransformation &Tr, const Vector &elfun, DenseMatrix &elmat) override
	Assemble the local gradient matrix.

void	AssembleFaceGrad (const FiniteElement &el1, const FiniteElement &el2, FaceElementTransformations &Tr, const Vector &elfun, DenseMatrix &elmat) override
	Assemble the local action of the gradient of the NonlinearFormIntegrator resulting from a face integral term.

virtual void	ComputeElementFlux (const FiniteElement &el, ElementTransformation &Trans, Vector &u, const FiniteElement &fluxelem, Vector &flux, bool with_coef=true, const IntegrationRule *ir=NULL)
	Virtual method required for Zienkiewicz-Zhu type error estimators.

virtual real_t	ComputeFluxEnergy (const FiniteElement &fluxelem, ElementTransformation &Trans, Vector &flux, Vector *d_energy=NULL)
	Virtual method required for Zienkiewicz-Zhu type error estimators.

virtual bool	RequiresFaceNormalDerivatives () const
	For bilinear forms on element faces, specifies if the normal derivatives are needed on the faces or just the face restriction.

virtual void	AddMultPAFaceNormalDerivatives (const Vector &x, const Vector &dxdn, Vector &y, Vector &dydn) const
	Method for partially assembled action.

virtual	~BilinearFormIntegrator ()

Public Member Functions inherited from mfem::NonlinearFormIntegrator
void	SetIntegrationMode (Mode m)

bool	Patchwise () const

void	SetPAMemoryType (MemoryType mt)

virtual real_t	GetElementEnergy (const FiniteElement &el, ElementTransformation &Tr, const Vector &elfun)
	Compute the local energy.

virtual void	AssembleGradPA (const Vector &x, const FiniteElementSpace &fes)
	Prepare the integrator for partial assembly (PA) gradient evaluations on the given FE space fes at the state x.

virtual real_t	GetLocalStateEnergyPA (const Vector &x) const
	Compute the local (to the MPI rank) energy with partial assembly.

virtual void	AddMultGradPA (const Vector &x, Vector &y) const
	Method for partially assembled gradient action.

virtual void	AssembleGradDiagonalPA (Vector &diag) const
	Method for computing the diagonal of the gradient with partial assembly.

virtual bool	SupportsCeed () const
	Indicates whether this integrator can use a Ceed backend.

ceed::Operator &	GetCeedOp ()

virtual	~NonlinearFormIntegrator ()

Public Member Functions inherited from mfem::Integrator
	Integrator (const IntegrationRule *ir=NULL)
	Create a new Integrator, optionally providing a prescribed quadrature rule to use in assembly.

void	SetIntegrationRule (const IntegrationRule &ir)
	Prescribe a fixed IntegrationRule to use. Sets the NURBS patch integration rule to null.

void	SetNURBSPatchIntRule (NURBSMeshRules *pr)
	Sets an integration rule for use on NURBS patches.

bool	HasNURBSPatchIntRule () const
	Check if a NURBS patch integration rule has been set.

const IntegrationRule *	GetIntRule () const
	Directly return the IntRule pointer (possibly null) without checking for NURBS patch rules or falling back on a default.

const IntegrationRule *	GetIntegrationRule () const
	Equivalent to GetIntRule, but retained for backward compatibility with applications.

Additional Inherited Members
Public Types inherited from mfem::NonlinearFormIntegrator
enum	Mode { ELEMENTWISE = 0 , PATCHWISE = 1 , PATCHWISE_REDUCED = 2 }

Protected Member Functions inherited from mfem::BilinearFormIntegrator
	BilinearFormIntegrator (const IntegrationRule *ir=NULL)

Protected Member Functions inherited from mfem::NonlinearFormIntegrator
	NonlinearFormIntegrator (const IntegrationRule *ir=NULL)

Protected Member Functions inherited from mfem::Integrator
const IntegrationRule *	GetIntegrationRule (const FiniteElement &trial_fe, const FiniteElement &test_fe, const ElementTransformation &trans) const
	Returns an integration rule based on the arguments and internal state of the Integrator object.

const IntegrationRule *	GetIntegrationRule (const FiniteElement &el, const ElementTransformation &trans) const
	Returns an integration rule based on the arguments and internal state. (Version for identical trial_fe and test_fe)

virtual const IntegrationRule *	GetDefaultIntegrationRule (const FiniteElement &trial_fe, const FiniteElement &test_fe, const ElementTransformation &trans) const
	Subclasses should override to choose a default integration rule.

Protected Attributes inherited from mfem::NonlinearFormIntegrator
Mode	integrationMode = Mode::ELEMENTWISE

ceed::Operator *	ceedOp

MemoryType	pa_mt = MemoryType::DEFAULT

Protected Attributes inherited from mfem::Integrator
const IntegrationRule *	IntRule

NURBSMeshRules *	patchRules = nullptr

Detailed Description

Integrator defining a sum of multiple Integrators.

Definition at line 453 of file bilininteg.hpp.

Constructor & Destructor Documentation

◆ SumIntegrator()

mfem::SumIntegrator::SumIntegrator ( int own_integs = 1 )

inline

Definition at line 461 of file bilininteg.hpp.

◆ ~SumIntegrator()

mfem::SumIntegrator::~SumIntegrator ( )

virtual

Definition at line 491 of file bilininteg.cpp.

Member Function Documentation

◆ AddIntegrator()

void mfem::SumIntegrator::AddIntegrator ( BilinearFormIntegrator * integ )

inline

Definition at line 465 of file bilininteg.hpp.

◆ AddMultMF()

void mfem::SumIntegrator::AddMultMF	(	const Vector &	x,
		Vector &	y ) const

overridevirtual

Perform the action of integrator on the input x and add the result to the output y. Both x and y are E-vectors, i.e. they represent the element-wise discontinuous version of the FE space.

This method can be called only after the method AssembleMF() has been called.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 437 of file bilininteg.cpp.

◆ AddMultPA()

void mfem::SumIntegrator::AddMultPA	(	const Vector &	x,
		Vector &	y ) const

overridevirtual

Method for partially assembled action.

Perform the action of integrator on the input x and add the result to the output y. Both x and y are E-vectors, i.e. they represent the element-wise discontinuous version of the FE space.

This method can be called only after the method AssemblePA() has been called.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 413 of file bilininteg.cpp.

◆ AddMultTransposeMF()

void mfem::SumIntegrator::AddMultTransposeMF	(	const Vector &	x,
		Vector &	y ) const

overridevirtual

Perform the transpose action of integrator on the input x and add the result to the output y. Both x and y are E-vectors, i.e. they represent the element-wise discontinuous version of the FE space.

This method can be called only after the method AssemblePA() has been called.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 445 of file bilininteg.cpp.

◆ AddMultTransposePA()

void mfem::SumIntegrator::AddMultTransposePA	(	const Vector &	x,
		Vector &	y ) const

overridevirtual

Method for partially assembled transposed action.

Perform the transpose action of integrator on the input x and add the result to the output y. Both x and y are E-vectors, i.e. they represent the element-wise discontinuous version of the FE space.

This method can be called only after the method AssemblePA() has been called.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 421 of file bilininteg.cpp.

◆ AssembleDiagonalMF()

void mfem::SumIntegrator::AssembleDiagonalMF ( Vector & diag )

overridevirtual

Assemble diagonal and add it to Vector diag.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 453 of file bilininteg.cpp.

◆ AssembleDiagonalPA()

void mfem::SumIntegrator::AssembleDiagonalPA ( Vector & diag )

overridevirtual

Assemble diagonal and add it to Vector diag.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 389 of file bilininteg.cpp.

◆ AssembleEA()

void mfem::SumIntegrator::AssembleEA	(	const FiniteElementSpace &	fes,
		Vector &	emat,
		const bool	add )

overridevirtual

Method defining element assembly.

The result of the element assembly is added to the emat Vector if add is true. Otherwise, if add is false, we set emat.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 461 of file bilininteg.cpp.

◆ AssembleEABoundaryFaces()

void mfem::SumIntegrator::AssembleEABoundaryFaces	(	const FiniteElementSpace &	fes,
		Vector &	ea_data_bdr,
		const bool	add )

overridevirtual

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 481 of file bilininteg.cpp.

◆ AssembleEAInteriorFaces() [1/2]

void mfem::SumIntegrator::AssembleEAInteriorFaces	(	const FiniteElementSpace &	fes,
		Vector &	ea_data_int,
		Vector &	ea_data_ext,
		const bool	add )

overridevirtual

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 470 of file bilininteg.cpp.

◆ AssembleEAInteriorFaces() [2/2]

void mfem::BilinearFormIntegrator::AssembleEAInteriorFaces	(	const FiniteElementSpace &	trial_fes,
		const FiniteElementSpace &	test_fes,
		Vector &	emat,
		const bool	add = true )

virtual

Method defining element assembly for mixed trace integrators.

This is the element assembly analogue of AssembleFaceMatrix(const FiniteElement&, const FiniteElement&, const FiniteElement&, FaceElementTransformations&, DenseMatrix&).

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 141 of file bilininteg.cpp.

◆ AssembleElementMatrix()

void mfem::SumIntegrator::AssembleElementMatrix	(	const FiniteElement &	el,
		ElementTransformation &	Trans,
		DenseMatrix &	elmat )

overridevirtual

Given a particular Finite Element computes the element matrix elmat.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 325 of file bilininteg.cpp.

◆ AssembleElementMatrix2()

void mfem::SumIntegrator::AssembleElementMatrix2	(	const FiniteElement &	trial_fe,
		const FiniteElement &	test_fe,
		ElementTransformation &	Trans,
		DenseMatrix &	elmat )

overridevirtual

Compute the local matrix representation of a bilinear form \(a(u,v)\) defined on different trial (given by \(u\)) and test (given by \(v\)) spaces. The rows in the local matrix correspond to the test dofs and the columns – to the trial dofs.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 338 of file bilininteg.cpp.

◆ AssembleFaceMatrix() [1/3]

void mfem::SumIntegrator::AssembleFaceMatrix	(	const FiniteElement &	el1,
		const FiniteElement &	el2,
		FaceElementTransformations &	Trans,
		DenseMatrix &	elmat )

overridevirtual

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 352 of file bilininteg.cpp.

◆ AssembleFaceMatrix() [2/3]

void mfem::SumIntegrator::AssembleFaceMatrix	(	const FiniteElement &	trial_face_fe,
		const FiniteElement &	test_fe1,
		const FiniteElement &	test_fe2,
		FaceElementTransformations &	Trans,
		DenseMatrix &	elmat )

overridevirtual

Abstract method used for assembling TraceFaceIntegrators in a MixedBilinearForm.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 366 of file bilininteg.cpp.

◆ AssembleFaceMatrix() [3/3]

void mfem::BilinearFormIntegrator::AssembleFaceMatrix	(	const FiniteElement &	trial_fe1,
		const FiniteElement &	test_fe1,
		const FiniteElement &	trial_fe2,
		const FiniteElement &	test_fe2,
		FaceElementTransformations &	Trans,
		DenseMatrix &	elmat )

virtual

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 176 of file bilininteg.cpp.

◆ AssembleMF()

void mfem::SumIntegrator::AssembleMF ( const FiniteElementSpace & fes )

overridevirtual

Method defining matrix-free assembly.

Used with BilinearFormIntegrators that have different spaces. The result of fully matrix-free assembly is stored internally so that it can be used later in the methods AddMultMF() and AddMultTransposeMF().

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 429 of file bilininteg.cpp.

◆ AssemblePA() [1/2]

void mfem::SumIntegrator::AssemblePA ( const FiniteElementSpace & fes )

overridevirtual

Method defining partial assembly.

The result of the partial assembly is stored internally so that it can be used later in the methods AddMultPA() and AddMultTransposePA().

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 381 of file bilininteg.cpp.

◆ AssemblePA() [2/2]

void mfem::BilinearFormIntegrator::AssemblePA	(	const FiniteElementSpace &	trial_fes,
		const FiniteElementSpace &	test_fes )

overridevirtual

Used with BilinearFormIntegrators that have different spaces.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 52 of file bilininteg.cpp.

◆ AssemblePABoundaryFaces()

void mfem::SumIntegrator::AssemblePABoundaryFaces ( const FiniteElementSpace & fes )

overridevirtual

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 405 of file bilininteg.cpp.

◆ AssemblePAInteriorFaces()

void mfem::SumIntegrator::AssemblePAInteriorFaces ( const FiniteElementSpace & fes )

overridevirtual

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 397 of file bilininteg.cpp.

◆ SetIntRule()

void mfem::SumIntegrator::SetIntRule ( const IntegrationRule * ir )

overridevirtual

Prescribe a fixed IntegrationRule to use, or set to null to let the integrator choose an appropriate rule.

This method allows setting a custom integration rule to use on each element during assembly, overriding the default choice if it is non-null. Passing a non-null value will set the Integrator's NURBS patch integration rule to null to avoid ambiguity in GetIntegrationRule.

Reimplemented from mfem::Integrator.

Definition at line 316 of file bilininteg.cpp.

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

fem/bilininteg.hpp
fem/bilininteg.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SumIntegrator()

◆ ~SumIntegrator()

Member Function Documentation

◆ AddIntegrator()

◆ AddMultMF()

◆ AddMultPA()

◆ AddMultTransposeMF()

◆ AddMultTransposePA()

◆ AssembleDiagonalMF()

◆ AssembleDiagonalPA()

◆ AssembleEA()

◆ AssembleEABoundaryFaces()

◆ AssembleEAInteriorFaces() [1/2]

◆ AssembleEAInteriorFaces() [2/2]

◆ AssembleElementMatrix()

◆ AssembleElementMatrix2()

◆ AssembleFaceMatrix() [1/3]

◆ AssembleFaceMatrix() [2/3]

◆ AssembleFaceMatrix() [3/3]

◆ AssembleMF()

◆ AssemblePA() [1/2]

◆ AssemblePA() [2/2]

◆ AssemblePABoundaryFaces()

◆ AssemblePAInteriorFaces()

◆ SetIntRule()