CSGUniverseList creates a container for CSGUniverse objects to pass to CSGBase. More...

#include <CSGUniverseList.h>

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

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

CSGUniverse &	addUniverse (const std::string &name)
	create an empty universe More...

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

std::unordered_map< std::string, std::unique_ptr< CSGUniverse > > &	getUniverseListMap ()
	Get non-const map of all names to universes in universe list. More...

const std::unordered_map< std::string, std::unique_ptr< CSGUniverse > > &	getUniverseListMap () const
	Get const map of all names to universes in universe list. More...

std::vector< std::reference_wrapper< const CSGUniverse > >	getAllUniverses () const
	Get all the universes in CSGBase instance. More...

CSGUniverse &	getUniverse (const std::string &name) const
	Get a Universe from the list by its name. More...

const CSGUniverse &	getRoot () const
	Get the root universe. More...

CSGUniverse &	addUniverse (std::unique_ptr< CSGUniverse > universe)
	add an existing universe to list. More...

void	renameUniverse (const CSGUniverse &universe, const std::string &name)
	rename the specified universe More...

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

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

Protected Attributes
std::unordered_map< std::string, std::unique_ptr< CSGUniverse > >	_universes
	Mapping of universe names to pointers of stored universe objects. More...

const CSGUniverse *	_root_universe
	root universe for the CSGBase instance More...

Friends
class	CSGBase

Detailed Description

CSGUniverseList creates a container for CSGUniverse objects to pass to CSGBase.

Definition at line 20 of file CSGUniverseList.h.

Constructor & Destructor Documentation

◆ CSGUniverseList()

CSG::CSGUniverseList::CSGUniverseList ( )

protected

Default constructor.

Definition at line 15 of file CSGUniverseList.C.

 {
   // create root universe by default when CSG object is initialized
   std::string root_name = "ROOT_UNIVERSE";
   auto root_universe = std::make_unique<CSGUniverse>(root_name, /* is_root = */ true);
   _root_universe = root_universe.get();
   _universes.insert(std::make_pair(root_name, std::move(root_universe)));
 }

◆ ~CSGUniverseList()

virtual CSG::CSGUniverseList::~CSGUniverseList ( )

protectedvirtualdefault

Destructor.

Member Function Documentation

◆ addUniverse() [1/2]

CSGUniverse & CSG::CSGUniverseList::addUniverse ( const std::string & name )

protected

create an empty universe

Parameters

name	unique name of universe

Returns: reference to empty universe that is created

Definition at line 44 of file CSGUniverseList.C.

Referenced by CSG::CSGBase::createUniverse(), CSG::CSGBase::joinUniverseList(), and renameUniverse().

 {
   return addUniverse(std::make_unique<CSGUniverse>(name));
 }

◆ addUniverse() [2/2]

CSGUniverse & CSG::CSGUniverseList::addUniverse ( std::unique_ptr< CSGUniverse > universe )

protected

add an existing universe to list.

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

Parameters

universe pointer to universe to add

Returns: reference to universe that is passed in

Definition at line 50 of file CSGUniverseList.C.

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

◆ getAllUniverses()

std::vector< std::reference_wrapper< const CSGUniverse > > CSG::CSGUniverseList::getAllUniverses ( ) const

protected

Get all the universes in CSGBase instance.

Returns: list of references to all CSGUniverse objects

Definition at line 35 of file CSGUniverseList.C.

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

 {
   std::vector<std::reference_wrapper<const CSGUniverse>> univs;
   for (auto it = _universes.begin(); it != _universes.end(); ++it)
     univs.push_back(*(it->second.get()));
   return univs;
 }

◆ getRoot()

const CSGUniverse& CSG::CSGUniverseList::getRoot ( ) const

inlineprotected

Get the root universe.

Returns: reference to the root universe

Definition at line 92 of file CSGUniverseList.h.

Referenced by CSG::CSGBase::getRootUniverse(), and CSG::CSGBase::renameRootUniverse().

92 { return *_root_universe; };

CSG::CSGUniverseList::_root_universe

const CSGUniverse * _root_universe

root universe for the CSGBase instance

Definition: CSGUniverseList.h:121

◆ getUniverse()

CSGUniverse & CSG::CSGUniverseList::getUniverse ( const std::string & name ) const

protected

Get a Universe from the list by its name.

Parameters

name	name of universe

Returns: reference to CSGUniverse of the specified name

Definition at line 25 of file CSGUniverseList.C.

Referenced by CSG::CSGBase::addCellToUniverse(), CSG::CSGBase::addUniverseToList(), CSG::CSGBase::checkUniverseInBase(), CSG::CSGBase::getUniverseByName(), operator==(), and CSG::CSGBase::removeCellFromUniverse().

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

◆ getUniverseListMap() [1/2]

std::unordered_map<std::string, std::unique_ptr<CSGUniverse> >& CSG::CSGUniverseList::getUniverseListMap ( )

inlineprotected

Get non-const map of all names to universes in universe list.

Returns: map of all names to CSGUniverse pointers

Definition at line 57 of file CSGUniverseList.h.

Referenced by CSG::CSGBase::CSGBase(), and CSG::CSGBase::joinUniverseList().

   {
     return _universes;
   }

◆ getUniverseListMap() [2/2]

const std::unordered_map<std::string, std::unique_ptr<CSGUniverse> >& CSG::CSGUniverseList::getUniverseListMap ( ) const

inlineprotected

Get const map of all names to universes in universe list.

Returns: map of all names to CSGUniverse pointers

Definition at line 67 of file CSGUniverseList.h.

   {
     return _universes;
   }

◆ hasUniverse()

bool CSG::CSGUniverseList::hasUniverse ( const std::string & name ) const

inlineprotected

return whether universe with given name exists in universe list

Parameters

name	name of universe

Returns: true if universe name exists, false otherwise

Definition at line 47 of file CSGUniverseList.h.

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

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

◆ operator!=()

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

protected

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

Definition at line 101 of file CSGUniverseList.C.

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

◆ operator==()

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

protected

Operator overload for checking if two CSGUniverseList objects are equal.

Definition at line 77 of file CSGUniverseList.C.

 {
   const auto all_univs = this->getAllUniverses();
   const auto other_univs = other.getAllUniverses();
 
   // Check that same number of universes are defined in both lists
   if (all_univs.size() != other_univs.size())
     return false;
 
   // Iterate through each CSGUniverse in list and check equality of universe
   // with other list
   for (const auto & univ : all_univs)
   {
     const auto & univ_name = univ.get().getName();
     if (!other.hasUniverse(univ_name))
       return false;
     const auto & other_univ = other.getUniverse(univ_name);
     if (univ.get() != other_univ)
       return false;
   }
   return true;
 }

◆ renameUniverse()

void CSG::CSGUniverseList::renameUniverse	(	const CSGUniverse &	universe,
		const std::string &	name
	)

protected

rename the specified universe

Parameters

universe	reference to universe whose name should be renamed
name	new name

Definition at line 60 of file CSGUniverseList.C.

Referenced by CSG::CSGBase::renameRootUniverse(), and CSG::CSGBase::renameUniverse().

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

Friends And Related Function Documentation

◆ CSGBase

friend class CSGBase

friend

Definition at line 124 of file CSGUniverseList.h.

Member Data Documentation

◆ _root_universe

const CSGUniverse* CSG::CSGUniverseList::_root_universe

protected

root universe for the CSGBase instance

Definition at line 121 of file CSGUniverseList.h.

Referenced by CSGUniverseList(), and getRoot().

◆ _universes

std::unordered_map<std::string, std::unique_ptr<CSGUniverse> > CSG::CSGUniverseList::_universes

protected

Mapping of universe names to pointers of stored universe objects.

Definition at line 118 of file CSGUniverseList.h.

Referenced by addUniverse(), CSGUniverseList(), getAllUniverses(), getUniverse(), getUniverseListMap(), hasUniverse(), and renameUniverse().

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

include/csg/CSGUniverseList.h
src/csg/CSGUniverseList.C

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CSGUniverseList()

◆ ~CSGUniverseList()

Member Function Documentation

◆ addUniverse() [1/2]

◆ addUniverse() [2/2]

◆ getAllUniverses()

◆ getRoot()

◆ getUniverse()

◆ getUniverseListMap() [1/2]

◆ getUniverseListMap() [2/2]

◆ hasUniverse()

◆ operator!=()

◆ operator==()

◆ renameUniverse()

Friends And Related Function Documentation

◆ CSGBase

Member Data Documentation

◆ _root_universe

◆ _universes