PinUniverseEngUnit is a CSGUniverseEngUnit that represents a 2D pin universe (concentric cylinders surrounded by an outer region) using basic engineering-scale attrbutes, including ring radii and fill material names for each radial region of the pin structure. More...

#include <PinUniverseEngUnit.h>

Inheritance diagram for CSG::PinUniverseEngUnit:

[legend]

Public Member Functions
	PinUniverseEngUnit (const std::string &name, const std::vector< Real > &ring_radii, const std::vector< std::string > &fill_mats)
	Constructor for PinUniverseEngUnit.

std::unordered_map< std::string, AttributeVariant >	getAttributes () const override
	Return the pin engineering unit attributes for this object.

const std::string &	getName () const override

bool	isEngUnit () const override

bool	operator== (const CSGUniverseEngUnit &other) const

bool	operator== (const CSGUniverse &other) const

bool	operator== (const CSGEngUnit &other) const

bool	operator!= (const CSGUniverseEngUnit &other) const

bool	operator!= (const CSGUniverse &other) const

bool	operator!= (const CSGEngUnit &other) const

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

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

const CSGCell &	getCell (const std::string &name)

bool	hasCell (const std::string &name) const

const std::vector< std::reference_wrapper< const CSGCell > > &	getAllCells () const

bool	isRoot () const

const std::string	getBehavior () const

const std::string	getUnitType () const

Static Public Member Functions
static bool	isValidTransformationValue (TransformationType type, const std::tuple< Real, Real, Real > &values)

static std::string	getTransformationTypeString (TransformationType type)

Protected Member Functions
std::unique_ptr< CSGUniverseEngUnit >	clone () const override
	Return a deep copy of this unit.

void	expandUnit () override
	Represent the pin cell as a single universe that contains cells that define each region of the pin cell structure.

const CSGUniverse &	getExpandedUniverse () const

void	removeCell (const std::string &name)

void	removeAllCells ()

void	setName (const std::string &name)

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

Point	applyReverseTransformsToPoint (Point p) const

CSGBase &	getBase ()

std::unique_ptr< CSGBase >	releaseBase ()

void	addCell (const CSGCell &)=delete

void	addCell (const CSGCell &)=delete

	FRIEND_TEST (CSGUniverseTest, testGetCell)

	FRIEND_TEST (CSGUniverseTest, testAddCell)

	FRIEND_TEST (CSGUniverseTest, testRemoveCell)

	FRIEND_TEST (CSGUniverseTest, testRemoveAllCells)

	FRIEND_TEST (CSGUniverseTest, testSetName)

	FRIEND_TEST (CSGUniverseTest, testUniverseEquality)

	FRIEND_TEST (CSGSurfaceTest, testHalfspaceWithTransform)

	FRIEND_TEST (CSGSurfaceTest, testHalfspaceWithNullTransform)

	FRIEND_TEST (CSGEngUnitTest, testEngUnitEqual)

	FRIEND_TEST (CSGUniverseTest, testGetCell)

	FRIEND_TEST (CSGUniverseTest, testAddCell)

	FRIEND_TEST (CSGUniverseTest, testRemoveCell)

	FRIEND_TEST (CSGUniverseTest, testRemoveAllCells)

	FRIEND_TEST (CSGUniverseTest, testSetName)

	FRIEND_TEST (CSGUniverseTest, testUniverseEquality)

	FRIEND_TEST (CSGSurfaceTest, testHalfspaceWithTransform)

	FRIEND_TEST (CSGSurfaceTest, testHalfspaceWithNullTransform)

	FRIEND_TEST (CSGEngUnitTest, testEngUnitEqual)

Protected Attributes
std::string	_name

std::vector< std::reference_wrapper< const CSGCell > >	_cells

bool	_is_root

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

std::unique_ptr< CSGBase >	_internal_base

MooseEnum	_behavior

Private Attributes
const std::vector< Real >	_ring_radii
	List of ring radii of pin cell.

std::vector< std::string >	_fill_mats
	Region IDs of pin cell.

Detailed Description

PinUniverseEngUnit is a CSGUniverseEngUnit that represents a 2D pin universe (concentric cylinders surrounded by an outer region) using basic engineering-scale attrbutes, including ring radii and fill material names for each radial region of the pin structure.

Implements:

expandUnit(): creates a universe that represents the pin cell structure
clone(): returns a deep copy of the pin engineering unit
getAttributes(): returns ring_radii, fill_mats, and geometry_type

Definition at line 29 of file PinUniverseEngUnit.h.

Constructor & Destructor Documentation

◆ PinUniverseEngUnit()

CSG::PinUniverseEngUnit::PinUniverseEngUnit	(	const std::string &	name,
		const std::vector< Real > &	ring_radii,
		const std::vector< std::string > &	fill_mats
	)

Constructor for PinUniverseEngUnit.

Parameters

name	unique name of the unit
ring_radii	list of ring radii of cylindrical pin regions, which need to be in ascending order
fill_mats	Vector of material names that represent the fill of each radial region

Note: The number of fill material names should be one larger than the number of ring radii in the pin. The extra material name represents the material fill that surrounds the region outside of the outermost ring.

Definition at line 17 of file PinUniverseEngUnit.C.

  : CSGUniverseEngUnit(name), _ring_radii(ring_radii), _fill_mats(fill_mats)
{
  unsigned int n_radial = _ring_radii.size();
 
  if (n_radial == 0)
    mooseError("Pin universe engineering unit must have at least one ring radius defined");
 
  // Check radii in ascending order
  if (n_radial > 1)
    for (const auto i : make_range(_ring_radii.size() - 1))
      if (_ring_radii[i] >= _ring_radii[i + 1])
        mooseError("Pin engineering unit must have ring radii defined in strictly ascending order");
 
  if (_fill_mats.size() != n_radial + 1)
    mooseError("Size of region IDs must be one more than the number of radial rings in pin");
}

Member Function Documentation

◆ clone()

std::unique_ptr< CSGUniverseEngUnit > CSG::PinUniverseEngUnit::clone ( ) const

overrideprotectedvirtual

Return a deep copy of this unit.

Returns: unique_ptr to a new PinUniverseEngUnit with identical parameters

Implements CSG::CSGUniverseEngUnit.

Definition at line 44 of file PinUniverseEngUnit.C.

{
  return std::make_unique<PinUniverseEngUnit>(_name, _ring_radii, _fill_mats);
}

◆ expandUnit()

void CSG::PinUniverseEngUnit::expandUnit ( )

overrideprotectedvirtual

Represent the pin cell as a single universe that contains cells that define each region of the pin cell structure.

Implements CSG::CSGUniverseEngUnit.

Definition at line 50 of file PinUniverseEngUnit.C.

{
  CSG::CSGRegion inner_region, outer_region, cell_region;
 
  // Add surfaces and regions for each pin ring
  // Iterate through all rings and define all corresponding surfaces, regions, and cells
  for (const auto i : index_range(_fill_mats))
  {
    const bool build_ring_surf = i < _ring_radii.size();
    if (build_ring_surf)
    {
      // Add surfaces corresponding to pin rings
      const auto & radius = _ring_radii[i];
      const auto surf_name = _name + "_radial_ring_" + std::to_string(i);
      std::unique_ptr<CSG::CSGSurface> ring_surf_ptr =
          std::make_unique<CSG::CSGZCylinder>(surf_name, 0, 0, radius);
      const auto & ring_surf = _internal_base->addSurface(std::move(ring_surf_ptr));
 
      // Define radial region for each incremental radial ring
      if (inner_region.getRegionType() == CSG::CSGRegion::RegionType::EMPTY)
      {
        // We are in the innermost radial region, the radial region is inner_region
        inner_region = CSGUtils::getInnerRegion({ring_surf}, Point(0, 0, 0));
        cell_region = inner_region;
      }
      else
      {
        // For all other regions, the radial region is the intersection of inner_region and
        // outer_region
        outer_region = ~inner_region;
        inner_region = CSGUtils::getInnerRegion({ring_surf}, Point(0, 0, 0));
        cell_region = inner_region & outer_region;
      }
    }
    else
      cell_region = ~inner_region;
 
    // Define all cells within pin domain
    auto cell_name = _name + "_cell_radial_" + std::to_string(i);
    const auto fill_mat = _fill_mats[i];
    _internal_base->createCell(cell_name, fill_mat, cell_region);
  }
}

◆ getAttributes()

std::unordered_map< std::string, AttributeVariant > CSG::PinUniverseEngUnit::getAttributes ( ) const

overridevirtual

Return the pin engineering unit attributes for this object.

Returns: map containing: ring_radii (std::vector<Real>) and fill_mats (std::vector<std::string>)

Implements CSG::CSGUniverseEngUnit.

Definition at line 38 of file PinUniverseEngUnit.C.

{
  return {{"ring_radii", _ring_radii}, {"fill_mats", _fill_mats}};
}

Member Data Documentation

◆ _fill_mats

std::vector<std::string> CSG::PinUniverseEngUnit::_fill_mats

private

Region IDs of pin cell.

Definition at line 74 of file PinUniverseEngUnit.h.

Referenced by clone(), expandUnit(), getAttributes(), and PinUniverseEngUnit().

◆ _ring_radii

const std::vector<Real> CSG::PinUniverseEngUnit::_ring_radii

private

List of ring radii of pin cell.

Definition at line 71 of file PinUniverseEngUnit.h.

Referenced by clone(), expandUnit(), getAttributes(), and PinUniverseEngUnit().

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

reactor/include/csg/PinUniverseEngUnit.h
reactor/src/csg/PinUniverseEngUnit.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PinUniverseEngUnit()

Member Function Documentation

◆ clone()

◆ expandUnit()

◆ getAttributes()

Member Data Documentation

◆ _fill_mats

◆ _ring_radii