MFEMQuadratureFunctionCoefficientBase Class Reference

Shared lazy-update state for quadrature function coefficients. More...

#include <MFEMQuadratureFunctionCoefficientBase.h>

Inheritance diagram for MFEMQuadratureFunctionCoefficientBase:

Public Member Functions
	CreateMooseEnumClass (UpdatePolicy, NONE, TIME, NONLINEAR)
	Policy controlling when the stored values are re-projected from the source coefficient. More...
	MFEMQuadratureFunctionCoefficientBase (UpdatePolicy update_policy, const std::string &name)
virtual	~MFEMQuadratureFunctionCoefficientBase ()=default
void	MarkSolutionChanged ()
	Mark the stored values as stale following a change of solution variables, forcing the source to be re-projected on next use. More...

Protected Member Functions
void	MarkTimeChanged ()
	Mark the stored values as stale following a change of time. More...
void	CheckIntegrationRule (const mfem::QuadratureFunction &qf, mfem::ElementTransformation &T, const mfem::IntegrationPoint &ip) const
	Verify that the integration point ip supplied by a consuming integrator belongs to the same quadrature rule the values in qf are stored on. More...

Protected Attributes
const UpdatePolicy	_update_policy
	When the stored values are re-projected from the source coefficient. More...
const std::string	_name
	Name of the owning MOOSE object, used in error messages. More...
bool	_dirty
	Whether the stored values are stale and must be re-projected before use. More...

Detailed Description

Shared lazy-update state for quadrature function coefficients.

Holds the update policy and a dirty flag marking whether the stored quadrature point values are stale and must be re-projected from the source coefficient before use. Provides a common polymorphic type so that scalar and vector quadrature function coefficients can be invalidated uniformly.

Definition at line 30 of file MFEMQuadratureFunctionCoefficientBase.h.

Constructor & Destructor Documentation

MFEMQuadratureFunctionCoefficientBase()

MFEMQuadratureFunctionCoefficientBase::MFEMQuadratureFunctionCoefficientBase ( UpdatePolicy  update_policy, const std::string &  name  )

inline

Definition at line 42 of file MFEMQuadratureFunctionCoefficientBase.h.

    : _update_policy(update_policy), _name(name), _dirty(true)
  {
  }

~MFEMQuadratureFunctionCoefficientBase()

virtual MFEMQuadratureFunctionCoefficientBase::~MFEMQuadratureFunctionCoefficientBase ( )

virtualdefault

Member Function Documentation

CheckIntegrationRule()

void MFEMQuadratureFunctionCoefficientBase::CheckIntegrationRule ( const mfem::QuadratureFunction &  qf, mfem::ElementTransformation &  T, const mfem::IntegrationPoint &  ip  ) const

protected

Verify that the integration point ip supplied by a consuming integrator belongs to the same quadrature rule the values in qf are stored on.

Errors, naming the quadrature order the coefficient should use, if the rules do not match. The stored values are indexed by quadrature point, so a mismatched rule would silently read values from the wrong points.

Definition at line 37 of file MFEMQuadratureFunctionCoefficientBase.C.

Referenced by MFEMScalarQuadratureFunctionCoefficient::Eval(), and MFEMVectorQuadratureFunctionCoefficient::Eval().

{
  const mfem::QuadratureSpaceBase & qspace = *qf.GetSpace();
  const int el_idx = qspace.GetEntityIndex(T);
  // Entity not in this space (e.g. a boundary evaluation)
  if (el_idx < 0)
    return;

  const mfem::Geometry::Type geom = qspace.GetGeometry(el_idx);
  const int dim = mfem::Geometry::Dimension[geom];
  const mfem::IntegrationRule & stored_rule = qspace.GetIntRule(el_idx);
  // Fast path: the consuming integrator's point at this index coincides with the stored rule's,
  // so the rules match.
  if (ip.index < stored_rule.Size() && SamePoint(stored_rule.IntPoint(ip.index), ip, dim))
    return;

  // Rules differ. Recover the quadrature order the coefficient should have used by finding the
  // lowest order whose rule for this geometry reproduces the consuming integrator's point at
  // ip.index. This runs only on the error path.
  const int stored_order = qspace.GetOrder();
  int suggested_order = -1;
  // The consuming integrator's order is not known here, but is realistically bounded. The upper
  // limit is just a generous finite cap so this error-path search always terminates: a multiple
  // of the stored order, plus a constant so low-order stored rules still search far enough. If the
  // true order somehow exceeds the cap, suggested_order stays -1 and a generic message is emitted.
  for (int order = 0; order <= 2 * stored_order + 64; ++order)
  {
    const mfem::IntegrationRule & candidate = mfem::IntRules.Get(geom, order);
    if (ip.index < candidate.Size() && SamePoint(candidate.IntPoint(ip.index), ip, dim))
    {
      suggested_order = order;
      break;
    }
  }

  if (suggested_order >= 0)
    mooseError("MFEM quadrature function '",
               _name,
               "' stores values on the order-",
               stored_order,
               " quadrature rule (",
               stored_rule.Size(),
               " points on this element), but it is being evaluated by an integrator using a "
               "different quadrature rule (",
               mfem::IntRules.Get(geom, suggested_order).Size(),
               " points). The stored values are indexed by quadrature point, so the orders must "
               "match. Set 'order = ",
               suggested_order,
               "' on '",
               _name,
               "'.");
  else
    mooseError("MFEM quadrature function '",
               _name,
               "' stores values on the order-",
               stored_order,
               " quadrature rule, but it is being evaluated by an integrator using a different "
               "quadrature rule. The stored values are indexed by quadrature point, so the orders "
               "must match; adjust 'order' on '",
               _name,
               "' to match the consuming integrator.");
}

CreateMooseEnumClass()

MFEMQuadratureFunctionCoefficientBase::CreateMooseEnumClass	(	UpdatePolicy	,
		NONE	,
		TIME	,
		NONLINEAR
	)

Policy controlling when the stored values are re-projected from the source coefficient.

NONE - the source never changes after initialization; project exactly once. TIME - the source changes with time only; re-project when the time is set. NONLINEAR - the source may additionally depend on solution variables; also re-project whenever trial variables are updated (i.e. on each nonlinear iteration).

MarkSolutionChanged()

void MFEMQuadratureFunctionCoefficientBase::MarkSolutionChanged ( )

inline

Mark the stored values as stale following a change of solution variables, forcing the source to be re-projected on next use.

Definition at line 51 of file MFEMQuadratureFunctionCoefficientBase.h.

  {
    if (_update_policy == UpdatePolicy::NONLINEAR)
      _dirty = true;
  }

MarkTimeChanged()

void MFEMQuadratureFunctionCoefficientBase::MarkTimeChanged ( )

inlineprotected

Mark the stored values as stale following a change of time.

Definition at line 59 of file MFEMQuadratureFunctionCoefficientBase.h.

Referenced by MFEMScalarQuadratureFunctionCoefficient::SetTime(), and MFEMVectorQuadratureFunctionCoefficient::SetTime().

  {
    if (_update_policy != UpdatePolicy::NONE)
      _dirty = true;
  }

Member Data Documentation

_dirty

bool MFEMQuadratureFunctionCoefficientBase::_dirty

protected

Whether the stored values are stale and must be re-projected before use.

Definition at line 78 of file MFEMQuadratureFunctionCoefficientBase.h.

Referenced by MFEMScalarQuadratureFunctionCoefficient::Eval(), MFEMVectorQuadratureFunctionCoefficient::Eval(), MarkSolutionChanged(), MarkTimeChanged(), MFEMScalarQuadratureFunctionCoefficient::Project(), MFEMVectorQuadratureFunctionCoefficient::Project(), MFEMScalarQuadratureFunctionCoefficient::Refresh(), and MFEMVectorQuadratureFunctionCoefficient::Refresh().

_name

const std::string MFEMQuadratureFunctionCoefficientBase::_name

protected

Name of the owning MOOSE object, used in error messages.

Definition at line 76 of file MFEMQuadratureFunctionCoefficientBase.h.

Referenced by CheckIntegrationRule().

_update_policy

const UpdatePolicy MFEMQuadratureFunctionCoefficientBase::_update_policy

protected

When the stored values are re-projected from the source coefficient.

Definition at line 74 of file MFEMQuadratureFunctionCoefficientBase.h.

Referenced by MarkSolutionChanged(), and MarkTimeChanged().

---

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

• include/mfem/functions/MFEMQuadratureFunctionCoefficientBase.h
• src/mfem/functions/MFEMQuadratureFunctionCoefficientBase.C