CSGUniverse.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 "CSGCellList.h"
#include "CSGTransformationHelper.h"

#ifdef MOOSE_UNIT_TEST
#include "gtest/gtest.h"
#endif

namespace CSG
{

class CSGUniverse : public CSGTransformationHelper
{
public:
  CSGUniverse(const std::string & name, bool is_root = false);

  CSGUniverse(const std::string & name, std::vector<CSGCell *> & cells, bool is_root = false);

  virtual ~CSGUniverse() = default;

  const CSGCell & getCell(const std::string & name);

  bool hasCell(const std::string & name) const;

  const std::vector<std::reference_wrapper<const CSGCell>> & getAllCells() const { return _cells; }

  const std::string & getName() const { return _name; }

  bool isRoot() const { return _is_root; }

  bool operator==(const CSGUniverse & other) const;

  bool operator!=(const CSGUniverse & other) const;

protected:
  void addCell(const CSGCell & cell);

  void removeCell(const std::string & name);

  void removeAllCells() { _cells.clear(); }

  // set the name of the universe - intentionally not public because
  // name needs to be managed at the CSGUniverseList level
  void setName(const std::string & name) { _name = name; }

  std::string _name;

  std::vector<std::reference_wrapper<const CSGCell>> _cells;

  bool _is_root;

  // CSGUniverseList needs to be friend to access setName()
  friend class CSGUniverseList;

  // CSGUniverseList needs to be friend to access addCell()
  friend class CSGBase;

#ifdef MOOSE_UNIT_TEST
  FRIEND_TEST(CSGUniverseTest, testGetCell);
  FRIEND_TEST(CSGUniverseTest, testAddCell);
  FRIEND_TEST(CSGUniverseTest, testRemoveCell);
  FRIEND_TEST(CSGUniverseTest, testRemoveAllCells);
  FRIEND_TEST(CSGUniverseTest, testSetName);
  FRIEND_TEST(CSGUniverseTest, testUniverseEquality);
#endif
};
} // namespace CSG