CSG::CSGSurfaceList Class Reference

CSGSurfaceList is a container for storing CSGSurface objects in the CSGBase object. More...

#include <CSGSurfaceList.h>

Protected Member Functions
	CSGSurfaceList ()
	Default constructor. More...
	CSGSurfaceList (const CSGSurfaceList &other_surface_list)
	Copy constructor. More...
virtual	~CSGSurfaceList ()=default
	Destructor. More...
std::unordered_map< std::string, std::unique_ptr< CSGSurface > > &	getSurfaceListMap ()
	Get non-const map of all names to surfaces in surface list. More...
const std::unordered_map< std::string, std::unique_ptr< CSGSurface > > &	getSurfaceListMap () const
	Get const map of all names to surfaces in surface list. More...
std::vector< std::reference_wrapper< const CSGSurface > >	getAllSurfaces () const
	Get list of references to all surfaces in surface list. More...
bool	hasSurface (const std::string &name) const
	return whether surface with given name exists in surface list More...
CSGSurface &	getSurface (const std::string &name) const
	Get a surface by name. More...
CSGSurface &	addSurface (std::unique_ptr< CSGSurface > surf)
	add a surface object to existing SurfaceList. More...
void	renameSurface (const CSGSurface &surface, const std::string &name)
	rename the specified surface More...
bool	operator== (const CSGSurfaceList &other) const
	Operator overload for checking if two CSGSurfaceList objects are equal. More...
bool	operator!= (const CSGSurfaceList &other) const
	Operator overload for checking if two CSGSurfaceList objects are not equal. More...

Protected Attributes
std::unordered_map< std::string, std::unique_ptr< CSGSurface > >	_surfaces
	Mapping of surface names to pointers of stored surface objects. More...

Friends
class	CSGBase

Detailed Description

CSGSurfaceList is a container for storing CSGSurface objects in the CSGBase object.

Definition at line 20 of file CSGSurfaceList.h.

Constructor & Destructor Documentation

CSGSurfaceList() [1/2]

CSG::CSGSurfaceList::CSGSurfaceList ( )

protected

Default constructor.

Definition at line 20 of file CSGSurfaceList.C.

{}

CSGSurfaceList() [2/2]

CSG::CSGSurfaceList::CSGSurfaceList ( const CSGSurfaceList &  other_surface_list )

protected

Copy constructor.

Definition at line 22 of file CSGSurfaceList.C.

{
  for (const auto & [name, surf] : other_surface_list.getSurfaceListMap())
    _surfaces.emplace(name, surf->clone());
}

~CSGSurfaceList()

virtual CSG::CSGSurfaceList::~CSGSurfaceList ( )

protectedvirtualdefault

Destructor.

Member Function Documentation

addSurface()

CSGSurface & CSG::CSGSurfaceList::addSurface ( std::unique_ptr< CSGSurface >  surf )

protected

add a surface object to existing SurfaceList.

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

Parameters

surf	CSGSurface to add

Returns

reference to CSGSurface

Definition at line 48 of file CSGSurfaceList.C.

Referenced by CSG::CSGBase::addSurface(), CSG::CSGBase::joinSurfaceList(), and renameSurface().

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

getAllSurfaces()

std::vector< std::reference_wrapper< const CSGSurface > > CSG::CSGSurfaceList::getAllSurfaces ( ) const

protected

Get list of references to all surfaces in surface list.

Returns

list of references to surfaces

Definition at line 39 of file CSGSurfaceList.C.

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

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

getSurface()

CSGSurface & CSG::CSGSurfaceList::getSurface ( const std::string &  name ) const

protected

Get a surface by name.

Parameters

name	name of surface

Returns

reference to CSGSurface of the specified name

Definition at line 29 of file CSGSurfaceList.C.

Referenced by CSG::CSGBase::checkRegionSurfaces(), CSG::CSGBase::getSurface(), CSG::CSGBase::getSurfaceByName(), and operator==().

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

getSurfaceListMap() [1/2]

std::unordered_map<std::string, std::unique_ptr<CSGSurface> >& CSG::CSGSurfaceList::getSurfaceListMap ( )

inlineprotected

Get non-const map of all names to surfaces in surface list.

Returns

map of all names to CSGSurface pointers

Definition at line 43 of file CSGSurfaceList.h.

Referenced by CSGSurfaceList(), and CSG::CSGBase::joinSurfaceList().

  {
    return _surfaces;
  }

getSurfaceListMap() [2/2]

const std::unordered_map<std::string, std::unique_ptr<CSGSurface> >& CSG::CSGSurfaceList::getSurfaceListMap ( ) const

inlineprotected

Get const map of all names to surfaces in surface list.

Returns

map of all names to CSGSurface pointers

Definition at line 53 of file CSGSurfaceList.h.

  {
    return _surfaces;
  }

hasSurface()

bool CSG::CSGSurfaceList::hasSurface ( const std::string &  name ) const

inlineprotected

return whether surface with given name exists in surface list

Parameters

name	name of surface

Returns

true if surface name exists, false otherwise

Definition at line 71 of file CSGSurfaceList.h.

Referenced by operator==().

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

operator!=()

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

protected

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

Definition at line 98 of file CSGSurfaceList.C.

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

operator==()

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

protected

Operator overload for checking if two CSGSurfaceList objects are equal.

Definition at line 74 of file CSGSurfaceList.C.

{
  const auto all_surfs = this->getAllSurfaces();
  const auto other_surfs = other.getAllSurfaces();

  // Check that same number of surfaces are defined in both lists
  if (all_surfs.size() != other_surfs.size())
    return false;

  // Iterate through each CSGSurface in list and check equality of surface
  // with other list
  for (const auto & surf : all_surfs)
  {
    const auto & surf_name = surf.get().getName();
    if (!other.hasSurface(surf_name))
      return false;
    const auto & other_surf = other.getSurface(surf_name);
    if (surf.get() != other_surf)
      return false;
  }
  return true;
}

renameSurface()

void CSG::CSGSurfaceList::renameSurface ( const CSGSurface &  surface, const std::string &  name  )

protected

rename the specified surface

Parameters

name	new name of surface

Definition at line 58 of file CSGSurfaceList.C.

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

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

  auto existing_surface = std::move(it->second);
  existing_surface->setName(name);
  _surfaces.erase(prev_name);
  addSurface(std::move(existing_surface));
}

Friends And Related Function Documentation

CSGBase

friend class CSGBase

friend

Definition at line 112 of file CSGSurfaceList.h.

Member Data Documentation

_surfaces

std::unordered_map<std::string, std::unique_ptr<CSGSurface> > CSG::CSGSurfaceList::_surfaces

protected

Mapping of surface names to pointers of stored surface objects.

Definition at line 109 of file CSGSurfaceList.h.

Referenced by addSurface(), CSGSurfaceList(), getAllSurfaces(), getSurface(), getSurfaceListMap(), hasSurface(), and renameSurface().

---

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

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