CSG::CSGLatticeList Class Reference

CSGLatticeList creates a container for CSGLattice objects to pass to CSGBase. More...

#include <CSGLatticeList.h>

Protected Member Functions
	CSGLatticeList ()
	Default constructor. More...
virtual	~CSGLatticeList ()=default
	Destructor. More...
CSGLattice &	addLattice (std::unique_ptr< CSGLattice > lattice, const bool ignore_identical_lattice=false)
	add an existing lattice to list. More...
bool	hasLattice (const std::string &name) const
	return whether lattice with given name exists in lattice list More...
std::unordered_map< std::string, std::unique_ptr< CSGLattice > > &	getLatticeListMap ()
	Get map of all names to lattices in lattice list. More...
const std::unordered_map< std::string, std::unique_ptr< CSGLattice > > &	getLatticeListMap () const
	Get const map of all names to lattices in lattice list. More...
std::vector< std::reference_wrapper< const CSGLattice > >	getAllLattices () const
	Get all the lattices in CSGBase instance. More...
CSGLattice &	getLattice (const std::string &name) const
	Get a Lattice from the list by its name. More...
void	renameLattice (const CSGLattice &lattice, const std::string &name)
	rename the specified lattice More...
bool	operator== (const CSGLatticeList &other) const
	Operator overload for checking if two CSGLatticeList objects are equal. More...
bool	operator!= (const CSGLatticeList &other) const
	Operator overload for checking if two CSGLatticeList objects are not equal. More...

Protected Attributes
std::unordered_map< std::string, std::unique_ptr< CSGLattice > >	_lattices
	Mapping of lattice names to pointers of stored lattice objects. More...

Friends
class	CSGBase

Detailed Description

CSGLatticeList creates a container for CSGLattice objects to pass to CSGBase.

Definition at line 20 of file CSGLatticeList.h.

Constructor & Destructor Documentation

CSGLatticeList()

CSG::CSGLatticeList::CSGLatticeList ( )

protected

Default constructor.

Definition at line 15 of file CSGLatticeList.C.

{}

~CSGLatticeList()

virtual CSG::CSGLatticeList::~CSGLatticeList ( )

protectedvirtualdefault

Destructor.

Member Function Documentation

addLattice()

CSGLattice & CSG::CSGLatticeList::addLattice ( std::unique_ptr< CSGLattice >  lattice, const bool  ignore_identical_lattice = false  )

protected

add an existing lattice to list.

Ownership of lattice will be transferred to CSGLatticeList object that calls this function

Parameters

lattice	pointer to lattice to add
ignore_identical_lattice	skip adding lattice if an identical lattice exists in lattice list

Returns

reference to CSGLattice that is passed in

Definition at line 37 of file CSGLatticeList.C.

Referenced by CSG::CSGBase::addLattice(), CSG::CSGBase::joinLatticeList(), and renameLattice().

{
  auto lattice_name = lattice->getName();
  if (ignore_identical_lattice)
    // Check that lattice already defined in _lattice and if so, confirm it matches with input lat
    if (auto it = _lattices.find(lattice_name); it != _lattices.end())
    {
      if (*lattice == *it->second)
        return *it->second;
      else
        mooseError("Lattice with name ",
                   lattice_name,
                   " has the same name as an existing lattice in CSGBase instance but cannot be "
                   "discarded as it is not an identical lattice.");
    }

  // Otherwise, add the lattice to the lattice list. At this point, we don't expect the lattice
  // to already be defined in the lattice list
  auto [it, inserted] = _lattices.emplace(lattice_name, std::move(lattice));
  if (!inserted)
    mooseError("Lattice with name " + lattice_name + " already exists in geometry.");
  return *it->second;
}

getAllLattices()

std::vector< std::reference_wrapper< const CSGLattice > > CSG::CSGLatticeList::getAllLattices ( ) const

protected

Get all the lattices in CSGBase instance.

Returns

list of references to all CSGLattice objects

Definition at line 28 of file CSGLatticeList.C.

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

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

getLattice()

CSGLattice & CSG::CSGLatticeList::getLattice ( const std::string &  name ) const

protected

Get a Lattice from the list by its name.

Parameters

name	name of lattice

Returns

reference to CSGLattice of the specified name

Definition at line 18 of file CSGLatticeList.C.

Referenced by CSG::CSGBase::addLatticeToList(), CSG::CSGBase::addTransformation(), CSG::CSGBase::checkLatticeInBase(), CSG::CSGBase::getLatticeByName(), operator==(), CSG::CSGBase::resetLatticeOuter(), CSG::CSGBase::setLatticeOuter(), CSG::CSGBase::setLatticeUniverses(), and CSG::CSGBase::setUniverseAtLatticeIndex().

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

getLatticeListMap() [1/2]

std::unordered_map<std::string, std::unique_ptr<CSGLattice> >& CSG::CSGLatticeList::getLatticeListMap ( )

inlineprotected

Get map of all names to lattices in lattice list.

Returns

map of all names to CSGLattice pointers

Definition at line 61 of file CSGLatticeList.h.

Referenced by CSG::CSGBase::CSGBase(), CSG::CSGBase::deleteLattice(), CSG::CSGBase::joinLatticeList(), CSG::CSGBase::replaceUniverseRefsByName(), and CSG::CSGBase::updateIncomingCSGReferences().

  {
    return _lattices;
  }

getLatticeListMap() [2/2]

const std::unordered_map<std::string, std::unique_ptr<CSGLattice> >& CSG::CSGLatticeList::getLatticeListMap ( ) const

inlineprotected

Get const map of all names to lattices in lattice list.

Returns

map of all names to CSGLattice pointers

Definition at line 71 of file CSGLatticeList.h.

  {
    return _lattices;
  }

hasLattice()

bool CSG::CSGLatticeList::hasLattice ( const std::string &  name ) const

inlineprotected

return whether lattice with given name exists in lattice list

Parameters

name	name of the lattice

Returns

true if lattice name exists, otherwise false

Definition at line 51 of file CSGLatticeList.h.

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

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

operator!=()

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

protected

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

Definition at line 102 of file CSGLatticeList.C.

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

operator==()

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

protected

Operator overload for checking if two CSGLatticeList objects are equal.

Definition at line 78 of file CSGLatticeList.C.

{
  const auto all_lats = this->getAllLattices();
  const auto other_lats = other.getAllLattices();

  // Check that same number of lattices are defined in both lists
  if (all_lats.size() != other_lats.size())
    return false;

  // Iterate through each CSGLattices in list and check equality of each cell
  // with other list
  for (const auto & lat : all_lats)
  {
    const auto & lat_name = lat.get().getName();
    if (!other.hasLattice(lat_name))
      return false;
    const auto & other_lat = other.getLattice(lat_name);
    if (lat.get() != other_lat)
      return false;
  }
  return true;
}

renameLattice()

void CSG::CSGLatticeList::renameLattice ( const CSGLattice &  lattice, const std::string &  name  )

protected

rename the specified lattice

Parameters

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

Definition at line 62 of file CSGLatticeList.C.

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

{
  // check that this lattice passed in is actually in the same lattice that is in the lattice list
  auto prev_name = lattice.getName();
  auto it = _lattices.find(prev_name);
  if (it == _lattices.end() || it->second.get() != &lattice)
    mooseError("Lattice " + prev_name + " cannot be renamed to " + name +
               " as it does not exist in this CSGBase instance.");

  auto existing_lat = std::move(it->second);
  existing_lat->setName(name);
  _lattices.erase(prev_name);
  addLattice(std::move(existing_lat));
}

Friends And Related Function Documentation

CSGBase

friend class CSGBase

friend

Definition at line 109 of file CSGLatticeList.h.

Member Data Documentation

_lattices

std::unordered_map<std::string, std::unique_ptr<CSGLattice> > CSG::CSGLatticeList::_lattices

protected

Mapping of lattice names to pointers of stored lattice objects.

Definition at line 106 of file CSGLatticeList.h.

Referenced by addLattice(), getAllLattices(), getLattice(), getLatticeListMap(), hasLattice(), and renameLattice().

---

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

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