VertexMarker.h

Go to the documentation of this file.

// This file is part of the Peano project. For conditions of distribution and
// use, please see the copyright notice at www.peano-framework.org
#pragma once
 
 
#include "peano4/grid/GridTraversalEvent.h"
#include "peano4/utils/Globals.h"
#include "tarch/la/Vector.h"
 
 
namespace peano4 {
  namespace datamanagement {
    struct VertexMarker;
 
    tarch::la::Vector<Dimensions, double> reconstructXOfParentVertex(
      const VertexMarker&             marker,
      const std::bitset<Dimensions>&  parentVertexPositionWithinParentCell
    );
  } // namespace datamanagement
} // namespace peano4
 
 
namespace toolbox {
  namespace particles {
    namespace tests {
      class MultiscaleTransitionsTest;
      class TestHelpers;
    } // namespace tests
  }   // namespace particles
} // namespace toolbox
 
 
std::ostream& operator<<(std::ostream& out, const peano4::datamanagement::VertexMarker& marker);
 
 
struct peano4::datamanagement::VertexMarker {
private:
  friend class toolbox::particles::tests::MultiscaleTransitionsTest;
  friend class toolbox::particles::tests::TestHelpers;
 
  tarch::la::Vector<Dimensions, double> _cellCentre;
 
  tarch::la::Vector<Dimensions, double> _h;
 
  int _select;
 
  std::bitset<TwoPowerD>    _hasBeenRefined;
  std::bitset<TwoPowerD>    _willBeRefined;
  std::bitset<TwoPowerD>    _isLocal;
  std::bitset<TwoPowerD>    _isHanging;
  std::bitset<TwoPowerD>    _isParentVertexLocal;
  std::bitset<ThreePowerD>  _isAdjacentCellLocal;
  std::bitset<TwoPowerD>    _isParentOfSubtree;
 
  bool _isParentCellLocal;
 
  bool isParentLocal() const;
 
  std::bitset<TwoPowerD>  _isAdjacentToParallelDomainBoundary;
 
  tarch::la::Vector<Dimensions, int> _relativePositionOfCellWithinFatherCell;
 
  tarch::la::Vector<TwoPowerD,int>   _numberOfAdjacentTrees;
 
  VertexMarker() = default;
 
public:
  VertexMarker(const ::peano4::grid::GridTraversalEvent& event, int select = 0);
 
  VertexMarker& select(int number);
 
  int getSelectedVertexNumber() const;
 
  tarch::la::Vector<Dimensions, double> x(int i) const;
 
  tarch::la::Vector<Dimensions, double> x() const;
 
  bool isParentOfSubtree(int i) const;
  bool isParentOfSubtree() const;
 
  tarch::la::Vector<Dimensions, double> h() const;
 
  std::string toString() const;
 
  bool hasBeenRefined() const;
  bool hasBeenRefined(int i) const;
 
  bool willBeRefined() const;
  bool willBeRefined(int i) const;
 
  int   getNumberOfAdjacentTrees() const;
  int   getNumberOfAdjacentTrees(int i) const;
 
  bool isLocal() const;
 
  bool isLocal(int i) const;
 
  bool isHanging() const;
 
  bool isHanging(int i) const;
 
  bool isAdjacentToParallelDomainBoundary() const;
 
  bool isAdjacentToParallelDomainBoundary(int i) const;
 
  bool isParentCellLocal() const;
 
  bool isParentVertexLocal(int i) const;
 
 
  tarch::la::Vector<Dimensions, int> getRelativePositionWithinFatherCell() const;
  tarch::la::Vector<Dimensions, int> getRelativePositionWithinFatherCell(int i) const;
 
  bool coincidesWithCoarseGridVertex() const;
 
 
  bool isContainedInAdjacentCells(
    const tarch::la::Vector<Dimensions, double>& x,
    double                                       scaleAdjacentCells = 1.0,
    double                                       tolerance          = tarch::la::NUMERICAL_ZERO_DIFFERENCE
  ) const;
 
 
  tarch::la::Vector<Dimensions, int> getRelativeAdjacentCell(const tarch::la::Vector<Dimensions, double>& x) const;
 
  tarch::la::Vector<Dimensions, double> getInvokingCellCentre() const;
 
  tarch::la::Vector<Dimensions, double> getInvokingParentCellsCentre() const;
 
  std::bitset<TwoPowerD> areAdjacentCellsLocal() const;
};