MFEMMesh.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 "MooseMesh.h"
 
class MFEMMesh : public MooseMesh
{
public:
  static InputParameters validParams();
 
  MFEMMesh(const InputParameters & parameters);
 
  mfem::ParMesh & getMFEMParMesh() { return *_mfem_par_mesh; }
  const mfem::ParMesh & getMFEMParMesh() const;
 
  std::shared_ptr<mfem::ParMesh> getMFEMParMeshPtr() { return _mfem_par_mesh; }
 
  void init() override;
  std::vector<std::filesystem::path>
  writeRecoveryFiles(const std::filesystem::path & file_base) override;
 
  bool shouldDisplace() const { return _mesh_displacement_variable.has_value(); }
 
  std::optional<std::reference_wrapper<std::string const>> getMeshDisplacementVariable() const
  {
    return _mesh_displacement_variable;
  }
 
  void displace(mfem::GridFunction const & displacement);
 
  bool isDistributedMesh() const override { return true; }
  unsigned int dimension() const override { return _mfem_par_mesh->Dimension(); }
  unsigned int spatialDimension() const override { return _mfem_par_mesh->SpaceDimension(); }
  SubdomainID nSubdomains() const override { return _mfem_par_mesh->attributes.Size(); }
  dof_id_type nActiveElem() const override { return _mfem_par_mesh->GetGlobalNE(); }
  dof_id_type nActiveLocalElem() const override { return _mfem_par_mesh->GetNE(); }
 
  void buildMesh() override final;
 
protected:
  virtual mfem::Mesh buildSerialMFEMMesh() = 0;
 
  void buildDummyMooseMesh();
 
  void uniformRefinement(mfem::Mesh & mesh, const unsigned int nref) const;
 
  std::optional<std::string> _mesh_displacement_variable;
 
  std::shared_ptr<mfem::ParMesh> _mfem_par_mesh{nullptr};
};
 
inline const mfem::ParMesh &
MFEMMesh::getMFEMParMesh() const
{
  return const_cast<MFEMMesh *>(this)->getMFEMParMesh();
}
 
#endif