CSGCell creates an internal representation of a Constructive Solid Geometry (CSG) cell, which represents a region of space filled by a material or void. More...

#include <CSGCell.h>

Inheritance diagram for CSG::CSGCell:

[legend]

Public Member Functions
	CSGCell (const std::string &name, const CSGRegion &region)
	Constructor for void cell. More...

	CSGCell (const std::string &name, const std::string &mat_name, const CSGRegion &region)
	Constructor for Material Cell. More...

	CSGCell (const std::string &name, const CSGUniverse *univ, const CSGRegion &region)
	Constructor for Universe Cell. More...

	CSGCell (const std::string &name, const CSGLattice *lattice, const CSGRegion &region)
	Constructor for a Lattice Cell. More...

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

const std::string	getFillType () const
	Get the type of fill for the cell. More...

const CSGUniverse &	getFillUniverse () const
	Get the cell fill if fill type is UNIVERSE. More...

const std::string &	getFillMaterial () const
	Get the cell fill material name if fill fype is CSG_MATERIAL. More...

const CSGLattice &	getFillLattice () const
	Get the cell fill if fill type is LATTICE. More...

const std::string &	getFillName () const
	Get the name of the fill, regardless of its type. More...

const std::string &	getName () const
	Get the cell name. More...

const CSGRegion &	getRegion () const
	Get the cell region. More...

void	resetCellFill ()
	Reset the cell fill to void. More...

void	updateCellFill (const std::string &mat_name)
	Set the cell fill to a material name. More...

void	updateCellFill (const CSGUniverse *univ)
	Set the cell fill to a universe. More...

void	updateCellFill (const CSGLattice *lattice)
	Set the cell fill to a lattice. More...

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

bool	operator!= (const CSGCell &other) const
	Operator overload for checking if two CSGCell 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	updateCellRegionSurfaces (std::map< std::string, std::reference_wrapper< const CSGSurface >> &identical_surface_refs)
	Update surface references of cell region based on map of input surface references. More...

void	setName (const std::string &name)

void	updateRegion (const CSGRegion &region)

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 (CSGCellTest, testSetName)
	Friends for unit testing. More...

	FRIEND_TEST (CSGCellTest, testUpdateRegion)

	FRIEND_TEST (CSGCellTest, testCellEquality)


	FRIEND_TEST (CSGSurfaceTest, testHalfspaceWithTransform)
	Friends for unit testing. More...

	FRIEND_TEST (CSGSurfaceTest, testHalfspaceWithNullTransform)

Protected Attributes
std::string	_name
	Name of surface. More...

MooseEnum	_fill_type {"VOID CSG_MATERIAL UNIVERSE LATTICE"}
	An enum for type of fill for cell region. More...

std::string	_fill_name
	name of the fill object for CSG_MATERIAL fills More...

CSGRegion	_region
	Cell region, represented as a CSGRegion object. More...

const CSGUniverse *	_fill_universe
	Fill object if fill is CSGUniverse. More...

const CSGLattice *	_fill_lattice
	Fill object if fill is CSGLattice. More...

std::vector< std::pair< TransformationType, std::tuple< Real, Real, Real > > >	_transformations
	List of transformations applied to this object. More...

Friends
class	CSGCellList

class	CSGBase

Detailed Description

CSGCell creates an internal representation of a Constructive Solid Geometry (CSG) cell, which represents a region of space filled by a material or void.

Definition at line 29 of file CSGCell.h.

Constructor & Destructor Documentation

◆ CSGCell() [1/4]

CSG::CSGCell::CSGCell	(	const std::string &	name,
		const CSGRegion &	region
	)

Constructor for void cell.

Parameters

name	name of cell
region	cell region

Definition at line 18 of file CSGCell.C.

   : _name(name), _fill_name(""), _region(region)
 {
   CSGUtils::checkValidCSGName(name);
   _fill_type = "VOID";
 }

◆ CSGCell() [2/4]

CSG::CSGCell::CSGCell	(	const std::string &	name,
		const std::string &	mat_name,
		const CSGRegion &	region
	)

Constructor for Material Cell.

Parameters

name	name of cell
mat_name	name of the CSG material (not a MOOSE material) to use as the cell fill
region	cell region

Definition at line 25 of file CSGCell.C.

   : _name(name), _fill_name(mat_name), _region(region)
 {
   CSGUtils::checkValidCSGName(name);
   _fill_type = "CSG_MATERIAL";
 }

◆ CSGCell() [3/4]

CSG::CSGCell::CSGCell	(	const std::string &	name,
		const CSGUniverse *	univ,
		const CSGRegion &	region
	)

Constructor for Universe Cell.

Parameters

name	name of cell
univ	universe to be the fill
region	cell region

Definition at line 32 of file CSGCell.C.

   : _name(name), _fill_name(""), _region(region), _fill_universe(univ)
 {
   CSGUtils::checkValidCSGName(name);
   _fill_type = "UNIVERSE";
 }

◆ CSGCell() [4/4]

CSG::CSGCell::CSGCell	(	const std::string &	name,
		const CSGLattice *	lattice,
		const CSGRegion &	region
	)

Constructor for a Lattice Cell.

Parameters

name	name of cell
lattice	lattice to be the fill
region	cell region

Definition at line 39 of file CSGCell.C.

   : _name(name), _fill_name(""), _region(region), _fill_lattice(lattice)
 {
   CSGUtils::checkValidCSGName(name);
   _fill_type = "LATTICE";
 }

◆ ~CSGCell()

virtual CSG::CSGCell::~CSGCell ( )

virtualdefault

Destructor.

Member Function Documentation

◆ 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/5]

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

protectedinherited

Friends for unit testing.

◆ FRIEND_TEST() [2/5]

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

protectedinherited

◆ FRIEND_TEST() [3/5]

CSG::CSGCell::FRIEND_TEST	(	CSGCellTest	,
		testSetName
	)

protected

Friends for unit testing.

◆ FRIEND_TEST() [4/5]

CSG::CSGCell::FRIEND_TEST	(	CSGCellTest	,
		testUpdateRegion
	)

protected

◆ FRIEND_TEST() [5/5]

CSG::CSGCell::FRIEND_TEST	(	CSGCellTest	,
		testCellEquality
	)

protected

◆ getFillLattice()

const CSGLattice & CSG::CSGCell::getFillLattice ( ) const

Get the cell fill if fill type is LATTICE.

Returns: Reference to CSGLattice fill

Definition at line 76 of file CSGCell.C.

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

 {
   if (getFillType() != "LATTICE")
     mooseError("Cell '" + getName() + "' has " + getFillType() + " fill, not LATTICE.");
   else
     return *_fill_lattice;
 }

◆ getFillMaterial()

const std::string & CSG::CSGCell::getFillMaterial ( ) const

Get the cell fill material name if fill fype is CSG_MATERIAL.

Returns: name of the cell's CSG material fill

Definition at line 67 of file CSGCell.C.

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

 {
   if (getFillType() != "CSG_MATERIAL")
     mooseError("Cell '" + getName() + "' has " + getFillType() + " fill, not CSG_MATERIAL.");
   else
     return _fill_name;
 }

◆ getFillName()

const std::string & CSG::CSGCell::getFillName ( ) const

Get the name of the fill, regardless of its type.

Returns: std::string fill name

Definition at line 47 of file CSGCell.C.

Referenced by operator==().

 {
   if (getFillType() == "UNIVERSE")
     return _fill_universe->getName();
   else if (getFillType() == "LATTICE")
     return _fill_lattice->getName();
   else
     return _fill_name;
 }

◆ getFillType()

const std::string CSG::CSGCell::getFillType ( ) const

inline

Get the type of fill for the cell.

Returns: fill type

Definition at line 77 of file CSGCell.h.

Referenced by CSG::CSGBase::addCellToList(), getFillLattice(), getFillMaterial(), getFillName(), getFillUniverse(), and operator==().

77 { return _fill_type; }

CSG::CSGCell::_fill_type

MooseEnum _fill_type

An enum for type of fill for cell region.

Definition: CSGCell.h:176

◆ getFillUniverse()

const CSGUniverse & CSG::CSGCell::getFillUniverse ( ) const

Get the cell fill if fill type is UNIVERSE.

Returns: Reference to CSGUniverse fill

Definition at line 58 of file CSGCell.C.

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

 {
   if (getFillType() != "UNIVERSE")
     mooseError("Cell '" + getName() + "' has " + getFillType() + " fill, not UNIVERSE.");
   else
     return *_fill_universe;
 }

◆ getName()

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

inline

Get the cell name.

Returns: const std::string cell name

Definition at line 112 of file CSGCell.h.

Referenced by CSG::CSGUniverse::addCell(), CSG::CSGCellList::addCell(), CSG::CSGBase::addCellToList(), CSG::CSGBase::addCellToUniverse(), CSG::CSGBase::addTransformation(), CSG::CSGBase::checkCellInBase(), CSG::CSGBase::deleteCell(), getFillLattice(), getFillMaterial(), getFillUniverse(), operator==(), CSG::CSGBase::removeCellFromUniverse(), CSG::CSGCellList::renameCell(), CSG::CSGBase::resetCellFill(), CSG::CSGBase::updateCellFill(), and CSG::CSGBase::updateCellRegion().

112 { return _name; }

CSG::CSGCell::_name

std::string _name

Name of surface.

Definition: CSGCell.h:173

◆ getRegion()

const CSGRegion& CSG::CSGCell::getRegion ( ) const

inline

Get the cell region.

Returns: const CSGRegion& region of the cell

Definition at line 119 of file CSGCell.h.

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

119 { return _region; }

CSG::CSGCell::_region

CSGRegion _region

Cell region, represented as a CSGRegion object.

Definition: CSGCell.h:182

◆ 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(), CSG::CSGUniverse::operator==(), CSG::CSGSurface::operator==(), 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);
 }

◆ 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::CSGCell::operator!= ( const CSGCell & other ) const

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

Definition at line 148 of file CSGCell.C.

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

◆ operator==()

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

Operator overload for checking if two CSGCell objects are equal.

Definition at line 125 of file CSGCell.C.

 {
   const auto name_eq = this->getName() == other.getName();
   const auto region_eq = this->getRegion() == other.getRegion();
   const auto fill_type_eq =
       (this->getFillType() == other.getFillType()) && (this->getFillName() == other.getFillName());
   const auto transformations_eq = this->getTransformations() == other.getTransformations();
   if (name_eq && region_eq && fill_type_eq && transformations_eq)
   {
     if (this->getFillType() == "CSG_MATERIAL")
       return this->getFillMaterial() == other.getFillMaterial();
     else if (this->getFillType() == "UNIVERSE")
       return this->getFillUniverse() == other.getFillUniverse();
     else if (this->getFillType() == "LATTICE")
       return this->getFillLattice() == other.getFillLattice();
     else
       return true;
   }
   else
     return false;
 }

◆ resetCellFill()

void CSG::CSGCell::resetCellFill ( )

Reset the cell fill to void.

Definition at line 85 of file CSGCell.C.

Referenced by CSG::CSGBase::resetCellFill(), and updateCellFill().

 {
   _fill_name = "";
   _fill_universe = nullptr;
   _fill_lattice = nullptr;
   _fill_type = "VOID";
 }

◆ setName()

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

inlineprotected

Definition at line 166 of file CSGCell.h.

166 { _name = name; }

name

std::string name(const ElemQuality q)

CSG::CSGCell::_name

std::string _name

Name of surface.

Definition: CSGCell.h:173

◆ updateCellFill() [1/3]

void CSG::CSGCell::updateCellFill ( const std::string & mat_name )

Set the cell fill to a material name.

Parameters

mat_name name of material fill

Definition at line 94 of file CSGCell.C.

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

 {
   resetCellFill();
   _fill_type = "CSG_MATERIAL";
   _fill_name = mat_name;
 }

◆ updateCellFill() [2/3]

void CSG::CSGCell::updateCellFill ( const CSGUniverse * univ )

Set the cell fill to a universe.

Parameters

univ	universe fill

Definition at line 102 of file CSGCell.C.

 {
   resetCellFill();
   _fill_type = "UNIVERSE";
   _fill_universe = univ;
 }

◆ updateCellFill() [3/3]

void CSG::CSGCell::updateCellFill ( const CSGLattice * lattice )

Set the cell fill to a lattice.

Parameters

lattice lattice fill

Definition at line 110 of file CSGCell.C.

 {
   resetCellFill();
   _fill_type = "LATTICE";
   _fill_lattice = lattice;
 }

◆ updateCellRegionSurfaces()

void CSG::CSGCell::updateCellRegionSurfaces ( std::map< std::string, std::reference_wrapper< const CSGSurface >> & identical_surface_refs )

protected

Update surface references of cell region based on map of input surface references.

Parameters

identical_surface_refs map of surface name to surface references that region should be defined with

Definition at line 118 of file CSGCell.C.

 {
   _region.updateSurfaceReferences(identical_surface_refs);
 }

◆ updateRegion()

void CSG::CSGCell::updateRegion ( const CSGRegion & region )

inlineprotected

Definition at line 170 of file CSGCell.h.

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

170 { _region = region; }

CSG::CSGCell::_region

CSGRegion _region

Cell region, represented as a CSGRegion object.

Definition: CSGCell.h:182

Friends And Related Function Documentation

◆ CSGBase

friend class CSGBase

friend

Definition at line 191 of file CSGCell.h.

◆ CSGCellList

friend class CSGCellList

friend

Definition at line 190 of file CSGCell.h.

Member Data Documentation

◆ _fill_lattice

const CSGLattice* CSG::CSGCell::_fill_lattice

protected

Fill object if fill is CSGLattice.

Definition at line 188 of file CSGCell.h.

Referenced by getFillLattice(), getFillName(), resetCellFill(), and updateCellFill().

◆ _fill_name

std::string CSG::CSGCell::_fill_name

protected

name of the fill object for CSG_MATERIAL fills

Definition at line 179 of file CSGCell.h.

Referenced by getFillMaterial(), getFillName(), resetCellFill(), and updateCellFill().

◆ _fill_type

MooseEnum CSG::CSGCell::_fill_type {"VOID CSG_MATERIAL UNIVERSE LATTICE"}

protected

An enum for type of fill for cell region.

Definition at line 176 of file CSGCell.h.

Referenced by CSGCell(), getFillType(), resetCellFill(), and updateCellFill().

◆ _fill_universe

const CSGUniverse* CSG::CSGCell::_fill_universe

protected

Fill object if fill is CSGUniverse.

Definition at line 185 of file CSGCell.h.

Referenced by getFillName(), getFillUniverse(), resetCellFill(), and updateCellFill().

◆ _name

std::string CSG::CSGCell::_name

protected

Name of surface.

Definition at line 173 of file CSGCell.h.

Referenced by getName(), and setName().

◆ _region

CSGRegion CSG::CSGCell::_region

protected

Cell region, represented as a CSGRegion object.

Definition at line 182 of file CSGCell.h.

Referenced by getRegion(), updateCellRegionSurfaces(), and updateRegion().

◆ _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/CSGCell.h
src/csg/CSGCell.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CSGCell() [1/4]

◆ CSGCell() [2/4]

◆ CSGCell() [3/4]

◆ CSGCell() [4/4]

◆ ~CSGCell()

Member Function Documentation

◆ addTransformation()

◆ applyReverseTransformsToPoint()

◆ FRIEND_TEST() [1/5]

◆ FRIEND_TEST() [2/5]

◆ FRIEND_TEST() [3/5]

◆ FRIEND_TEST() [4/5]

◆ FRIEND_TEST() [5/5]

◆ getFillLattice()

◆ getFillMaterial()

◆ getFillName()

◆ getFillType()

◆ getFillUniverse()

◆ getName()

◆ getRegion()

◆ getTransformations()

◆ getTransformationsAsStrings()

◆ getTransformationTypeString()

◆ isValidTransformationValue()

◆ operator!=()

◆ operator==()

◆ resetCellFill()

◆ setName()

◆ updateCellFill() [1/3]

◆ updateCellFill() [2/3]

◆ updateCellFill() [3/3]

◆ updateCellRegionSurfaces()

◆ updateRegion()

Friends And Related Function Documentation

◆ CSGBase

◆ CSGCellList

Member Data Documentation

◆ _fill_lattice

◆ _fill_name

◆ _fill_type

◆ _fill_universe

◆ _name

◆ _region

◆ _transformations