MFEMIndicator.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#ifdef MOOSE_MFEM_ENABLED

#pragma once

#include "MFEMObject.h"
#include "MFEMContainers.h"
#include "MFEMVariable.h"

/*
 * Wrapper class for mfem::ErrorEstimator objects. To keep the
 * naming consistent with MOOSE, we refer to it as an Indicator.
 */
class MFEMIndicator : public MFEMObject
{
public:
  static InputParameters validParams();

  MFEMIndicator(const InputParameters & params);

  virtual ~MFEMIndicator() = default;

  virtual void createEstimator() = 0;

  mfem::ParFiniteElementSpace & getFESpace() const { return _fespace; }

  mfem::ParMesh & getParMesh() const { return *(_fespace.GetParMesh()); }

  std::shared_ptr<mfem::ErrorEstimator> getEstimator() const;

protected:
  const VariableName & _var_name;

  const std::string & _kernel_name;

  std::shared_ptr<mfem::ErrorEstimator> _error_estimator;

  // FE space that the variable lives in
  mfem::ParFiniteElementSpace & _fespace;
};

inline std::shared_ptr<mfem::ErrorEstimator>
MFEMIndicator::getEstimator() const
{
  mooseAssert(_error_estimator,
              "Attempting to retrieve error estimator before it's been constructed");
  return _error_estimator;
}

#endif