#include <tmop.hpp>

Inheritance diagram for mfem::TMOPComboIntegrator:

Collaboration diagram for mfem::TMOPComboIntegrator:

Public Member Functions
	TMOPComboIntegrator ()

	~TMOPComboIntegrator ()

void	AddTMOPIntegrator (TMOP_Integrator *ti)
	Adds a new TMOP_Integrator to the combination.

const Array< TMOP_Integrator * > &	GetTMOPIntegrators () const

void	EnableLimiting (const GridFunction &n0, const GridFunction &dist, Coefficient &w0, TMOP_LimiterFunction *lfunc=NULL)
	Adds the limiting term to the first integrator. Disables it for the rest.

void	EnableLimiting (const GridFunction &n0, Coefficient &w0, TMOP_LimiterFunction *lfunc=NULL)
	Adds the limiting term to the first integrator. Disables it for the rest (dist in the general version of the method) equal to 1.

void	EnableAdaptiveLimiting (const GridFunction &z0, Coefficient &coeff, AdaptivityEvaluator &ae, real_t delta_max=1.0)
	Adds the adaptive limiting term to the first integrator.

void	EnableAdaptiveLimiting (const Array< const GridFunction * > &z0, const Array< Coefficient * > &coeff, AdaptivityEvaluator &ae, const Array< real_t > &delta_max)
	Multi-field adaptive limiting with per-field delta_max values.

void	EnableAdaptiveLimiting (const ParGridFunction &z0, Coefficient &coeff, AdaptivityEvaluator &ae, real_t delta_max=1.0)
	Parallel support for adaptive limiting.

void	EnableAdaptiveLimiting (const Array< const ParGridFunction * > &z0, const Array< Coefficient * > &coeff, AdaptivityEvaluator &ae, const Array< real_t > &delta_max)
	Multi-field parallel adaptive limiting with per-field delta_max values.

void	SetLimitingNodes (const GridFunction &n0)
	Update the original/reference nodes used for limiting.

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

void	AssembleElementVector (const FiniteElement &el, ElementTransformation &T, const Vector &elfun, Vector &elvect) override
	Perform the local action of the NonlinearFormIntegrator.

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

virtual real_t	GetRefinementElementEnergy (const FiniteElement &el, ElementTransformation &T, const Vector &elfun, const IntegrationRule &irule)

virtual real_t	GetDerefinementElementEnergy (const FiniteElement &el, ElementTransformation &T, const Vector &elfun)

void	EnableNormalization (const GridFunction &x)
	Normalization factor that considers all integrators in the combination.

void	ParEnableNormalization (const ParGridFunction &x)

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

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

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

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

void	AddMultGradPA (const Vector &, Vector &) const override
	Method for partially assembled gradient action.

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

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

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

bool	Patchwise () const

void	SetPAMemoryType (MemoryType mt)

virtual void	AssembleFaceVector (const FiniteElement &el1, const FiniteElement &el2, FaceElementTransformations &Tr, const Vector &elfun, Vector &elvect)
	Perform the local action of the NonlinearFormIntegrator resulting from a face integral term.

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

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

virtual void	AssembleMF (const FiniteElementSpace &fes)
	Method defining fully unassembled operator.

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

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 Member Functions
void	SetInitialMeshPos (const GridFunction *x0)

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
Array< TMOP_Integrator * >	tmopi

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

Friends
class	TMOPNewtonSolver

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

Detailed Description

Definition at line 2609 of file tmop.hpp.

Constructor & Destructor Documentation

◆ TMOPComboIntegrator()

mfem::TMOPComboIntegrator::TMOPComboIntegrator ( )

inline

Definition at line 2624 of file tmop.hpp.

◆ ~TMOPComboIntegrator()

mfem::TMOPComboIntegrator::~TMOPComboIntegrator ( )

inline

Definition at line 2626 of file tmop.hpp.

Member Function Documentation

◆ AddMultGradPA()

void mfem::TMOPComboIntegrator::AddMultGradPA	(	const Vector &	x,
		Vector &	y ) const

overridevirtual

Method for partially assembled gradient action.

All arguments are E-vectors. This method can be called only after the method AssembleGradPA() has been called.

Parameters

[in]	x	The gradient Operator is applied to the Vector x.
[in,out]	y	The result Vector: \( y += G x \).

Reimplemented from mfem::NonlinearFormIntegrator.

Definition at line 6323 of file tmop.cpp.

◆ AddMultPA()

void mfem::TMOPComboIntegrator::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::NonlinearFormIntegrator.

Definition at line 6315 of file tmop.cpp.

◆ AddTMOPIntegrator()

void mfem::TMOPComboIntegrator::AddTMOPIntegrator ( TMOP_Integrator * ti )

inline

Adds a new TMOP_Integrator to the combination.

Definition at line 2632 of file tmop.hpp.

◆ AssembleElementGrad()

void mfem::TMOPComboIntegrator::AssembleElementGrad	(	const FiniteElement &	el,
		ElementTransformation &	Tr,
		const Vector &	elfun,
		DenseMatrix &	elmat )

overridevirtual

Assemble the local gradient matrix.

Reimplemented from mfem::NonlinearFormIntegrator.

Definition at line 6216 of file tmop.cpp.

◆ AssembleElementVector()

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

overridevirtual

Perform the local action of the NonlinearFormIntegrator.

Reimplemented from mfem::NonlinearFormIntegrator.

Definition at line 6200 of file tmop.cpp.

◆ AssembleGradDiagonalPA()

void mfem::TMOPComboIntegrator::AssembleGradDiagonalPA ( Vector & diag ) const

overridevirtual

Method for computing the diagonal of the gradient with partial assembly.

The result Vector diag is an E-Vector. This method can be called only after the method AssembleGradPA() has been called.

Parameters

[in,out] diag The result Vector: \( diag += diag(G) \).

Reimplemented from mfem::NonlinearFormIntegrator.

Definition at line 6307 of file tmop.cpp.

◆ AssembleGradPA()

void mfem::TMOPComboIntegrator::AssembleGradPA	(	const Vector &	x,
		const FiniteElementSpace &	fes )

overridevirtual

Prepare the integrator for partial assembly (PA) gradient evaluations on the given FE space fes at the state x.

The result of the partial assembly is stored internally so that it can be used later in the methods AddMultGradPA() and AssembleGradDiagonalPA(). The state Vector x is an E-vector.

Reimplemented from mfem::NonlinearFormIntegrator.

Definition at line 6298 of file tmop.cpp.

◆ AssemblePA() [1/2]

void mfem::TMOPComboIntegrator::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().

Reimplemented from mfem::NonlinearFormIntegrator.

Definition at line 6290 of file tmop.cpp.

◆ AssemblePA() [2/2]

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

virtual

The result of the partial assembly is stored internally so that it can be used later in the methods AddMultPA(). Used with BilinearFormIntegrators that have different spaces.

Reimplemented from mfem::NonlinearFormIntegrator.

Definition at line 100 of file nonlininteg.cpp.

◆ EnableAdaptiveLimiting() [1/4]

void mfem::TMOPComboIntegrator::EnableAdaptiveLimiting	(	const Array< const GridFunction * > &	z0,
		const Array< Coefficient * > &	coeff,
		AdaptivityEvaluator &	ae,
		const Array< real_t > &	delta_max )

Multi-field adaptive limiting with per-field delta_max values.

Definition at line 6148 of file tmop.cpp.

◆ EnableAdaptiveLimiting() [2/4]

void mfem::TMOPComboIntegrator::EnableAdaptiveLimiting	(	const Array< const ParGridFunction * > &	z0,
		const Array< Coefficient * > &	coeff,
		AdaptivityEvaluator &	ae,
		const Array< real_t > &	delta_max )

Multi-field parallel adaptive limiting with per-field delta_max values.

Definition at line 6169 of file tmop.cpp.

◆ EnableAdaptiveLimiting() [3/4]

void mfem::TMOPComboIntegrator::EnableAdaptiveLimiting	(	const GridFunction &	z0,
		Coefficient &	coeff,
		AdaptivityEvaluator &	ae,
		real_t	delta_max = 1.0 )

Adds the adaptive limiting term to the first integrator.

Definition at line 6138 of file tmop.cpp.

◆ EnableAdaptiveLimiting() [4/4]

void mfem::TMOPComboIntegrator::EnableAdaptiveLimiting	(	const ParGridFunction &	z0,
		Coefficient &	coeff,
		AdaptivityEvaluator &	ae,
		real_t	delta_max = 1.0 )

Parallel support for adaptive limiting.

Definition at line 6159 of file tmop.cpp.

◆ EnableLimiting() [1/2]

void mfem::TMOPComboIntegrator::EnableLimiting	(	const GridFunction &	n0,
		Coefficient &	w0,
		TMOP_LimiterFunction *	lfunc = NULL )

Adds the limiting term to the first integrator. Disables it for the rest (dist in the general version of the method) equal to 1.

Definition at line 6128 of file tmop.cpp.

◆ EnableLimiting() [2/2]

void mfem::TMOPComboIntegrator::EnableLimiting	(	const GridFunction &	n0,
		const GridFunction &	dist,
		Coefficient &	w0,
		TMOP_LimiterFunction *	lfunc = NULL )

Adds the limiting term to the first integrator. Disables it for the rest.

Definition at line 6117 of file tmop.cpp.

◆ EnableNormalization()

void mfem::TMOPComboIntegrator::EnableNormalization ( const GridFunction & x )

Normalization factor that considers all integrators in the combination.

Definition at line 6258 of file tmop.cpp.

◆ GetDerefinementElementEnergy()

real_t mfem::TMOPComboIntegrator::GetDerefinementElementEnergy	(	const FiniteElement &	el,
		ElementTransformation &	T,
		const Vector &	elfun )

virtual

Definition at line 6245 of file tmop.cpp.

◆ GetElementEnergy()

real_t mfem::TMOPComboIntegrator::GetElementEnergy	(	const FiniteElement &	el,
		ElementTransformation &	Tr,
		const Vector &	elfun )

overridevirtual

Compute the local energy.

Reimplemented from mfem::NonlinearFormIntegrator.

Definition at line 6188 of file tmop.cpp.

◆ GetLocalStateEnergyPA()

real_t mfem::TMOPComboIntegrator::GetLocalStateEnergyPA ( const Vector & x ) const

overridevirtual

Compute the local (to the MPI rank) energy with partial assembly.

Here the state x is an E-vector. This method can be called only after the method AssemblePA() has been called.

Reimplemented from mfem::NonlinearFormIntegrator.

Definition at line 6331 of file tmop.cpp.

◆ GetRefinementElementEnergy()

real_t mfem::TMOPComboIntegrator::GetRefinementElementEnergy	(	const FiniteElement &	el,
		ElementTransformation &	T,
		const Vector &	elfun,
		const IntegrationRule &	irule )

virtual

Definition at line 6232 of file tmop.cpp.

◆ GetTMOPIntegrators()

const Array< TMOP_Integrator * > & mfem::TMOPComboIntegrator::GetTMOPIntegrators ( ) const

inline

Definition at line 2634 of file tmop.hpp.

◆ ParEnableNormalization()

void mfem::TMOPComboIntegrator::ParEnableNormalization ( const ParGridFunction & x )

Definition at line 6274 of file tmop.cpp.

◆ SetInitialMeshPos()

void mfem::TMOPComboIntegrator::SetInitialMeshPos ( const GridFunction * x0 )

inlineprotected

Definition at line 2617 of file tmop.hpp.

◆ SetLimitingNodes()

void mfem::TMOPComboIntegrator::SetLimitingNodes ( const GridFunction & n0 )

Update the original/reference nodes used for limiting.

Definition at line 6180 of file tmop.cpp.

Friends And Related Symbol Documentation

◆ TMOPNewtonSolver

friend class TMOPNewtonSolver

friend

Definition at line 2612 of file tmop.hpp.

Member Data Documentation

◆ tmopi

Array<TMOP_Integrator *> mfem::TMOPComboIntegrator::tmopi

protected

Definition at line 2615 of file tmop.hpp.

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

fem/tmop.hpp
fem/tmop.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TMOPComboIntegrator()

◆ ~TMOPComboIntegrator()

Member Function Documentation

◆ AddMultGradPA()

◆ AddMultPA()

◆ AddTMOPIntegrator()

◆ AssembleElementGrad()

◆ AssembleElementVector()

◆ AssembleGradDiagonalPA()

◆ AssembleGradPA()

◆ AssemblePA() [1/2]

◆ AssemblePA() [2/2]

◆ EnableAdaptiveLimiting() [1/4]

◆ EnableAdaptiveLimiting() [2/4]

◆ EnableAdaptiveLimiting() [3/4]

◆ EnableAdaptiveLimiting() [4/4]

◆ EnableLimiting() [1/2]

◆ EnableLimiting() [2/2]

◆ EnableNormalization()

◆ GetDerefinementElementEnergy()

◆ GetElementEnergy()

◆ GetLocalStateEnergyPA()

◆ GetRefinementElementEnergy()

◆ GetTMOPIntegrators()

◆ ParEnableNormalization()

◆ SetInitialMeshPos()

◆ SetLimitingNodes()

Friends And Related Symbol Documentation

◆ TMOPNewtonSolver

Member Data Documentation

◆ tmopi