CSGCellList creates a container for CSGCell objects to pass to CSGBase object. More...

#include <CSGCellList.h>

Protected Member Functions
	CSGCellList ()
	Default constructor. More...

virtual	~CSGCellList ()=default
	Destructor. More...

CSGCell &	addMaterialCell (const std::string &name, const std::string &mat_name, const CSGRegion &region)
	Add a Material Cell object to cell list. More...

CSGCell &	addVoidCell (const std::string &name, const CSGRegion &region)
	Add a Void Cell object cell list. More...

CSGCell &	addUniverseCell (const std::string &name, const CSGUniverse &univ, const CSGRegion &region)
	Add a Universe Cell object to cell list. More...

CSGCell &	addLatticeCell (const std::string &name, const CSGLattice &lattice, const CSGRegion &region)
	Add a Lattice Cell object to cell list. More...

bool	hasCell (const std::string &name) const
	return whether cell with given name exists in cell list More...

std::unordered_map< std::string, std::unique_ptr< CSGCell > > &	getCellListMap ()
	Get non-const map of all names to cells in cell list. More...

const std::unordered_map< std::string, std::unique_ptr< CSGCell > > &	getCellListMap () const
	Get const map of all names to cells in cell list. More...

std::vector< std::reference_wrapper< const CSGCell > >	getAllCells () const
	Get all the cells in CSGBase instance. More...

CSGCell &	getCell (const std::string &name) const
	Get the CSGCell by name. More...

CSGCell &	addCell (std::unique_ptr< CSGCell > cell, const bool ignore_identical_cell=false)
	add a cell to the CellList. More...

void	renameCell (const CSGCell &cell, const std::string &name)
	rename the specified cell More...

bool	operator== (const CSGCellList &other) const
	Operator overload for checking if two CSGCellList objects are equal. More...

bool	operator!= (const CSGCellList &other) const
	Operator overload for checking if two CSGCellList objects are not equal. More...

Protected Attributes
std::unordered_map< std::string, std::unique_ptr< CSGCell > >	_cells
	Mapping of cell names to pointers of stored cell objects. More...

Friends
class	CSGBase

Detailed Description

CSGCellList creates a container for CSGCell objects to pass to CSGBase object.

Definition at line 20 of file CSGCellList.h.

Constructor & Destructor Documentation

◆ CSGCellList()

CSG::CSGCellList::CSGCellList ( )

protected

Default constructor.

Definition at line 15 of file CSGCellList.C.

15 {}

◆ ~CSGCellList()

virtual CSG::CSGCellList::~CSGCellList ( )

protectedvirtualdefault

Destructor.

Member Function Documentation

◆ addCell()

CSGCell & CSG::CSGCellList::addCell	(	std::unique_ptr< CSGCell >	cell,
		const bool	ignore_identical_cell = `false`
	)

protected

add a cell to the CellList.

Ownership of cell will be transferred to cell list object that calls this function

Parameters

cell	cell to add to the CellList.
ignore_identical_cell	skip adding cell if an identical cell exists in cell list

Returns: reference to CSGCell that was added to CellList

Definition at line 18 of file CSGCellList.C.

Referenced by addLatticeCell(), addMaterialCell(), addUniverseCell(), addVoidCell(), CSG::CSGBase::joinCellList(), and renameCell().

 {
   auto cell_name = cell->getName();
   if (ignore_identical_cell)
     // Check that cell already defined in _cells and if so, confirm it matches with input cell
     if (auto it = _cells.find(cell_name); it != _cells.end())
     {
       if (*cell == *it->second)
         return *it->second;
       else
         mooseError("Cell with name ",
                    cell_name,
                    " has the same name as an existing cell in CSGBase instance but cannot be "
                    "discarded as it is not an identical cell.");
     }
 
   // Otherwise, add the cell to the cell list. At this point, we don't expect the cell
   // to already be defined in the cell list
   auto [it, inserted] = _cells.emplace(cell_name, std::move(cell));
   if (!inserted)
     mooseError("Cell with name " + cell_name + " already exists in geometry.");
 
   return *it->second;
 }

◆ addLatticeCell()

CSGCell & CSG::CSGCellList::addLatticeCell	(	const std::string &	name,
		const CSGLattice &	lattice,
		const CSGRegion &	region
	)

protected

Add a Lattice Cell object to cell list.

Parameters

name	unique cell name
lattice	lattice
region	cell region

Returns: reference to CSGCell with lattice fill that was created and added to this CSGCellList

Definition at line 75 of file CSGCellList.C.

Referenced by CSG::CSGBase::addCellToList(), and CSG::CSGBase::createCell().

 {
   return addCell(std::make_unique<CSGCell>(name, &lattice, region));
 }

◆ addMaterialCell()

CSGCell & CSG::CSGCellList::addMaterialCell	(	const std::string &	name,
		const std::string &	mat_name,
		const CSGRegion &	region
	)

protected

Add a Material Cell object to cell list.

Parameters

name	unique cell name
mat_name	material name
region	cell region

Returns: reference to CSGCell with material fill that was created and added to this CSGCellList

Definition at line 59 of file CSGCellList.C.

Referenced by CSG::CSGBase::addCellToList(), and CSG::CSGBase::createCell().

 {
   return addCell(std::make_unique<CSGCell>(name, mat_name, region));
 }

◆ addUniverseCell()

CSGCell & CSG::CSGCellList::addUniverseCell	(	const std::string &	name,
		const CSGUniverse &	univ,
		const CSGRegion &	region
	)

protected

Add a Universe Cell object to cell list.

Parameters

name	unique cell name
univ	universe
region	cell region

Returns: reference to CSGCell with universe fill that was created and added to this CSGCellList

Definition at line 67 of file CSGCellList.C.

Referenced by CSG::CSGBase::addCellToList(), and CSG::CSGBase::createCell().

 {
   return addCell(std::make_unique<CSGCell>(name, &univ, region));
 }

◆ addVoidCell()

CSGCell & CSG::CSGCellList::addVoidCell	(	const std::string &	name,
		const CSGRegion &	region
	)

protected

Add a Void Cell object cell list.

Parameters

name	unique cell name
region	cell region

Returns: reference to CSGCell with void fill that was created and added to this CSGCellList

Definition at line 53 of file CSGCellList.C.

Referenced by CSG::CSGBase::addCellToList(), and CSG::CSGBase::createCell().

 {
   return addCell(std::make_unique<CSGCell>(name, region));
 }

◆ getAllCells()

std::vector< std::reference_wrapper< const CSGCell > > CSG::CSGCellList::getAllCells ( ) const

protected

Get all the cells in CSGBase instance.

Returns: list of references to all CSGCell objects

Definition at line 83 of file CSGCellList.C.

Referenced by CSG::CSGBase::deleteLattice(), CSG::CSGBase::deleteSurface(), CSG::CSGBase::deleteUniverse(), CSG::CSGBase::getAllCells(), and operator==().

 {
   std::vector<std::reference_wrapper<const CSGCell>> cells;
   for (auto it = _cells.begin(); it != _cells.end(); ++it)
     cells.push_back(*(it->second));
   return cells;
 }

◆ getCell()

CSGCell & CSG::CSGCellList::getCell ( const std::string & name ) const

protected

Get the CSGCell by name.

Parameters

name

Returns: reference to CSGCell of the specified name

Definition at line 44 of file CSGCellList.C.

Referenced by CSG::CSGBase::addCellToList(), CSG::CSGBase::addTransformation(), CSG::CSGBase::checkCellInBase(), CSG::CSGBase::CSGBase(), CSG::CSGBase::getCellByName(), operator==(), CSG::CSGBase::resetCellFill(), CSG::CSGBase::updateCellFill(), and CSG::CSGBase::updateCellRegion().

 {
   if (_cells.find(name) == _cells.end())
     mooseError("No cell by name " + name + " exists in the geometry.");
   else
     return *(_cells.find(name)->second);
 }

◆ getCellListMap() [1/2]

std::unordered_map<std::string, std::unique_ptr<CSGCell> >& CSG::CSGCellList::getCellListMap ( )

inlineprotected

Get non-const map of all names to cells in cell list.

Returns: map of all names to CSGCell pointers

Definition at line 92 of file CSGCellList.h.

Referenced by CSG::CSGBase::CSGBase(), CSG::CSGBase::deleteCell(), CSG::CSGBase::joinCellList(), CSG::CSGBase::replaceLatticeRefsByName(), CSG::CSGBase::replaceSurfaceRefsByName(), CSG::CSGBase::replaceUniverseRefsByName(), and CSG::CSGBase::updateIncomingCSGReferences().

92 { return _cells; }

CSG::CSGCellList::_cells

std::unordered_map< std::string, std::unique_ptr< CSGCell > > _cells

Mapping of cell names to pointers of stored cell objects.

Definition: CSGCellList.h:144

◆ getCellListMap() [2/2]

const std::unordered_map<std::string, std::unique_ptr<CSGCell> >& CSG::CSGCellList::getCellListMap ( ) const

inlineprotected

Get const map of all names to cells in cell list.

Returns: map of all names to CSGCell pointers

Definition at line 99 of file CSGCellList.h.

   {
     return _cells;
   }

◆ hasCell()

bool CSG::CSGCellList::hasCell ( const std::string & name ) const

inlineprotected

return whether cell with given name exists in cell list

Parameters

name	name of cell

Returns: true if cell name exists, false otherwise

Definition at line 85 of file CSGCellList.h.

Referenced by CSG::CSGBase::addCellToList(), CSG::CSGBase::hasCell(), and operator==().

85 { return _cells.find(name) != _cells.end(); }

CSG::CSGCellList::_cells

std::unordered_map< std::string, std::unique_ptr< CSGCell > > _cells

Mapping of cell names to pointers of stored cell objects.

Definition: CSGCellList.h:144

◆ operator!=()

bool CSG::CSGCellList::operator!= ( const CSGCellList & other ) const

protected

Operator overload for checking if two CSGCellList objects are not equal.

Definition at line 132 of file CSGCellList.C.

 {
   return !(*this == other);
 }

◆ operator==()

bool CSG::CSGCellList::operator== ( const CSGCellList & other ) const

protected

Operator overload for checking if two CSGCellList objects are equal.

Definition at line 108 of file CSGCellList.C.

 {
   const auto all_cells = this->getAllCells();
   const auto other_cells = other.getAllCells();
 
   // Check that same number of cells are defined in both lists
   if (all_cells.size() != other_cells.size())
     return false;
 
   // Iterate through each CSGCell in list and check equality of each cell
   // with other list
   for (const auto & cell : all_cells)
   {
     const auto & cell_name = cell.get().getName();
     if (!other.hasCell(cell_name))
       return false;
     const auto & other_cell = other.getCell(cell_name);
     if (cell.get() != other_cell)
       return false;
   }
   return true;
 }

◆ renameCell()

void CSG::CSGCellList::renameCell	(	const CSGCell &	cell,
		const std::string &	name
	)

protected

rename the specified cell

Parameters

cell	reference to CSGCell object that should be renamed
name	new name

Definition at line 92 of file CSGCellList.C.

Referenced by CSG::CSGBase::renameCell().

 {
   // check that this cell passed in is actually in the same cell that is in the cell list
   auto prev_name = cell.getName();
   auto it = _cells.find(prev_name);
   if (it == _cells.end() || it->second.get() != &cell)
     mooseError("Cell " + prev_name + " cannot be renamed to " + name +
                " as it does not exist in this CSGBase instance.");
 
   auto existing_cell = std::move(_cells.find(prev_name)->second);
   existing_cell->setName(name);
   _cells.erase(prev_name);
   addCell(std::move(existing_cell));
 }

Friends And Related Function Documentation

◆ CSGBase

friend class CSGBase

friend

Definition at line 147 of file CSGCellList.h.

Member Data Documentation

◆ _cells

std::unordered_map<std::string, std::unique_ptr<CSGCell> > CSG::CSGCellList::_cells

protected

Mapping of cell names to pointers of stored cell objects.

Definition at line 144 of file CSGCellList.h.

Referenced by addCell(), getAllCells(), getCell(), getCellListMap(), hasCell(), and renameCell().

The documentation for this class was generated from the following files:

include/csg/CSGCellList.h
src/csg/CSGCellList.C

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CSGCellList()

◆ ~CSGCellList()

Member Function Documentation

◆ addCell()

◆ addLatticeCell()

◆ addMaterialCell()

◆ addUniverseCell()

◆ addVoidCell()

◆ getAllCells()

◆ getCell()

◆ getCellListMap() [1/2]

◆ getCellListMap() [2/2]

◆ hasCell()

◆ operator!=()

◆ operator==()

◆ renameCell()

Friends And Related Function Documentation

◆ CSGBase

Member Data Documentation

◆ _cells