MFEMScalarQuadratureFunctionCoefficient Class Reference

Scalar coefficient holding precomputed values of a source coefficient at the quadrature points of a QuadratureFunction. More...

#include <MFEMScalarQuadratureFunctionCoefficient.h>

Inheritance diagram for MFEMScalarQuadratureFunctionCoefficient:

Public Member Functions
	MFEMScalarQuadratureFunctionCoefficient (mfem::Coefficient &source, mfem::QuadratureFunction &qf, UpdatePolicy update_policy, const std::string &name)
void	SetTime (mfem::real_t t) override
	Set the time for the coefficient, invalidating the stored values unless the update policy is NONE. More...
mfem::real_t	Eval (mfem::ElementTransformation &T, const mfem::IntegrationPoint &ip) override
	Return the stored value at ip, re-projecting the source first if invalidated. More...
void	Project (mfem::QuadratureFunction &qf) override
	Copy the stored values into qf, re-projecting the source first if invalidated. More...
	CreateMooseEnumClass (UpdatePolicy, NONE, TIME, NONLINEAR)
	Policy controlling when the stored values are re-projected from the source coefficient. More...
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...

Private Member Functions
void	Refresh ()
	Project the source coefficient into the quadrature function if invalidated. More...

Private Attributes
mfem::Coefficient &	_source
	Source coefficient the stored values are projected from. More...
mfem::QuadratureFunction &	_qf
	Storage for the projected values, shared with the owning MOOSE object. More...

Detailed Description

Scalar coefficient holding precomputed values of a source coefficient at the quadrature points of a QuadratureFunction.

The stored values are (re)projected lazily: evaluation triggers a projection of the source coefficient only if the values have been invalidated since the last projection.

Definition at line 27 of file MFEMScalarQuadratureFunctionCoefficient.h.

Constructor & Destructor Documentation

MFEMScalarQuadratureFunctionCoefficient()

MFEMScalarQuadratureFunctionCoefficient::MFEMScalarQuadratureFunctionCoefficient	(	mfem::Coefficient &	source,
		mfem::QuadratureFunction &	qf,
		UpdatePolicy	update_policy,
		const std::string &	name
	)

Definition at line 15 of file MFEMScalarQuadratureFunctionCoefficient.C.

  : mfem::QuadratureFunctionCoefficient(qf),
    MFEMQuadratureFunctionCoefficientBase(update_policy, name),
    _source(source),
    _qf(qf)
{
}

Member Function Documentation

CheckIntegrationRule()

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

protectedinherited

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 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    )

inherited

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).

Eval()

mfem::real_t MFEMScalarQuadratureFunctionCoefficient::Eval ( mfem::ElementTransformation &  T, const mfem::IntegrationPoint &  ip  )

override

Return the stored value at ip, re-projecting the source first if invalidated.

Definition at line 35 of file MFEMScalarQuadratureFunctionCoefficient.C.

{
  if (_dirty)
    Refresh();
  CheckIntegrationRule(_qf, T, ip);
  return mfem::QuadratureFunctionCoefficient::Eval(T, ip);
}

MarkSolutionChanged()

void MFEMQuadratureFunctionCoefficientBase::MarkSolutionChanged ( )

inlineinherited

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 ( )

inlineprotectedinherited

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

Definition at line 59 of file MFEMQuadratureFunctionCoefficientBase.h.

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

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

Project()

void MFEMScalarQuadratureFunctionCoefficient::Project ( mfem::QuadratureFunction &  qf )

override

Copy the stored values into qf, re-projecting the source first if invalidated.

Definition at line 45 of file MFEMScalarQuadratureFunctionCoefficient.C.

{
  if (_dirty)
    Refresh();
  mfem::QuadratureFunctionCoefficient::Project(qf);
}

Refresh()

void MFEMScalarQuadratureFunctionCoefficient::Refresh ( )

private

Project the source coefficient into the quadrature function if invalidated.

Definition at line 53 of file MFEMScalarQuadratureFunctionCoefficient.C.

Referenced by Eval(), and Project().

{
  // Equivalent to _source.Project(_qf), except performed with a caller-owned element
  // transformation: the mesh-owned shared transformation used by mfem::Coefficient::Project
  // may belong to an in-flight assembly loop that is evaluating this coefficient, and
  // projecting through it would corrupt that loop's state.
  const mfem::QuadratureSpaceBase & qspace = *_qf.GetSpace();
  const mfem::Mesh & mesh = *qspace.GetMesh();
  mfem::IsoparametricTransformation T;
  mfem::Vector values;
  _qf.HostWrite();
  for (const auto iel : libMesh::make_range(qspace.GetNE()))
  {
    _qf.GetValues(iel, values);
    const mfem::IntegrationRule & ir = qspace.GetIntRule(iel);
    mesh.GetElementTransformation(iel, &T);
    for (const auto iq : libMesh::make_range(ir.Size()))
    {
      const mfem::IntegrationPoint & ip = ir[iq];
      T.SetIntPoint(&ip);
      values[iq] = _source.Eval(T, ip);
    }
  }
  _dirty = false;
}

SetTime()

void MFEMScalarQuadratureFunctionCoefficient::SetTime ( mfem::real_t  t )

override

Set the time for the coefficient, invalidating the stored values unless the update policy is NONE.

Definition at line 28 of file MFEMScalarQuadratureFunctionCoefficient.C.

{
  mfem::Coefficient::SetTime(t);
  MarkTimeChanged();
}

Member Data Documentation

_dirty

bool MFEMQuadratureFunctionCoefficientBase::_dirty

protectedinherited

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

Definition at line 78 of file MFEMQuadratureFunctionCoefficientBase.h.

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

_name

const std::string MFEMQuadratureFunctionCoefficientBase::_name

protectedinherited

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

Definition at line 76 of file MFEMQuadratureFunctionCoefficientBase.h.

Referenced by MFEMQuadratureFunctionCoefficientBase::CheckIntegrationRule().

_qf

mfem::QuadratureFunction& MFEMScalarQuadratureFunctionCoefficient::_qf

private

Storage for the projected values, shared with the owning MOOSE object.

Definition at line 53 of file MFEMScalarQuadratureFunctionCoefficient.h.

Referenced by Eval(), and Refresh().

_source

mfem::Coefficient& MFEMScalarQuadratureFunctionCoefficient::_source

private

Source coefficient the stored values are projected from.

Definition at line 51 of file MFEMScalarQuadratureFunctionCoefficient.h.

Referenced by Refresh().

_update_policy

const UpdatePolicy MFEMQuadratureFunctionCoefficientBase::_update_policy

protectedinherited

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

Definition at line 74 of file MFEMQuadratureFunctionCoefficientBase.h.

Referenced by MFEMQuadratureFunctionCoefficientBase::MarkSolutionChanged(), and MFEMQuadratureFunctionCoefficientBase::MarkTimeChanged().

---

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

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