CD_VofUtils.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_VOFUTILS_H
#define CD_VOFUTILS_H
 
// Chombo includes
#include <Stencils.H>
#include <EBISBox.H>
#include <IntVectSet.H>
#include <RealVect.H>
#include <ProblemDomain.H>
#include <VolIndex.H>
#include <LoHiSide.H>
#include <DenseIntVectSet.H>
 
// Our includes
#include <CD_Location.H>
#include <CD_NamespaceHeader.H>
 
class VofUtils
{
public:
  enum class Connectivity
  {
    MonotonePath,
    SimplyConnected,
    All
  };
 
  enum class Neighborhood
  {
    Quadrant,
    Radius,
    SemiCircle
  };
 
  VofUtils() = delete;
 
  static Vector<VolIndex>
  getVofsInRadius(const VolIndex&    a_startVof,
                  const EBISBox&     a_ebisbox,
                  const int          a_radius,
                  const Connectivity a_connectivity,
                  const bool         a_addStartVof);
 
  static Vector<VolIndex>
  getVofsInRadius(const VolIndex&        a_startVof,
                  const EBISBox&         a_ebisbox,
                  const int              a_radius,
                  const DenseIntVectSet& a_validCells,
                  const Connectivity     a_connectivity,
                  const bool             a_addStartVof);
 
  static Vector<VolIndex>
  getVofsInQuadrant(const VolIndex&    a_startVof,
                    const EBISBox&     a_ebisbox,
                    const RealVect&    a_normal,
                    const int          a_radius,
                    const Connectivity a_connectivity,
                    const bool         a_addStartVof);
 
  static Vector<VolIndex>
  restrictVofsToQuadrant(const Vector<VolIndex>& a_vofs,
                         const VolIndex&         a_startVof,
                         const EBISBox&          a_ebisbox,
                         const RealVect&         a_normal,
                         const int               a_radius);
 
  static Vector<VolIndex>
  getVofsInSemiCircle(const VolIndex&      a_startVof,
                      const EBISBox&       a_ebisbox,
                      const RealVect&      a_normal,
                      const int            a_radius,
                      const Real           a_deltaThresh,
                      const Connectivity   a_connectivity,
                      const Location::Cell a_vofLocation,
                      const Location::Cell a_cellLocation,
                      const bool           a_addStartVof);
 
  static Vector<VolIndex>
  restrictVofsToSemiCircle(const Vector<VolIndex>& a_vofs,
                           const VolIndex&         a_startVof,
                           const EBISBox&          a_ebisbox,
                           const RealVect&         a_normal,
                           const Real              a_deltaThresh,
                           const Location::Cell    a_vofLocation,
                           const Location::Cell    a_cellLocation);
 
  static void
  excludeCells(Vector<VolIndex>& a_vofs, const Box& a_excludeBox);
 
  static void
  excludeCells(Vector<VolIndex>& a_vofs, const IntVectSet& a_excludeIVS);
 
  static void
  includeCells(Vector<VolIndex>& a_vofs, const Box& a_includeBox);
 
  static void
  includeCells(Vector<VolIndex>& a_vofs, const IntVectSet& a_includeIVS);
 
  static void
  includeCells(Vector<VolIndex>& a_vofs, const DenseIntVectSet& a_includeIVS);
 
  static void
  onlyUnique(Vector<VolIndex>& a_vofs);
 
protected:
  static bool
  isQuadrantWellDefined(const RealVect& a_normal);
 
  static std::pair<int, Side::LoHiSide>
  getCardinalDirection(const RealVect& a_normal);
 
  static Vector<VolIndex>
  getVofsInMonotonePath(const VolIndex& a_startVof,
                        const EBISBox&  a_ebisbox,
                        const int       a_radius,
                        const bool      a_addStartVof);
 
  static Vector<VolIndex>
  getConnectedVofsInRadius(const VolIndex& a_startVof,
                           const EBISBox&  a_ebisbox,
                           const int       a_radius,
                           const bool      a_addStartVof);
 
  static Vector<VolIndex>
  getAllVofsInRadius(const VolIndex& a_startVof,
                     const EBISBox&  a_ebisbox,
                     const int       a_radius,
                     const bool      a_addStartVof);
 
  static Vector<VolIndex>
  connectedVofsOnly(const VolIndex& a_startVof, const Vector<VolIndex>& a_allVofs, const EBISBox& a_ebisbox);
 
  static Box
  getQuadrant(const RealVect& a_normal, const VolIndex& a_vof, const EBISBox& a_ebisbox, const Real a_radius);
 
  static Box
  getSymmetricQuadrant(const std::pair<int, Side::LoHiSide>& a_cardinal,
                       const VolIndex&                       a_vof,
                       const EBISBox&                        a_ebisbox,
                       const Real                            a_radius);
 
  static void
  getVofsInMonotonePath(Vector<VolIndex>& a_vofList,
                        const VolIndex&   a_startVof,
                        const EBISBox&    a_ebisbox,
                        const int         a_radius,
                        const IntVect&    a_timesMoved,
                        const IntVect&    a_pathSign);
 
  static void
  getVofsInMonotonePath(std::set<VolIndex>& a_vofSet,
                        const VolIndex&     a_startVof,
                        const EBISBox&      a_ebisbox,
                        const Box&          a_validBox,
                        const int&          a_radius,
                        const IntVect&      a_timesMoved,
                        const IntVect&      a_pathSign);
};
 
#include <CD_NamespaceFooter.H>
 
#endif