CSGHexagonalLattice.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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 "CSGLattice.h"
 
#ifdef MOOSE_UNIT_TEST
#include "gtest/gtest.h"
#endif
 
namespace CSG
{
 
class CSGHexagonalLattice : public CSGLattice
{
public:
  CSGHexagonalLattice(const std::string & name,
                      Real pitch,
                      std::vector<std::vector<std::reference_wrapper<const CSGUniverse>>> universes,
                      const std::optional<OuterVariant> & outer = std::nullopt);
 
  CSGHexagonalLattice(const std::string & name,
                      Real pitch,
                      const std::optional<OuterVariant> & outer = std::nullopt);
 
  virtual ~CSGHexagonalLattice() = default;
 
  std::unique_ptr<CSGLattice> clone() const override
  {
    return std::make_unique<CSGHexagonalLattice>(*this);
  }
 
  virtual std::unordered_map<std::string, AttributeVariant> getAttributes() const override;
 
  virtual bool isValidIndex(const std::pair<int, int> index) const override;
 
  virtual bool isValidUniverseMap(
      std::vector<std::vector<std::reference_wrapper<const CSGUniverse>>> universes) const override;
 
  unsigned int getNRows() const { return _nrow; }
 
  unsigned int getNRings() const { return _nring; }
 
  std::pair<int, int> getRowIndexFromRingIndex(const std::pair<int, int> & row_col_index) const;
 
  std::pair<int, int> getRingIndexFromRowIndex(const std::pair<int, int> & row_col_index) const;
 
  Real getPitch() const { return _pitch; }
 
  void setPitch(Real pitch);
 
protected:
  virtual bool compareAttributes(const CSGLattice & other) const override;
 
  void buildIndexMap();
 
  virtual void setUniverses(
      std::vector<std::vector<std::reference_wrapper<const CSGUniverse>>> universes) override;
 
  Real _pitch;
 
  unsigned int _nrow;
 
  unsigned int _nring;
 
  std::map<std::pair<unsigned int, unsigned int>, std::pair<unsigned int, unsigned int>>
      _row_to_ring_map;
 
#ifdef MOOSE_UNIT_TEST
  FRIEND_TEST(CSGLatticeTest, testHexSetUniverses);
  FRIEND_TEST(CSGLatticeTest, testConvertRowsRings);
#endif
};
 
unsigned int nRowToRing(int nrow);
 
unsigned int nRingToRow(int nring);
 
} // namespace CSG