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

#pragma once

#include "MooseObject.h"
#include "SetupInterface.h"
#include "Restartable.h"
#include "MeshChangedInterface.h"

#include "libmesh/vector_value.h"

// libMesh forward declarations
namespace libMesh
{
class Point;
}

namespace MooseMeshDivision
{
inline unsigned int INVALID_DIVISION_INDEX = std::numeric_limits<unsigned int>::max();
}

class MeshDivision : public MooseObject, public SetupInterface, public MeshChangedInterface
{
public:
  static InputParameters validParams();

  MeshDivision(const InputParameters & parameters);

  virtual ~MeshDivision();

  virtual unsigned int divisionIndex(const Point & pt) const = 0;
  virtual unsigned int divisionIndex(const Elem & elem) const = 0;
  unsigned int getNumDivisions() const { return _num_divs; }
  bool coversEntireMesh() const { return _mesh_fully_indexed; }

  virtual void meshChanged() override { initialize(); }

protected:
  void setNumDivisions(const unsigned int ndivs) { _num_divs = ndivs; }

  virtual void initialize() {}

  const FEProblemBase * const _fe_problem;

  const MooseMesh & _mesh;

  bool _mesh_fully_indexed;

private:
  unsigned int _num_divs;
};