#include <integrator.hpp>

Inheritance diagram for mfem::ceed::MFIntegrator:

Collaboration diagram for mfem::ceed::MFIntegrator:

Public Member Functions
	MFIntegrator ()

template<typename CeedOperatorInfo , typename CoeffType >
void	Assemble (CeedOperatorInfo &info, const mfem::FiniteElementSpace &fes, const mfem::IntegrationRule &ir, CoeffType *Q)
	This method assembles the `MFIntegrator` with the given `CeedOperatorInfo` info, an `mfem::FiniteElementSpace` fes, an `mfem::IntegrationRule` ir, and `mfem::Coefficient` or `mfem::VectorCoefficient` Q. The `CeedOperatorInfo` type is expected to inherit from `OperatorInfo`, and contain a `Context` type relevant to the qFunctions.

template<typename CeedOperatorInfo , typename CoeffType >
void	Assemble (CeedOperatorInfo &info, const mfem::FiniteElementSpace &fes, const mfem::IntegrationRule &ir, int nelem, const int indices, CoeffType Q)
	This method assembles the `MFIntegrator` with the given `CeedOperatorInfo` info, an `mfem::FiniteElementSpace` fes, an `mfem::IntegrationRule` ir, and `mfem::Coefficient` or `mfem::VectorCoefficient` Q for the elements given by the indices indices. The `CeedOperatorInfo` type is expected to inherit from `OperatorInfo`, and contain a `Context` type relevant to the qFunctions.

template<typename CeedOperatorInfo , typename CoeffType >
void	Assemble (CeedOperatorInfo &info, const mfem::FiniteElementSpace &trial_fes, const mfem::FiniteElementSpace &test_fes, const mfem::IntegrationRule &ir, CoeffType *Q)

template<typename CeedOperatorInfo , typename CoeffType >
void	Assemble (CeedOperatorInfo &info, const mfem::FiniteElementSpace &trial_fes, const mfem::FiniteElementSpace &test_fes, const mfem::IntegrationRule &ir, int nelem, const int indices, CoeffType Q)

virtual	~MFIntegrator ()

Public Member Functions inherited from mfem::ceed::Operator
	Operator (CeedOperator op)
	This class takes ownership of op and will delete it.

void	Mult (const mfem::Vector &x, mfem::Vector &y) const override
	Operator application: `y=A(x)`.

void	AddMult (const mfem::Vector &x, mfem::Vector &y, const real_t a=1.0) const override
	Operator application: `y+=A(x)` (default) or `y+=a*A(x)`.

void	GetDiagonal (mfem::Vector &diag) const

virtual	~Operator ()
	Virtual destructor.

CeedOperator &	GetCeedOperator ()

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	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 Operator &	GetGradient (const Vector &x) const
	Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error.

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.

Type	GetType () const
	Return the type ID of the Operator class.

Protected Attributes
CeedBasis	trial_basis

CeedBasis	test_basis

CeedBasis	mesh_basis

CeedElemRestriction	trial_restr

CeedElemRestriction	test_restr

CeedElemRestriction	mesh_restr

CeedElemRestriction	restr_i

CeedQFunction	apply_qfunc

CeedVector	node_coords

CeedVector	qdata

Coefficient *	coeff

CeedQFunctionContext	build_ctx

Protected Attributes inherited from mfem::ceed::Operator
CeedOperator	oper

CeedVector	u

CeedVector	v

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::ceed::Operator
	Operator ()

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

This class represent a matrix-free operator using libCEED.

Definition at line 436 of file integrator.hpp.

Constructor & Destructor Documentation

◆ MFIntegrator()

mfem::ceed::MFIntegrator::MFIntegrator ( )

inline

Definition at line 448 of file integrator.hpp.

◆ ~MFIntegrator()

virtual mfem::ceed::MFIntegrator::~MFIntegrator ( )

inlinevirtual

Definition at line 743 of file integrator.hpp.

Member Function Documentation

◆ Assemble() [1/4]

template<typename CeedOperatorInfo , typename CoeffType >

void mfem::ceed::MFIntegrator::Assemble	(	CeedOperatorInfo &	info,
		const mfem::FiniteElementSpace &	fes,
		const mfem::IntegrationRule &	ir,
		CoeffType *	Q )

inline

This method assembles the MFIntegrator with the given CeedOperatorInfo info, an mfem::FiniteElementSpace fes, an mfem::IntegrationRule ir, and mfem::Coefficient or mfem::VectorCoefficient Q. The CeedOperatorInfo type is expected to inherit from OperatorInfo, and contain a Context type relevant to the qFunctions.

Parameters

[in]	info	is the structure describing the CeedOperator to assemble.
[in]	fes	is the finite element space.
[in]	ir	is the integration rule for the operator.
[in]	Q	is the coefficient from the `Integrator`.

Definition at line 468 of file integrator.hpp.

◆ Assemble() [2/4]

template<typename CeedOperatorInfo , typename CoeffType >

void mfem::ceed::MFIntegrator::Assemble	(	CeedOperatorInfo &	info,
		const mfem::FiniteElementSpace &	fes,
		const mfem::IntegrationRule &	ir,
		int	nelem,
		const int *	indices,
		CoeffType *	Q )

inline

This method assembles the MFIntegrator with the given CeedOperatorInfo info, an mfem::FiniteElementSpace fes, an mfem::IntegrationRule ir, and mfem::Coefficient or mfem::VectorCoefficient Q for the elements given by the indices indices. The CeedOperatorInfo type is expected to inherit from OperatorInfo, and contain a Context type relevant to the qFunctions.

Parameters

[in]	info	is the structure describing the CeedOperator to assemble.
[in]	fes	is the finite element space.
[in]	ir	is the integration rule for the operator.
[in]	nelem	The number of elements.
[in]	indices	The indices of the elements of same type in the `FiniteElementSpace`. If `indices == nullptr`, assumes that the `FiniteElementSpace` is not mixed.
[in]	Q	is the coefficient from the `Integrator`.

Definition at line 493 of file integrator.hpp.

◆ Assemble() [3/4]

template<typename CeedOperatorInfo , typename CoeffType >

void mfem::ceed::MFIntegrator::Assemble	(	CeedOperatorInfo &	info,
		const mfem::FiniteElementSpace &	trial_fes,
		const mfem::FiniteElementSpace &	test_fes,
		const mfem::IntegrationRule &	ir,
		CoeffType *	Q )

inline

This method assembles the MFIntegrator for mixed forms.

Parameters

[in]	info	the `CeedOperatorInfo` describing the `CeedOperator`, the `CeedOperatorInfo` type is expected to inherit from `OperatorInfo` and contain a `Context` type relevant to the qFunctions.
[in]	trial_fes	the trial `FiniteElementSpace` for the form,
[in]	test_fes	the test `FiniteElementSpace` for the form,
[in]	ir	the `IntegrationRule` for the numerical integration,
[in]	Q	`Coefficient` or `VectorCoefficient`.

Definition at line 514 of file integrator.hpp.

◆ Assemble() [4/4]

template<typename CeedOperatorInfo , typename CoeffType >

void mfem::ceed::MFIntegrator::Assemble	(	CeedOperatorInfo &	info,
		const mfem::FiniteElementSpace &	trial_fes,
		const mfem::FiniteElementSpace &	test_fes,
		const mfem::IntegrationRule &	ir,
		int	nelem,
		const int *	indices,
		CoeffType *	Q )

inline

This method assembles the MFIntegrator for mixed forms.

Parameters

[in]	info	the `CeedOperatorInfo` describing the `CeedOperator`, the `CeedOperatorInfo` type is expected to inherit from `OperatorInfo` and contain a `Context` type relevant to the qFunctions.
[in]	trial_fes	the trial `FiniteElementSpace` for the form,
[in]	test_fes	the test `FiniteElementSpace` for the form,
[in]	ir	the `IntegrationRule` for the numerical integration,
[in]	nelem	The number of elements,
[in]	indices	The indices of the elements of same type in the `FiniteElementSpace`. If `indices == nullptr`, assumes that the `FiniteElementSpace` is not mixed,
[in]	Q	`Coefficient` or `VectorCoefficient`.

Definition at line 538 of file integrator.hpp.

Member Data Documentation

◆ apply_qfunc

CeedQFunction mfem::ceed::MFIntegrator::apply_qfunc

protected

Definition at line 442 of file integrator.hpp.

◆ build_ctx

CeedQFunctionContext mfem::ceed::MFIntegrator::build_ctx

protected

Definition at line 445 of file integrator.hpp.

◆ coeff

Coefficient* mfem::ceed::MFIntegrator::coeff

protected

Definition at line 444 of file integrator.hpp.

◆ mesh_basis

CeedBasis mfem::ceed::MFIntegrator::mesh_basis

protected

Definition at line 440 of file integrator.hpp.

◆ mesh_restr

CeedElemRestriction mfem::ceed::MFIntegrator::mesh_restr

protected

Definition at line 441 of file integrator.hpp.

◆ node_coords

CeedVector mfem::ceed::MFIntegrator::node_coords

protected

Definition at line 443 of file integrator.hpp.

◆ qdata

CeedVector mfem::ceed::MFIntegrator::qdata

protected

Definition at line 443 of file integrator.hpp.

◆ restr_i

CeedElemRestriction mfem::ceed::MFIntegrator::restr_i

protected

Definition at line 441 of file integrator.hpp.

◆ test_basis

CeedBasis mfem::ceed::MFIntegrator::test_basis

protected

Definition at line 440 of file integrator.hpp.

◆ test_restr

CeedElemRestriction mfem::ceed::MFIntegrator::test_restr

protected

Definition at line 441 of file integrator.hpp.

◆ trial_basis

CeedBasis mfem::ceed::MFIntegrator::trial_basis

protected

Definition at line 440 of file integrator.hpp.

◆ trial_restr

CeedElemRestriction mfem::ceed::MFIntegrator::trial_restr

protected

Definition at line 441 of file integrator.hpp.

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

fem/ceed/interface/integrator.hpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MFIntegrator()

◆ ~MFIntegrator()

Member Function Documentation

◆ Assemble() [1/4]

◆ Assemble() [2/4]

◆ Assemble() [3/4]

◆ Assemble() [4/4]

Member Data Documentation

◆ apply_qfunc

◆ build_ctx

◆ coeff

◆ mesh_basis

◆ mesh_restr

◆ node_coords

◆ qdata

◆ restr_i

◆ test_basis

◆ test_restr

◆ trial_basis

◆ trial_restr