CSG::CSGUniverse Class Reference

CSGUniverse creates an internal representation of a Constructive Solid Geometry (CSG) universe, which represents a collection of cells that can be defined repeatedly within a separate container of cells. More...

#include <CSGUniverse.h>

Public Member Functions
	CSGUniverse (const std::string &name, bool is_root=false)
	Construct a new CSGUniverse object. More...
	CSGUniverse (const std::string &name, std::vector< CSGCell *> &cells, bool is_root=false)
	Construct a new CSGUniverse object from list of cells. More...
virtual	~CSGUniverse ()=default
	Destructor. More...
const CSGCell &	getCell (const std::string &name)
	Get the CSGCell object by name. More...
bool	hasCell (const std::string &name) const
	check if cell of provided name is present in universe More...
const std::vector< std::reference_wrapper< const CSGCell > > &	getAllCells () const
	Get list of the all cells in the universe. More...
const std::string &	getName () const
	Get the name of the universe. More...
bool	isRoot () const
	return true if the universe is the root universe More...
bool	operator== (const CSGUniverse &other) const
	Operator overload for checking if two CSGUniverse objects are equal. More...
bool	operator!= (const CSGUniverse &other) const
	Operator overload for checking if two CSGUniverse objects are not equal. More...

Protected Member Functions
void	addCell (const CSGCell &cell)
	add cell to universe More...
void	removeCell (const std::string &name)
	remove a cell of the specified name from the universe More...
void	removeAllCells ()
	remove all cells from the universe More...
void	setName (const std::string &name)
	FRIEND_TEST (CSGUniverseTest, testGetCell)
	Friends for unit testing. More...
	FRIEND_TEST (CSGUniverseTest, testAddCell)
	FRIEND_TEST (CSGUniverseTest, testRemoveCell)
	FRIEND_TEST (CSGUniverseTest, testRemoveAllCells)
	FRIEND_TEST (CSGUniverseTest, testSetName)

Protected Attributes
std::string	_name
	Name of universe. More...
std::vector< std::reference_wrapper< const CSGCell > >	_cells
	list of references to cells in universe More...
bool	_is_root
	whether or not this universe is the root universe More...

Friends
class	CSGUniverseList
class	CSGBase

Detailed Description

CSGUniverse creates an internal representation of a Constructive Solid Geometry (CSG) universe, which represents a collection of cells that can be defined repeatedly within a separate container of cells.

Definition at line 26 of file CSGUniverse.h.

Constructor & Destructor Documentation

CSGUniverse() [1/2]

CSG::CSGUniverse::CSGUniverse	(	const std::string &	name,
		bool	is_root = false
	)

Construct a new CSGUniverse object.

Parameters

name	unique name of universe
is_root	true to set universe as the root universe (default false)

Definition at line 15 of file CSGUniverse.C.

: _name(name), _is_root(is_root) {}

CSGUniverse() [2/2]

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

Construct a new CSGUniverse object from list of cells.

Parameters

name	unique name of universe
cells	list of cells to add to universe
is_root	true to set universe as the root universe (default false)

Definition at line 17 of file CSGUniverse.C.

  : _name(name), _is_root(is_root)
{
  for (auto cell : cells)
    addCell(*cell);
}

~CSGUniverse()

virtual CSG::CSGUniverse::~CSGUniverse ( )

virtualdefault

Destructor.

Member Function Documentation

addCell()

void CSG::CSGUniverse::addCell ( const CSGCell &  cell )

protected

add cell to universe

Parameters

reference

to cell to add

Definition at line 25 of file CSGUniverse.C.

Referenced by CSG::CSGBase::addCellToUniverse(), and CSGUniverse().

{
  auto cell_name = cell.getName();
  if (!hasCell(cell_name))
    _cells.push_back(cell);
  else
    mooseWarning("Universe " + getName() + " already contains a cell by name " + cell_name + ". " +
                 "Skipping cell insertion for cell with duplicate name.");
}

FRIEND_TEST() [1/5]

CSG::CSGUniverse::FRIEND_TEST ( CSGUniverseTest  , testGetCell    )

protected

Friends for unit testing.

FRIEND_TEST() [2/5]

CSG::CSGUniverse::FRIEND_TEST ( CSGUniverseTest  , testAddCell    )

protected

FRIEND_TEST() [3/5]

CSG::CSGUniverse::FRIEND_TEST ( CSGUniverseTest  , testRemoveCell    )

protected

FRIEND_TEST() [4/5]

CSG::CSGUniverse::FRIEND_TEST ( CSGUniverseTest  , testRemoveAllCells    )

protected

FRIEND_TEST() [5/5]

CSG::CSGUniverse::FRIEND_TEST ( CSGUniverseTest  , testSetName    )

protected

getAllCells()

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

inline

Get list of the all cells in the universe.

Returns

list of pointers to cells in universe

Definition at line 72 of file CSGUniverse.h.

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

{ return _cells; }

getCell()

const CSGCell & CSG::CSGUniverse::getCell

(

const std::string &

name

)

Get the CSGCell object by name.

Parameters

name	name of cell

Returns

reference to the cell of the specified name in this universe

Definition at line 36 of file CSGUniverse.C.

{
  if (!hasCell(name))
    mooseError("Cell with name " + name + " does not exist in universe " + _name + ".");
  for (const CSGCell & cell : _cells)
    if (cell.getName() == name)
      return cell;
  mooseError("Should not reach here.");
}

getName()

const std::string& CSG::CSGUniverse::getName ( ) const

inline

Get the name of the universe.

Returns

name of universe

Definition at line 79 of file CSGUniverse.h.

Referenced by addCell(), CSG::CSGBase::addCellToUniverse(), CSG::CSGBase::checkUniverseInBase(), CSG::CSGBase::getLinkedUniverses(), operator==(), CSG::CSGBase::removeCellFromUniverse(), and CSG::CSGUniverseList::renameUniverse().

{ return _name; }

hasCell()

bool CSG::CSGUniverse::hasCell

(

const std::string &

name

)

const

check if cell of provided name is present in universe

Parameters

name	name of cell

Returns

true if cell of name is in universe, otherwise false

Definition at line 47 of file CSGUniverse.C.

Referenced by addCell(), getCell(), and removeCell().

{
  for (const CSGCell & cell : _cells)
    if (cell.getName() == name)
      return true;
  return false;
}

isRoot()

bool CSG::CSGUniverse::isRoot ( ) const

inline

return true if the universe is the root universe

Returns

true / false

Definition at line 86 of file CSGUniverse.h.

{ return _is_root; }

operator!=()

bool CSG::CSGUniverse::operator!=

(

const CSGUniverse &

other

)

const

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

Definition at line 93 of file CSGUniverse.C.

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

operator==()

bool CSG::CSGUniverse::operator==

(

const CSGUniverse &

other

)

const

Operator overload for checking if two CSGUniverse objects are equal.

Definition at line 70 of file CSGUniverse.C.

{
  const bool names_eq = this->getName() == other.getName();
  if (names_eq)
  {
    const auto & all_cells = getAllCells();
    const auto & other_cells = other.getAllCells();
    const bool num_cells_eq = all_cells.size() == other_cells.size();
    if (num_cells_eq)
    {
      for (unsigned int i = 0; i < all_cells.size(); ++i)
        if (all_cells[i].get() != other_cells[i].get())
          return false;
      return true;
    }
    else
      return false;
  }
  else
    return false;
}

removeAllCells()

void CSG::CSGUniverse::removeAllCells ( )

inlineprotected

remove all cells from the universe

Definition at line 112 of file CSGUniverse.h.

{ _cells.clear(); }

removeCell()

void CSG::CSGUniverse::removeCell ( const std::string &  name )

protected

remove a cell of the specified name from the universe

Parameters

name	name of cell to remove

Definition at line 56 of file CSGUniverse.C.

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

{
  if (!hasCell(name))
    mooseError("Cannot remove cell. Cell with name " + name + " does not exist in universe " +
               _name + ".");
  for (auto it = _cells.begin(); it != _cells.end(); ++it)
    if (it->get().getName() == name)
    {
      _cells.erase(it);
      break;
    }
}

setName()

void CSG::CSGUniverse::setName ( const std::string &  name )

inlineprotected

Definition at line 116 of file CSGUniverse.h.

{ _name = name; }

Friends And Related Function Documentation

CSGBase

friend class CSGBase

friend

Definition at line 131 of file CSGUniverse.h.

CSGUniverseList

friend class CSGUniverseList

friend

Definition at line 128 of file CSGUniverse.h.

Member Data Documentation

_cells

std::vector<std::reference_wrapper<const CSGCell> > CSG::CSGUniverse::_cells

protected

list of references to cells in universe

Definition at line 122 of file CSGUniverse.h.

Referenced by addCell(), getAllCells(), getCell(), hasCell(), removeAllCells(), and removeCell().

_is_root

bool CSG::CSGUniverse::_is_root

protected

whether or not this universe is the root universe

Definition at line 125 of file CSGUniverse.h.

Referenced by isRoot().

_name

std::string CSG::CSGUniverse::_name

protected

Name of universe.

Definition at line 119 of file CSGUniverse.h.

Referenced by getCell(), getName(), removeCell(), and setName().

---

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

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