CSG::CSGCellList Class Reference

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...
std::unordered_map< std::string, std::unique_ptr< CSGCell > > &	getCellListMap ()
	Get 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)
	add a cell to the CellList. More...
void	renameCell (const CSGCell &cell, const std::string &name)
	rename the specified cell 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.

{}

~CSGCellList()

virtual CSG::CSGCellList::~CSGCellList ( )

protectedvirtualdefault

Destructor.

Member Function Documentation

addCell()

CSGCell & CSG::CSGCellList::addCell ( std::unique_ptr< CSGCell >  cell )

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.

Returns

reference to CSGCell that was added to CellList

Definition at line 18 of file CSGCellList.C.

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

{
  auto name = cell->getName();
  auto [it, inserted] = _cells.emplace(name, std::move(cell));
  if (!inserted)
    mooseError("Cell with name " + name + " already exists in geometry.");
  return *it->second;
}

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 43 of file CSGCellList.C.

Referenced by 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 51 of file CSGCellList.C.

Referenced by 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 37 of file CSGCellList.C.

Referenced by 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 59 of file CSGCellList.C.

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

{
  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 28 of file CSGCellList.C.

Referenced by CSG::CSGBase::checkCellInBase(), CSG::CSGBase::getCellByName(), 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()

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

inlineprotected

Get map of all names to cells in cell list.

Returns

map of all names to CSGCell pointers

Definition at line 72 of file CSGCellList.h.

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

{ return _cells; }

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 68 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 110 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 107 of file CSGCellList.h.

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

---

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

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