CSG::CSGCartesianLattice Class Reference

CSGCartesianLattice is the class for constructing regular Cartesian lattices of CSGUniverses. More...

#include <CSGCartesianLattice.h>

Inheritance diagram for CSG::CSGCartesianLattice:

Public Member Functions
	CSGCartesianLattice (const std::string &name, const Real pitch, std::vector< std::vector< std::reference_wrapper< const CSGUniverse >>> universes, const std::optional< OuterVariant > &outer=std::nullopt)
	Construct a new CSGCartesianLattice object from the map of universes provided. More...
	CSGCartesianLattice (const std::string &name, const Real pitch, const std::optional< OuterVariant > &outer=std::nullopt)
	Construct a new empty CSGCartesianLattice object with specified pitch. More...
virtual	~CSGCartesianLattice ()=default
	Destructor. More...
std::unique_ptr< CSGLattice >	clone () const override
	clone this Cartesian lattice More...
virtual std::unordered_map< std::string, AttributeVariant >	getAttributes () const override
	Get attributes that define the lattice (excluding the universe map). More...
virtual bool	isValidIndex (const std::pair< int, int > index) const override
	Checks if the given index location (row, column) is a valid index for the lattice. More...
virtual bool	isValidUniverseMap (std::vector< std::vector< std::reference_wrapper< const CSGUniverse >>> universes) const override
	check that any provided list of list of CSGUniverses are the correct dimensions. More...
unsigned int	getNRows () const
	get the number of rows More...
unsigned int	getNCols () const
	get number of columns More...
Real	getPitch () const
	get lattice pitch More...
void	setPitch (Real pitch)
	set the pitch of the lattice More...
const std::string &	getName () const
	Get the name of lattice. More...
const std::string &	getType () const
	Get the lattice type. More...
const std::string	getOuterType () const
	Get the type of outer that fills the space around the lattice elements. More...
const CSGUniverse &	getOuterUniverse () const
	Get the outer universe if outer type is UNIVERSE. More...
const std::string &	getOuterMaterial () const
	Get the outer material name if outer fype is CSG_MATERIAL. More...
std::vector< std::vector< std::reference_wrapper< const CSGUniverse > > >	getUniverses () const
	Get the arrangement of CSGUniverses in the lattice. More...
const std::vector< std::vector< std::string > >	getUniverseNameMap () const
	Get the arrangement of CSGUniverses in the lattice as their names. More...
bool	hasUniverse (const std::string &name) const
	whether or not the universe of the specified name exists in the lattice More...
const CSGUniverse &	getUniverseAtIndex (const std::pair< int, int > index)
	Get the universe located at the given index. More...
const std::vector< std::pair< unsigned int, unsigned int > >	getUniverseIndices (const std::string &univ_name) const
	get all locations in lattice where universe of the specified name exists More...
void	resetOuter ()
	reset the outer fill around the lattice elements to be VOID More...
const std::vector< std::reference_wrapper< const CSGUniverse > >	getUniqueUniverses () const
	Get the list of unique universe objects in the lattice. More...
bool	operator== (const CSGLattice &other) const
	Operator overload for checking if two CSGLattice objects are equal. More...
bool	operator!= (const CSGLattice &other) const
	Operator overload for checking if two CSGLattice 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
virtual bool	compareAttributes (const CSGLattice &other) const override
	compare the attributes returned in getAttributes of this lattice to another lattice More...
virtual void	setUniverses (std::vector< std::vector< std::reference_wrapper< const CSGUniverse >>> universes) override
	set the universes that define the lattice layout More...
void	setName (const std::string &name)
void	setUniverseAtIndex (const CSGUniverse &universe, const std::pair< int, int > index)
	replace the element at specified index in the lattice with the provided CSGUniverse. More...
void	updateOuter (const std::string &outer_name)
	Update the outer of the lattice to be the provided material name. More...
void	updateOuter (const CSGUniverse &outer_universe)
	Update the outer of the lattice to be the provided universe. More...
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 (CSGLatticeTest, testCartSetUniverses)
	Friends for unit testing. More...
	FRIEND_TEST (CSGLatticeTest, testCartSetUniverseAtIndex)
	FRIEND_TEST (CSGLatticeTest, testEmptyToFilled)
	FRIEND_TEST (CSGLatticeTest, testCartLatticeEquality)
	FRIEND_TEST (CSGLatticeTest, testSetName)
	Friends for unit testing. More...
	FRIEND_TEST (CSGLatticeTest, testUpdateOuter)
	FRIEND_TEST (CSGBaseTest, testAddLattice)
	FRIEND_TEST (CSGSurfaceTest, testHalfspaceWithTransform)
	Friends for unit testing. More...
	FRIEND_TEST (CSGSurfaceTest, testHalfspaceWithNullTransform)

Protected Attributes
Real	_pitch
	pitch More...
unsigned int	_nrow
	number of elements in the first dimension (rows) More...
unsigned int	_ncol
	number of elements in the second direction (columns) More...
std::string	_name
	Name of lattice. More...
const std::string	_lattice_type
	Type of lattice. More...
std::vector< std::vector< std::reference_wrapper< const CSGUniverse > > >	_universe_map
	Universes in the arrangement of how they appear in the lattice; dimensions depends on lattice type. More...
std::string	_outer_type
	An enum for type of outer fill for lattice. More...
std::string	_outer_material
	name of the outer material More...
const CSGUniverse *	_outer_universe
	outer object if fill is CSGUniverse More...
std::vector< std::pair< TransformationType, std::tuple< Real, Real, Real > > >	_transformations
	List of transformations applied to this object. More...

Friends
class	CSGBase

Detailed Description

CSGCartesianLattice is the class for constructing regular Cartesian lattices of CSGUniverses.

Definition at line 24 of file CSGCartesianLattice.h.

Constructor & Destructor Documentation

CSGCartesianLattice() [1/2]

CSG::CSGCartesianLattice::CSGCartesianLattice	(	const std::string &	name,
		const Real	pitch,
		std::vector< std::vector< std::reference_wrapper< const CSGUniverse >>>	universes,
		const std::optional< OuterVariant > &	outer = std::nullopt
	)

Construct a new CSGCartesianLattice object from the map of universes provided.

Parameters

name	unique identifying name of lattice
pitch	pitch of lattice elements
universes	list of list of universes to set as the lattice map
outer	optional outer universe or material name that fills space around lattice elements. If not provided, outer is assumed to be VOID.

Definition at line 15 of file CSGCartesianLattice.C.

  : CSGLattice(name, MooseUtils::prettyCppType<CSGCartesianLattice>(), outer), _pitch(pitch)
{
  setUniverses(universes); // this will set _nrow and _ncol
  if (_pitch < 0)
    mooseError("Lattice " + getName() + " must have pitch greater than 0.");
}

CSGCartesianLattice() [2/2]

CSG::CSGCartesianLattice::CSGCartesianLattice	(	const std::string &	name,
		const Real	pitch,
		const std::optional< OuterVariant > &	outer = std::nullopt
	)

Construct a new empty CSGCartesianLattice object with specified pitch.

NOTE: must call setLatticeUniverses to populate the universe map.

Parameters

name	unique identifying name of lattice
pitch	pitch of lattice elements
outer	optional outer universe or material name that fills space around lattice elements. If not provided, outer is assumed to be VOID.

Definition at line 27 of file CSGCartesianLattice.C.

  : CSGLattice(name, MooseUtils::prettyCppType<CSGCartesianLattice>(), outer),
    _pitch(pitch),
    _nrow(0),
    _ncol(0)
{
  if (_pitch < 0)
    mooseError("Lattice " + getName() + " must have pitch greater than 0.");
}

~CSGCartesianLattice()

virtual CSG::CSGCartesianLattice::~CSGCartesianLattice ( )

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;
}

clone()

std::unique_ptr<CSGLattice> CSG::CSGCartesianLattice::clone ( ) const

inlineoverridevirtual

clone this Cartesian lattice

Returns

std::unique_ptr<CSGLattice> unique pointer to cloned Cartesian lattice

Implements CSG::CSGLattice.

Definition at line 64 of file CSGCartesianLattice.h.

  {
    return std::make_unique<CSGCartesianLattice>(*this);
  }

compareAttributes()

bool CSG::CSGCartesianLattice::compareAttributes ( const CSGLattice &  other ) const

overrideprotectedvirtual

compare the attributes returned in getAttributes of this lattice to another lattice

Implements CSG::CSGLattice.

Definition at line 96 of file CSGCartesianLattice.C.

{
  if (other.getType() != this->getType())
    return false;

  auto this_dims = this->getAttributes();
  auto other_dims = other.getAttributes();
  if (std::get<unsigned int>(this_dims["nrow"]) != std::get<unsigned int>(other_dims["nrow"]))
    return false;
  if (std::get<unsigned int>(this_dims["ncol"]) != std::get<unsigned int>(other_dims["ncol"]))
    return false;
  if (std::get<Real>(this_dims["pitch"]) != std::get<Real>(other_dims["pitch"]))
    return false;
  return true;
}

FRIEND_TEST() [1/9]

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

protectedinherited

Friends for unit testing.

FRIEND_TEST() [2/9]

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

protectedinherited

FRIEND_TEST() [3/9]

CSG::CSGCartesianLattice::FRIEND_TEST ( CSGLatticeTest  , testCartSetUniverses    )

protected

Friends for unit testing.

FRIEND_TEST() [4/9]

CSG::CSGCartesianLattice::FRIEND_TEST ( CSGLatticeTest  , testCartSetUniverseAtIndex    )

protected

FRIEND_TEST() [5/9]

CSG::CSGCartesianLattice::FRIEND_TEST ( CSGLatticeTest  , testEmptyToFilled    )

protected

FRIEND_TEST() [6/9]

CSG::CSGCartesianLattice::FRIEND_TEST ( CSGLatticeTest  , testCartLatticeEquality    )

protected

FRIEND_TEST() [7/9]

CSG::CSGLattice::FRIEND_TEST ( CSGLatticeTest  , testSetName    )

protectedinherited

Friends for unit testing.

FRIEND_TEST() [8/9]

CSG::CSGLattice::FRIEND_TEST ( CSGLatticeTest  , testUpdateOuter    )

protectedinherited

FRIEND_TEST() [9/9]

CSG::CSGLattice::FRIEND_TEST ( CSGBaseTest  , testAddLattice    )

protectedinherited

getAttributes()

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

overridevirtual

Get attributes that define the lattice (excluding the universe map).

• nrow: number of rows (int)
• ncol: number of columns (int)
• pitch: pitch of the lattice element (Real)

Returns

map of string dimension name to value of that dimension

Implements CSG::CSGLattice.

Definition at line 48 of file CSGCartesianLattice.C.

Referenced by compareAttributes().

{
  return {{"nrow", static_cast<unsigned int>(_nrow)},
          {"ncol", static_cast<unsigned int>(_ncol)},
          {"pitch", _pitch}};
}

getName()

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

inlineinherited

Get the name of lattice.

Returns

std::string name of lattice

Definition at line 62 of file CSGLattice.h.

Referenced by CSG::CSGLatticeList::addLattice(), CSG::CSGBase::addLatticeToList(), CSG::CSGBase::addTransformation(), CSG::CSGBase::checkLatticeInBase(), CSGCartesianLattice(), CSG::CSGHexagonalLattice::CSGHexagonalLattice(), CSG::CSGBase::deleteLattice(), CSG::CSGCell::getFillName(), CSG::CSGLattice::getOuterMaterial(), CSG::CSGLattice::getOuterUniverse(), CSG::CSGHexagonalLattice::getRingIndexFromRowIndex(), CSG::CSGHexagonalLattice::getRowIndexFromRingIndex(), CSG::CSGLattice::getUniverseAtIndex(), CSG::CSGLattice::getUniverseIndices(), CSG::CSGLattice::operator==(), CSG::CSGLatticeList::renameLattice(), CSG::CSGBase::resetLatticeOuter(), CSG::CSGBase::setLatticeOuter(), CSG::CSGBase::setLatticeUniverses(), setPitch(), CSG::CSGHexagonalLattice::setPitch(), CSG::CSGLattice::setUniverseAtIndex(), CSG::CSGBase::setUniverseAtLatticeIndex(), setUniverses(), CSG::CSGHexagonalLattice::setUniverses(), and CSG::CSGBase::updateCellFill().

{ return _name; }

getNCols()

unsigned int CSG::CSGCartesianLattice::getNCols ( ) const

inline

get number of columns

Returns

number of columns

Definition at line 110 of file CSGCartesianLattice.h.

{ return _ncol; }

getNRows()

unsigned int CSG::CSGCartesianLattice::getNRows ( ) const

inline

get the number of rows

Returns

number of rows

Definition at line 103 of file CSGCartesianLattice.h.

{ return _nrow; }

getOuterMaterial()

const std::string & CSG::CSGLattice::getOuterMaterial ( ) const

inherited

Get the outer material name if outer fype is CSG_MATERIAL.

Returns

name of the CSG material fill

Definition at line 120 of file CSGLattice.C.

Referenced by CSG::CSGLattice::operator==().

{
  if (getOuterType() != "CSG_MATERIAL")
    mooseError("Lattice '" + getName() + "' has " + getOuterType() + " outer, not CSG_MATERIAL.");
  else
    return _outer_material;
}

getOuterType()

const std::string CSG::CSGLattice::getOuterType ( ) const

inlineinherited

Get the type of outer that fills the space around the lattice elements.

Returns

string of outer type: CSG_MATERIAL, UNIVERSE, or VOID

Definition at line 76 of file CSGLattice.h.

Referenced by CSG::CSGBase::addLatticeToList(), CSG::CSGLattice::getOuterMaterial(), CSG::CSGLattice::getOuterUniverse(), and CSG::CSGLattice::operator==().

{ return _outer_type; }

getOuterUniverse()

const CSGUniverse & CSG::CSGLattice::getOuterUniverse ( ) const

inherited

Get the outer universe if outer type is UNIVERSE.

Returns

Reference to CSGUniverse

Definition at line 111 of file CSGLattice.C.

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

{
  if (getOuterType() != "UNIVERSE")
    mooseError("Lattice '" + getName() + "' has " + getOuterType() + " outer, not UNIVERSE.");
  else
    return *_outer_universe;
}

getPitch()

Real CSG::CSGCartesianLattice::getPitch ( ) const

inline

get lattice pitch

Returns

pitch

Definition at line 117 of file CSGCartesianLattice.h.

{ return _pitch; }

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==(), 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);
}

getType()

const std::string& CSG::CSGLattice::getType ( ) const

inlineinherited

Get the lattice type.

Returns

std::string type of lattice

Definition at line 69 of file CSGLattice.h.

Referenced by compareAttributes(), CSG::CSGHexagonalLattice::compareAttributes(), CSG::CSGLattice::operator==(), setUniverses(), and CSG::CSGHexagonalLattice::setUniverses().

{ return _lattice_type; }

getUniqueUniverses()

const std::vector< std::reference_wrapper< const CSGUniverse > > CSG::CSGLattice::getUniqueUniverses ( ) const

inherited

Get the list of unique universe objects in the lattice.

Returns

list of references to unique CSGUniverse objects

Definition at line 93 of file CSGLattice.C.

{
  std::vector<std::reference_wrapper<const CSGUniverse>> unique_univs;
  auto all_univs = getUniverses();

  for (const auto & ulist : all_univs)
    for (const auto & u : ulist)
    {
      auto it = std::find_if(unique_univs.begin(),
                             unique_univs.end(),
                             [&u](const auto & ref) { return &ref.get() == &u.get(); });
      if (it == unique_univs.end())
        unique_univs.push_back(u);
    }
  return unique_univs;
}

getUniverseAtIndex()

const CSGUniverse & CSG::CSGLattice::getUniverseAtIndex ( const std::pair< int, int >  index )

inherited

Get the universe located at the given index.

Parameters

index

pair of ints that specify the location in lattice

Returns

universe at the specified location

Definition at line 66 of file CSGLattice.C.

{
  if (!isValidIndex(index))
    mooseError("Index (" + std::to_string(index.first) + ", " + std::to_string(index.second) +
               ") is not a valid index for lattice " + getName());
  else
    return _universe_map[index.first][index.second];
}

getUniverseIndices()

const std::vector< std::pair< unsigned int, unsigned int > > CSG::CSGLattice::getUniverseIndices ( const std::string &  univ_name ) const

inherited

get all locations in lattice where universe of the specified name exists

Parameters

univ_name

name of universe

Returns

vector of locations (pairs of ints)

Definition at line 76 of file CSGLattice.C.

{
  if (!hasUniverse(univ_name))
    mooseError("Universe " + univ_name + " does not exist in lattice " + getName());

  std::vector<std::pair<unsigned int, unsigned int>> indices;
  for (auto i : index_range(_universe_map))
    for (auto j : index_range(_universe_map[i]))
    {
      const CSGUniverse & univ = _universe_map[i][j];
      if (univ.getName() == univ_name)
        indices.push_back(std::make_pair(i, j));
    }
  return indices;
}

getUniverseNameMap()

const std::vector< std::vector< std::string > > CSG::CSGLattice::getUniverseNameMap ( ) const

inherited

Get the arrangement of CSGUniverses in the lattice as their names.

Returns

list of list of universe names

Definition at line 52 of file CSGLattice.C.

{
  std::vector<std::vector<std::string>> name_map;
  for (auto & univ_list : _universe_map)
  {
    std::vector<std::string> name_list;
    for (const CSGUniverse & univ : univ_list)
      name_list.push_back(univ.getName());
    name_map.push_back(name_list);
  }
  return name_map;
}

getUniverses()

std::vector<std::vector<std::reference_wrapper<const CSGUniverse> > > CSG::CSGLattice::getUniverses ( ) const

inlineinherited

Get the arrangement of CSGUniverses in the lattice.

Returns

list of list of universes in their lattice arrangement

Definition at line 97 of file CSGLattice.h.

Referenced by CSG::CSGBase::addLatticeToList(), CSG::CSGBase::createCell(), CSG::CSGLattice::getUniqueUniverses(), and CSG::CSGLattice::operator==().

  {
    return _universe_map;
  }

hasUniverse()

bool CSG::CSGLattice::hasUniverse ( const std::string &  name ) const

inherited

whether or not the universe of the specified name exists in the lattice

Parameters

name	of universe to search for

Returns

true if universe of that name exists in lattice

Definition at line 42 of file CSGLattice.C.

Referenced by CSG::CSGLattice::getUniverseIndices().

{
  for (auto list_univ : _universe_map)
    for (const CSGUniverse & univ : list_univ)
      if (univ.getName() == name)
        return true;
  return false; // no universe with matching name was found
}

isValidIndex()

bool CSG::CSGCartesianLattice::isValidIndex ( const std::pair< int, int >  index ) const

overridevirtual

Checks if the given index location (row, column) is a valid index for the lattice.

Allowable indices are: 0 <= row < _nrow and 0 <= column < _ncol.

Parameters

index

location in (row, column) form

Returns

true if index is valid for the lattice

Implements CSG::CSGLattice.

Definition at line 88 of file CSGCartesianLattice.C.

{
  auto row = index.first;  // must be (0 <= row < _nrow); rows
  auto col = index.second; // must be (0 <= col < _ncol); cols
  return ((0 <= row && row < (int)_nrow) && (0 <= col && col < (int)_ncol));
}

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");
  }
}

isValidUniverseMap()

bool CSG::CSGCartesianLattice::isValidUniverseMap ( std::vector< std::vector< std::reference_wrapper< const CSGUniverse >>>  universes ) const

overridevirtual

check that any provided list of list of CSGUniverses are the correct dimensions.

Must have number of lists within universes equal to _nrow. And each sublist must be size _ncol.

Parameters

universes

list of list of universes to be used to define the lattice structure

Returns

true if universe dimensions are valid

Implements CSG::CSGLattice.

Definition at line 56 of file CSGCartesianLattice.C.

Referenced by setUniverses().

{
  // need at least one row
  if (universes.size() < 1)
    return false;

  // check that each row is same size
  auto row_size = universes[0].size();
  for (auto univ_list : universes)
  {
    if (univ_list.size() != row_size)
      return false;
  }
  return true;
}

operator!=()

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

inherited

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

Definition at line 189 of file CSGLattice.C.

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

operator==()

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

inherited

Operator overload for checking if two CSGLattice objects are equal.

Definition at line 153 of file CSGLattice.C.

{
  if (this->getName() != other.getName())
    return false;
  if (this->getType() != other.getType())
    return false;
  if (this->getTransformations() != other.getTransformations())
    return false;
  if (this->getOuterType() != other.getOuterType())
    return false;
  if ((this->getOuterType() == "CSG_MATERIAL") &&
      (this->getOuterMaterial() != other.getOuterMaterial()))
    return false;
  if ((this->getOuterType() == "UNIVERSE") &&
      (this->getOuterUniverse() != other.getOuterUniverse()))
    return false;
  if (!this->compareAttributes(other))
    return false;

  const auto & this_univs = this->getUniverses();
  const auto & other_univs = other.getUniverses();
  if (this_univs.size() != other_univs.size())
    return false;
  for (unsigned int i = 0; i < this_univs.size(); ++i)
  {
    if (this_univs[i].size() != other_univs[i].size())
      return false;
    for (unsigned int j = 0; j < this_univs[i].size(); j++)
      if (this_univs[i][j].get() != other_univs[i][j].get())
        return false;
  }

  return true;
}

resetOuter()

void CSG::CSGLattice::resetOuter ( )

inherited

reset the outer fill around the lattice elements to be VOID

Definition at line 145 of file CSGLattice.C.

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

{
  _outer_type = "VOID";
  _outer_material = "";
  _outer_universe = nullptr;
}

setName()

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

inlineprotectedinherited

Definition at line 183 of file CSGLattice.h.

{ _name = name; }

setPitch()

void CSG::CSGCartesianLattice::setPitch

(

Real

pitch

)

set the pitch of the lattice

Parameters

pitch

new pitch value

Definition at line 40 of file CSGCartesianLattice.C.

{
  if (pitch < 0)
    mooseError("Lattice " + getName() + " must have pitch greater than 0.");
  _pitch = pitch;
}

setUniverseAtIndex()

void CSG::CSGLattice::setUniverseAtIndex ( const CSGUniverse &  universe, const std::pair< int, int >  index  )

protectedinherited

replace the element at specified index in the lattice with the provided CSGUniverse.

This will check that the _universe_map has been initialized and that the index is valid.

Parameters

universe	universe to add to the lattice at the location index
index	location in lattice replace with provided universe

Definition at line 30 of file CSGLattice.C.

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

{
  std::string base_msg = "Cannot set universe at location (" + std::to_string(index.first) + ", " +
                         std::to_string(index.second) + ") for lattice " + getName() + ". ";
  if (_universe_map.size() == 0)
    mooseError(base_msg + "Universe map has not been initialized.");
  if (!isValidIndex(index))
    mooseError(base_msg + "Not a valid location.");
  _universe_map[index.first][index.second] = universe;
}

setUniverses()

void CSG::CSGCartesianLattice::setUniverses ( std::vector< std::vector< std::reference_wrapper< const CSGUniverse >>>  universes )

overrideprotectedvirtual

set the universes that define the lattice layout

Parameters

universes

list of list of universes to set as the lattice map

Implements CSG::CSGLattice.

Definition at line 74 of file CSGCartesianLattice.C.

Referenced by CSGCartesianLattice().

{
  // check for valid map arrangment
  if (!isValidUniverseMap(universes))
    mooseError("Cannot set lattice " + getName() +
               " with universes. Does not have valid dimensions for lattice type " + getType());
  // set attributes based on universe map
  _nrow = universes.size();
  _ncol = universes[0].size();
  _universe_map = universes;
}

updateOuter() [1/2]

void CSG::CSGLattice::updateOuter ( const std::string &  outer_name )

protectedinherited

Update the outer of the lattice to be the provided material name.

This will change outer type to CSG_MATERIAL even if it was a different type previously.

Parameters

outer_name

name of CSG material that will fill space around lattice elements

Definition at line 137 of file CSGLattice.C.

Referenced by CSG::CSGLattice::CSGLattice(), and CSG::CSGBase::setLatticeOuter().

{
  _outer_type = "CSG_MATERIAL";
  _outer_material = outer_name;
  _outer_universe = nullptr;
}

updateOuter() [2/2]

void CSG::CSGLattice::updateOuter ( const CSGUniverse &  outer_universe )

protectedinherited

Update the outer of the lattice to be the provided universe.

This will change outer type to UNIVERSE even if it was a different type previously.

Parameters

outer_universe

pointer to outer universe that will fill space around lattice elements

Definition at line 129 of file CSGLattice.C.

{
  _outer_type = "UNIVERSE";
  _outer_universe = &outer_universe;
  _outer_material = "";
}

Friends And Related Function Documentation

CSGBase

friend class CSGBase

friend

Definition at line 147 of file CSGCartesianLattice.h.

Member Data Documentation

_lattice_type

const std::string CSG::CSGLattice::_lattice_type

protectedinherited

Type of lattice.

Definition at line 222 of file CSGLattice.h.

Referenced by CSG::CSGLattice::getType().

_name

std::string CSG::CSGLattice::_name

protectedinherited

Name of lattice.

Definition at line 219 of file CSGLattice.h.

Referenced by CSG::CSGLattice::getName(), and CSG::CSGLattice::setName().

_ncol

unsigned int CSG::CSGCartesianLattice::_ncol

protected

number of elements in the second direction (columns)

Definition at line 145 of file CSGCartesianLattice.h.

Referenced by getAttributes(), getNCols(), isValidIndex(), and setUniverses().

_nrow

unsigned int CSG::CSGCartesianLattice::_nrow

protected

number of elements in the first dimension (rows)

Definition at line 142 of file CSGCartesianLattice.h.

Referenced by getAttributes(), getNRows(), isValidIndex(), and setUniverses().

_outer_material

std::string CSG::CSGLattice::_outer_material

mutableprotectedinherited

name of the outer material

Definition at line 231 of file CSGLattice.h.

Referenced by CSG::CSGLattice::getOuterMaterial(), CSG::CSGLattice::resetOuter(), and CSG::CSGLattice::updateOuter().

_outer_type

std::string CSG::CSGLattice::_outer_type

mutableprotectedinherited

An enum for type of outer fill for lattice.

Definition at line 228 of file CSGLattice.h.

Referenced by CSG::CSGLattice::getOuterType(), CSG::CSGLattice::resetOuter(), and CSG::CSGLattice::updateOuter().

_outer_universe

const CSGUniverse* CSG::CSGLattice::_outer_universe

protectedinherited

outer object if fill is CSGUniverse

Definition at line 234 of file CSGLattice.h.

Referenced by CSG::CSGLattice::getOuterUniverse(), CSG::CSGLattice::resetOuter(), and CSG::CSGLattice::updateOuter().

_pitch

Real CSG::CSGCartesianLattice::_pitch

protected

pitch

Definition at line 139 of file CSGCartesianLattice.h.

Referenced by CSGCartesianLattice(), getAttributes(), getPitch(), and setPitch().

_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().

_universe_map

std::vector<std::vector<std::reference_wrapper<const CSGUniverse> > > CSG::CSGLattice::_universe_map

protectedinherited

Universes in the arrangement of how they appear in the lattice; dimensions depends on lattice type.

Definition at line 225 of file CSGLattice.h.

Referenced by CSG::CSGLattice::getUniverseAtIndex(), CSG::CSGLattice::getUniverseIndices(), CSG::CSGLattice::getUniverseNameMap(), CSG::CSGLattice::getUniverses(), CSG::CSGLattice::hasUniverse(), CSG::CSGLattice::setUniverseAtIndex(), setUniverses(), and CSG::CSGHexagonalLattice::setUniverses().

---

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

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