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>

Inheritance diagram for CSG::CSGUniverse:

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...
const std::vector< std::pair< TransformationType, std::tuple< Real, Real, Real > > > &	getTransformations () const
	Get the list of transformations. More...
std::vector< std::pair< std::string, std::tuple< Real, Real, Real > > >	getTransformationsAsStrings () const
	Get the transformations of this object with string representations for types. More...

Static Public Member Functions
static bool	isValidTransformationValue (TransformationType type, const std::tuple< Real, Real, Real > &values)
	Check if the transformation value is valid for the given type. More...
static std::string	getTransformationTypeString (TransformationType type)
	Get the string representation of the transformation type. 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)
void	addTransformation (TransformationType type, const std::tuple< Real, Real, Real > &values)
	Add a transformation to the list of transformations. More...
Point	applyReverseTransformsToPoint (Point p) const
	update the value of point p by applying the inverse of the list of transformations to the point More...
	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)
	FRIEND_TEST (CSGUniverseTest, testUniverseEquality)
	FRIEND_TEST (CSGSurfaceTest, testHalfspaceWithTransform)
	Friends for unit testing. More...
	FRIEND_TEST (CSGSurfaceTest, testHalfspaceWithNullTransform)

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...
std::vector< std::pair< TransformationType, std::tuple< Real, Real, Real > > >	_transformations
	List of transformations applied to this object. 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 27 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 17 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 19 of file CSGUniverse.C.

  : _name(name), _is_root(is_root)
{
  CSGUtils::checkValidCSGName(name);
  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 28 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.");
}

addTransformation()

void CSG::CSGTransformationHelper::addTransformation ( TransformationType  type, const std::tuple< Real, Real, Real > &  values  )

protectedinherited

Add a transformation to the list of transformations.

Parameters

type	The type of transformation
values	The values for the transformation

Definition at line 16 of file CSGTransformationHelper.C.

{
  if (!isValidTransformationValue(type, values))
    mooseError("Invalid transformation values provided for transformation type " +
               getTransformationTypeString(type));
  _transformations.emplace_back(type, values);
}

applyReverseTransformsToPoint()

Point CSG::CSGTransformationHelper::applyReverseTransformsToPoint ( Point  p ) const

protectedinherited

update the value of point p by applying the inverse of the list of transformations to the point

Parameters

p	point to transform

Returns

transformed point

Definition at line 74 of file CSGTransformationHelper.C.

Referenced by CSG::CSGSurface::getHalfspaceFromPoint().

{
  // iterate list of transformations in reverse and apply the inverse operation
  for (auto it = _transformations.rbegin(); it != _transformations.rend(); ++it)
  {
    auto trans_type = it->first;
    auto val = it->second;

    if (trans_type == TransformationType::TRANSLATION)
    {
      Point offset(std::get<0>(val), std::get<1>(val), std::get<2>(val));
      p -= offset;
    }
    else if (trans_type == TransformationType::SCALE)
    {
      Point scale(std::get<0>(val), std::get<1>(val), std::get<2>(val));
      for (int i = 0; i < 3; ++i)
        p(i) /= scale(i);
    }
    else if (trans_type == TransformationType::ROTATION)
    {
      // get the transpose of the original rotation matrix and apply to point p
      const auto rot_matrix = RealTensorValue::intrinsic_rotation_matrix(
          std::get<0>(val), std::get<1>(val), std::get<2>(val));
      const auto rot_transpose = rot_matrix.transpose();
      p = rot_transpose * p;
    }
    else
      mooseError("Transformation type is not recognized.");
  }
  return p;
}

FRIEND_TEST() [1/8]

CSG::CSGTransformationHelper::FRIEND_TEST ( CSGSurfaceTest  , testHalfspaceWithTransform    )

protectedinherited

Friends for unit testing.

FRIEND_TEST() [2/8]

CSG::CSGTransformationHelper::FRIEND_TEST ( CSGSurfaceTest  , testHalfspaceWithNullTransform    )

protectedinherited

FRIEND_TEST() [3/8]

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

protected

Friends for unit testing.

FRIEND_TEST() [4/8]

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

protected

FRIEND_TEST() [5/8]

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

protected

FRIEND_TEST() [6/8]

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

protected

FRIEND_TEST() [7/8]

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

protected

FRIEND_TEST() [8/8]

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

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 73 of file CSGUniverse.h.

Referenced by CSG::CSGBase::addUniverseToList(), CSG::CSGBase::CSGBase(), 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 39 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 80 of file CSGUniverse.h.

Referenced by addCell(), CSG::CSGBase::addCellToUniverse(), CSG::CSGBase::addLattice(), CSG::CSGBase::addTransformation(), CSG::CSGBase::addUniverseToList(), CSG::CSGBase::checkUniverseInBase(), CSG::CSGBase::deleteUniverse(), CSG::CSGCell::getFillName(), CSG::CSGBase::getLinkedUniverses(), CSG::CSGLattice::getUniverseIndices(), operator==(), CSG::CSGBase::removeCellFromUniverse(), CSG::CSGUniverseList::renameUniverse(), CSG::CSGBase::setLatticeOuter(), CSG::CSGBase::setUniverseAtLatticeIndex(), and CSG::CSGBase::updateCellFill().

{ return _name; }

getTransformations()

const std::vector<std::pair<TransformationType, std::tuple<Real, Real, Real> > >& CSG::CSGTransformationHelper::getTransformations ( ) const

inlineinherited

Get the list of transformations.

Returns

The list of transformations

Definition at line 47 of file CSGTransformationHelper.h.

Referenced by CSG::CSGSurface::getHalfspaceFromPoint(), operator==(), CSG::CSGSurface::operator==(), CSG::CSGCell::operator==(), and CSG::CSGLattice::operator==().

  {
    return _transformations;
  }

getTransformationsAsStrings()

std::vector< std::pair< std::string, std::tuple< Real, Real, Real > > > CSG::CSGTransformationHelper::getTransformationsAsStrings ( ) const

inherited

Get the transformations of this object with string representations for types.

Returns

Vector of transformation pairs with string representations for types

Definition at line 65 of file CSGTransformationHelper.C.

{
  std::vector<std::pair<std::string, std::tuple<Real, Real, Real>>> result;
  for (const auto & transform_pair : _transformations)
    result.emplace_back(getTransformationTypeString(transform_pair.first), transform_pair.second);
  return result;
}

getTransformationTypeString()

std::string CSG::CSGTransformationHelper::getTransformationTypeString ( TransformationType  type )

staticinherited

Get the string representation of the transformation type.

Parameters

type	The transformation type

Returns

String name of the transformation type

Definition at line 56 of file CSGTransformationHelper.C.

Referenced by CSG::CSGTransformationHelper::addTransformation(), and CSG::CSGTransformationHelper::getTransformationsAsStrings().

{
  // Set the enum to the value and convert it to string
  MooseEnum enum_copy = transformation_type_enum;
  enum_copy = static_cast<int>(type);
  return std::string(enum_copy);
}

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 50 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 87 of file CSGUniverse.h.

{ return _is_root; }

isValidTransformationValue()

bool CSG::CSGTransformationHelper::isValidTransformationValue ( TransformationType  type, const std::tuple< Real, Real, Real > &  values  )

staticinherited

Check if the transformation value is valid for the given type.

Parameters

type	The type of transformation
values	The values for the transformation

Returns

True if the values are valid for the type

Definition at line 26 of file CSGTransformationHelper.C.

Referenced by CSG::CSGTransformationHelper::addTransformation().

{
  // Additional validation specific to each transformation type could be added here
  switch (type)
  {
    case TransformationType::TRANSLATION:
      // All translation values are inherently valid
      return true;

    case TransformationType::ROTATION:
      // Rotation uses euler notation; values are angles in degrees (phi, theta, psi)
      // For consistency with TransformGenerator, there are no restrictions on the angles
      // phi: rotation around Z-axis
      // theta: rotation around new X-axis
      // psi: rotation around new Z-axis
      return true;

    case TransformationType::SCALE:
      // Scaling factors should be non-zero
      if (std::get<0>(values) == 0.0 || std::get<1>(values) == 0.0 || std::get<2>(values) == 0.0)
        return false;
      return true;

    default:
      mooseError("Unknown transformation type");
  }
}

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 73 of file CSGUniverse.C.

{
  if ((this->getName() != other.getName()) ||
      (this->getTransformations() != other.getTransformations()))
    return false;
  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;
}

removeAllCells()

void CSG::CSGUniverse::removeAllCells ( )

inlineprotected

remove all cells from the universe

Definition at line 113 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 59 of file CSGUniverse.C.

Referenced by CSG::CSGBase::deleteCell(), and 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 117 of file CSGUniverse.h.

{ _name = name; }

Friends And Related Function Documentation

CSGBase

friend class CSGBase

friend

Definition at line 132 of file CSGUniverse.h.

CSGUniverseList

friend class CSGUniverseList

friend

Definition at line 129 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 123 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 126 of file CSGUniverse.h.

Referenced by isRoot().

_name

std::string CSG::CSGUniverse::_name

protected

Name of universe.

Definition at line 120 of file CSGUniverse.h.

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

_transformations

std::vector<std::pair<TransformationType, std::tuple<Real, Real, Real> > > CSG::CSGTransformationHelper::_transformations

protectedinherited

List of transformations applied to this object.

Definition at line 92 of file CSGTransformationHelper.h.

Referenced by CSG::CSGTransformationHelper::addTransformation(), CSG::CSGTransformationHelper::applyReverseTransformsToPoint(), CSG::CSGTransformationHelper::getTransformations(), and CSG::CSGTransformationHelper::getTransformationsAsStrings().

---

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

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