CD_CutCellBody.H

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */
 
#ifndef CD_CUTCELLBODY_H
#define CD_CUTCELLBODY_H
 
// Chombo includes
#include <RealVect.H>
#include <LoHiSide.H>
 
// Our includes
#include <CD_CutCellSurface.H>
#include <CD_PolyhedralEBUtils.H>
#include <CD_NamespaceHeader.H>
 
namespace PolyhedralEB {
 
class CutCellBody
{
public:
  enum class Kind
  {
    Regular,
    Covered,
    Cut
  };
 
  CutCellBody() noexcept;
 
  ~CutCellBody() noexcept = default;
 
  bool
  define(const CutCellSurface& a_surface) noexcept;
 
  static Kind
  classify(const CutCellSurface& a_surface) noexcept;
 
  static int
  numSheets(const CutCellSurface& a_surface) noexcept;
 
  bool
  isConnected() const noexcept;
 
  bool
  interfaceIsPlanar() const noexcept;
 
  bool
  subdivide(CutCellBody* a_children) const noexcept;
 
  bool
  hasMultiValuedChildren(const int a_refRat) const noexcept;
 
  Real
  volumeFraction() const noexcept;
 
  const RealVect&
  volumeCentroid() const noexcept;
 
  Real
  areaFraction(const int a_dir, const Side::LoHiSide a_side) const noexcept;
 
  const RealVect&
  faceCentroid(const int a_dir, const Side::LoHiSide a_side) const noexcept;
 
  Real
  boundaryArea() const noexcept;
 
  Real
  trueBoundaryArea() const noexcept;
 
  const RealVect&
  normal() const noexcept;
 
  const RealVect&
  boundaryCentroid() const noexcept;
 
  Real
  closureResidual() const noexcept;
 
#if CH_SPACEDIM == 3
  void
  appendInterfaceFacets(Vector<Real>&   a_facets,
                        const IntVect&  a_cell,
                        const RealVect& a_probLo,
                        const Real      a_dx) const noexcept;
 
  void
  printPolygons(std::ostream& a_out) const noexcept;
 
  bool
  restrictFace(const CutCellSurface* a_children, const int a_dir, const int a_side) noexcept;
 
  bool
  closeInterface() noexcept;
 
  bool
  closeBoundary(const int a_face) noexcept;
 
  bool
  snapFace(const int a_dir, const int a_side, const bool a_neighbourIsFluid) noexcept;
 
  bool
  weldTJunctions() noexcept;
 
#endif
 
  int
  numPolygons() const noexcept;
 
  int
  widestPolygon() const noexcept;
 
  Real
  divergenceResidual() const noexcept;
 
protected:
  static constexpr int s_numFaces = 2 * SpaceDim;
 
  static constexpr int s_maxPolygons = 20;
 
  static constexpr int s_maxVertices = 20;
 
  static constexpr Real s_edgeTolerance = 1.0E-12;
 
  static constexpr Real s_nullArea = 1.0E-18;
  struct Polygon
  {
    RealVect m_vertex[s_maxVertices];
 
    int m_vertexEdge[s_maxVertices];
 
    int m_numVertices;
 
    int m_face;
 
    int m_segmentFace[s_maxVertices];
  };
 
  void
  defineDegenerate(const CutCellSurface& a_surface, const Kind a_kind) noexcept;
 
  bool
  defineCut(const CutCellSurface& a_surface) noexcept;
 
#if CH_SPACEDIM == 3
  bool
  mergeCoplanar(const Polygon* a_in, const int a_num, Polygon* a_out, const int a_maxOut, int& a_numOut) const noexcept;
 
  int
  faceWalk(const int a_dir, const int a_side, const CutCellSurface& a_surface, Polygon* a_out) const noexcept;
 
  void
  orientOutward(Polygon& a_polygon, const int a_dir, const int a_side) const noexcept;
#endif
 
  bool
  partitions(const CutCellBody* a_children) const noexcept;
 
  void
  accumulateMoments() noexcept;
 
  Polygon m_polygon[s_maxPolygons];
 
  int m_numPolygons;
 
  Real m_volumeFraction;
 
  Real m_areaFraction[s_numFaces];
 
  Real m_boundaryArea;
 
  Real m_trueBoundaryArea;
 
  RealVect m_volumeCentroid;
 
  RealVect m_faceCentroid[s_numFaces];
 
  RealVect m_normal;
 
  RealVect m_boundaryCentroid;
 
  RealVect m_closure;
};
 
} // namespace PolyhedralEB
 
#include <CD_NamespaceFooter.H>
 
#endif