MFEMFESpace.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 "libmesh/ignore_warnings.h"
#include "mfem.hpp"
#include "libmesh/restore_warnings.h"
#include "MFEMGeneralUserObject.h"

class MFEMFESpace : public MFEMGeneralUserObject
{
public:
  static InputParameters validParams();

  MFEMFESpace(const InputParameters & parameters);

  // Note: The simplest way to handle the boilerplate of constructing
  // FiniteElementCollection and FiniteElementSpace objects in the
  // base class while deferring their arguments to the subclasses was
  // to build them after construction was finished. Rather than
  // requiring the user to call an additional Init() function (which
  // could easily be forgotten) instead they get built lazily, when
  // required.

  inline std::shared_ptr<mfem::ParFiniteElementSpace> getFESpace() const
  {
    if (!_fespace)
      buildFESpace(getVDim());
    return _fespace;
  }

  inline std::shared_ptr<mfem::FiniteElementCollection> getFEC() const
  {
    if (!_fec)
      buildFEC(getFECName());
    return _fec;
  }

  virtual bool isScalar() const = 0;

  virtual bool isVector() const = 0;

protected:
  const int _ordering;

  virtual std::string getFECName() const = 0;

  virtual int getVDim() const = 0;

private:
  void buildFEC(const std::string & fec_name) const;

  mutable std::shared_ptr<mfem::FiniteElementCollection> _fec{nullptr};

  void buildFESpace(const int vdim) const;
  mutable std::shared_ptr<mfem::ParFiniteElementSpace> _fespace{nullptr};

  mfem::ParMesh & _pmesh;
};

#endif