CSGCell.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

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

#include "CSGRegion.h"
#include "CSGTransformationHelper.h"

namespace CSG
{

class CSGUniverse;
class CSGLattice;

class CSGCell : public CSGTransformationHelper
{
public:
  CSGCell(const std::string & name, const CSGRegion & region);

  CSGCell(const std::string & name, const std::string & mat_name, const CSGRegion & region);

  CSGCell(const std::string & name, const CSGUniverse * univ, const CSGRegion & region);

  CSGCell(const std::string & name, const CSGLattice * lattice, const CSGRegion & region);

  virtual ~CSGCell() = default;

  const std::string getFillType() const { return _fill_type; }

  const CSGUniverse & getFillUniverse() const;

  const std::string & getFillMaterial() const;

  const CSGLattice & getFillLattice() const;

  const std::string & getFillName() const;

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

  const CSGRegion & getRegion() const { return _region; }

  void resetCellFill();

  void updateCellFill(const std::string & mat_name);

  void updateCellFill(const CSGUniverse * univ);

  void updateCellFill(const CSGLattice * lattice);

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

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

protected:
  void updateCellRegionSurfaces(
      std::map<std::string, std::reference_wrapper<const CSGSurface>> & identical_surface_refs);

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

  // update the region of the cell to a new region - not public because
  // it needs to be called from CSGBase so that the surfaces can be checked first.
  void updateRegion(const CSGRegion & region) { _region = region; }

  std::string _name;

  MooseEnum _fill_type{"VOID CSG_MATERIAL UNIVERSE LATTICE"};

  std::string _fill_name;

  CSGRegion _region;

  const CSGUniverse * _fill_universe;

  const CSGLattice * _fill_lattice;

  friend class CSGCellList; // needed for setName() access
  friend class CSGBase;     // needed for updateRegion() access

#ifdef MOOSE_UNIT_TEST
  FRIEND_TEST(CSGCellTest, testSetName);
  FRIEND_TEST(CSGCellTest, testUpdateRegion);
  FRIEND_TEST(CSGCellTest, testCellEquality);
#endif
};
} // namespace CSG