#include <bilininteg.hpp>

Inheritance diagram for mfem::VectorDiffusionIntegrator:

Collaboration diagram for mfem::VectorDiffusionIntegrator:

Public Member Functions
	VectorDiffusionIntegrator ()

	VectorDiffusionIntegrator (int vector_dimension)
	Integrator with unit coefficient for caller-specified vector dimension.

	VectorDiffusionIntegrator (Coefficient &q)

	VectorDiffusionIntegrator (Coefficient &q, const IntegrationRule *ir)

	VectorDiffusionIntegrator (Coefficient &q, int vector_dimension)
	Integrator with scalar coefficient for caller-specified vector dimension.

	VectorDiffusionIntegrator (VectorCoefficient &vq)
	Integrator with `VectorCoefficient`. The vector dimension of the `FiniteElementSpace` is assumed to be the same as the dimension of the `Vector`.

	VectorDiffusionIntegrator (MatrixCoefficient &mq)
	Integrator with `MatrixCoefficient`. The vector dimension of the `FiniteElementSpace` is assumed to be the same as the dimension of the `Matrix`.

void	AssembleElementMatrix (const FiniteElement &el, ElementTransformation &Trans, DenseMatrix &elmat) override
	Given a particular Finite Element computes the element matrix 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	AssemblePA (const FiniteElementSpace &fes) override
	Method defining partial assembly.

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

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

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

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

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

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

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

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	AssemblePAInteriorFaces (const FiniteElementSpace &fes)

virtual void	AssemblePABoundaryFaces (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	AddMultTransposePA (const Vector &x, Vector &y) const
	Method for partially assembled transposed action.

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

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

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

virtual void	AssembleEAInteriorFaces (const FiniteElementSpace &fes, Vector &ea_data_int, Vector &ea_data_ext, const bool add=true)

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.

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

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

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

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

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

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

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

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.

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.

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

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.

Protected Attributes
Coefficient *	Q = NULL

VectorCoefficient *	VQ = NULL

MatrixCoefficient *	MQ = NULL

const DofToQuad *	maps
	Not owned.

const GeometricFactors *	geom
	Not owned.

int	dim

int	sdim

int	ne

int	dofs1D

int	quad1D

Vector	pa_data

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

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.

Detailed Description

Class for integrating the bilinear form \(a(u,v) := (Q \nabla u, \nabla v)\), where \(u=(u_1,\dots,u_n)\) and \(v=(v_1,\dots,v_n)\), \(u_i\) and \(v_i\) are defined by scalar FE through standard transformation. See the constructors' documentation for all Coefficient options. The computed local element matrix is square, of size vdim*dof , where vdim is the vector dimension space and dof is the local degrees of freedom. The integrator is not aware of the true vector dimension and must use VectorCoefficient, MatrixCoefficient, or a caller-specified value to determine the vector space. For a scalar coefficient, the caller may manually specify the vector dimension or the vector dimension is assumed to be the spatial dimension (i.e. 2-dimension or 3-dimension).

Definition at line 3054 of file bilininteg.hpp.

Constructor & Destructor Documentation

◆ VectorDiffusionIntegrator() [1/7]

mfem::VectorDiffusionIntegrator::VectorDiffusionIntegrator ( )

inline

Definition at line 3074 of file bilininteg.hpp.

◆ VectorDiffusionIntegrator() [2/7]

mfem::VectorDiffusionIntegrator::VectorDiffusionIntegrator ( int vector_dimension )

inline

Integrator with unit coefficient for caller-specified vector dimension.

If the vector dimension does not match the true dimension of the space, the resulting element matrix will be mathematically invalid.

Definition at line 3081 of file bilininteg.hpp.

◆ VectorDiffusionIntegrator() [3/7]

mfem::VectorDiffusionIntegrator::VectorDiffusionIntegrator ( Coefficient & q )

inline

Definition at line 3084 of file bilininteg.hpp.

◆ VectorDiffusionIntegrator() [4/7]

mfem::VectorDiffusionIntegrator::VectorDiffusionIntegrator	(	Coefficient &	q,
		const IntegrationRule *	ir )

inline

Definition at line 3087 of file bilininteg.hpp.

◆ VectorDiffusionIntegrator() [5/7]

mfem::VectorDiffusionIntegrator::VectorDiffusionIntegrator	(	Coefficient &	q,
		int	vector_dimension )

inline

Integrator with scalar coefficient for caller-specified vector dimension.

The element matrix is block-diagonal with vdim copies of the element matrix integrated with the Coefficient.

If the vector dimension does not match the true dimension of the space, the resulting element matrix will be mathematically invalid.

Definition at line 3098 of file bilininteg.hpp.

◆ VectorDiffusionIntegrator() [6/7]

mfem::VectorDiffusionIntegrator::VectorDiffusionIntegrator ( VectorCoefficient & vq )

inline

Integrator with VectorCoefficient. The vector dimension of the FiniteElementSpace is assumed to be the same as the dimension of the Vector.

The element matrix is block-diagonal and each block is integrated with coefficient \(q_{i}\).

If the vector dimension does not match the true dimension of the space, the resulting element matrix will be mathematically invalid.

Definition at line 3110 of file bilininteg.hpp.

◆ VectorDiffusionIntegrator() [7/7]

mfem::VectorDiffusionIntegrator::VectorDiffusionIntegrator ( MatrixCoefficient & mq )

inline

Integrator with MatrixCoefficient. The vector dimension of the FiniteElementSpace is assumed to be the same as the dimension of the Matrix.

The element matrix is populated in each block. Each block is integrated with coefficient \(q_{ij}\).

If the vector dimension does not match the true dimension of the space, the resulting element matrix will be mathematically invalid.

Definition at line 3122 of file bilininteg.hpp.

Member Function Documentation

◆ AddMultMF()

void mfem::VectorDiffusionIntegrator::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 48 of file bilininteg_vecdiffusion_mf.cpp.

◆ AddMultPA()

void mfem::VectorDiffusionIntegrator::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 745 of file bilininteg_vecdiffusion_pa.cpp.

◆ AssembleDiagonalMF()

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

overridevirtual

Assemble diagonal and add it to Vector diag.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 61 of file bilininteg_vecdiffusion_mf.cpp.

◆ AssembleDiagonalPA()

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

overridevirtual

Assemble diagonal and add it to Vector diag.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 414 of file bilininteg_vecdiffusion_pa.cpp.

◆ AssembleElementMatrix()

void mfem::VectorDiffusionIntegrator::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 3002 of file bilininteg.cpp.

◆ AssembleElementVector()

void mfem::VectorDiffusionIntegrator::AssembleElementVector	(	const FiniteElement &	el,
		ElementTransformation &	Tr,
		const Vector &	elfun,
		Vector &	elvect )

overridevirtual

Perform the local action of the BilinearFormIntegrator. Note that the default implementation in the base class is general but not efficient.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 3084 of file bilininteg.cpp.

◆ AssembleMF()

void mfem::VectorDiffusionIntegrator::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 19 of file bilininteg_vecdiffusion_mf.cpp.

◆ AssemblePA() [1/2]

void mfem::VectorDiffusionIntegrator::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 139 of file bilininteg_vecdiffusion_pa.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.

◆ SupportsCeed()

bool mfem::VectorDiffusionIntegrator::SupportsCeed ( ) const

inlineoverridevirtual

Indicates whether this integrator can use a Ceed backend.

Reimplemented from mfem::NonlinearFormIntegrator.

Definition at line 3138 of file bilininteg.hpp.

Member Data Documentation

◆ dim

int mfem::VectorDiffusionIntegrator::dim

protected

Definition at line 3064 of file bilininteg.hpp.

◆ dofs1D

int mfem::VectorDiffusionIntegrator::dofs1D

protected

Definition at line 3064 of file bilininteg.hpp.

◆ geom

const GeometricFactors* mfem::VectorDiffusionIntegrator::geom

protected

Not owned.

Definition at line 3063 of file bilininteg.hpp.

◆ maps

const DofToQuad* mfem::VectorDiffusionIntegrator::maps

protected

Not owned.

Definition at line 3062 of file bilininteg.hpp.

◆ MQ

MatrixCoefficient* mfem::VectorDiffusionIntegrator::MQ = NULL

protected

Definition at line 3059 of file bilininteg.hpp.

◆ ne

int mfem::VectorDiffusionIntegrator::ne

protected

Definition at line 3064 of file bilininteg.hpp.

◆ pa_data

Vector mfem::VectorDiffusionIntegrator::pa_data

protected

Definition at line 3065 of file bilininteg.hpp.

◆ Q

Coefficient* mfem::VectorDiffusionIntegrator::Q = NULL

protected

Definition at line 3057 of file bilininteg.hpp.

◆ quad1D

int mfem::VectorDiffusionIntegrator::quad1D

protected

Definition at line 3064 of file bilininteg.hpp.

◆ sdim

int mfem::VectorDiffusionIntegrator::sdim

protected

Definition at line 3064 of file bilininteg.hpp.

◆ VQ

VectorCoefficient* mfem::VectorDiffusionIntegrator::VQ = NULL

protected

Definition at line 3058 of file bilininteg.hpp.

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

fem/bilininteg.hpp
fem/bilininteg.cpp
fem/integ/bilininteg_vecdiffusion_mf.cpp
fem/integ/bilininteg_vecdiffusion_pa.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VectorDiffusionIntegrator() [1/7]

◆ VectorDiffusionIntegrator() [2/7]

◆ VectorDiffusionIntegrator() [3/7]

◆ VectorDiffusionIntegrator() [4/7]

◆ VectorDiffusionIntegrator() [5/7]

◆ VectorDiffusionIntegrator() [6/7]

◆ VectorDiffusionIntegrator() [7/7]

Member Function Documentation

◆ AddMultMF()

◆ AddMultPA()

◆ AssembleDiagonalMF()

◆ AssembleDiagonalPA()

◆ AssembleElementMatrix()

◆ AssembleElementVector()

◆ AssembleMF()

◆ AssemblePA() [1/2]

◆ AssemblePA() [2/2]

◆ SupportsCeed()

Member Data Documentation

◆ dim

◆ dofs1D

◆ geom

◆ maps

◆ MQ

◆ ne

◆ pa_data

◆ Q

◆ quad1D

◆ sdim

◆ VQ