CSG::CSGRegion Class Reference

CSGRegions creates an internal representation of a CSG region, which can refer to an intersection, union, complement, or half-space. More...

#include <CSGRegion.h>

Public Types
enum	RegionType {   RegionType::EMPTY = 0, RegionType::HALFSPACE = 1, RegionType::COMPLEMENT = 2, RegionType::INTERSECTION = 3,   RegionType::UNION = 4 }
	Enum for representing region types, defined to match _region_type MooseEnum. More...

Public Member Functions
	CSGRegion ()
	Default Constructor. More...
	CSGRegion (const CSGSurface &surf, const CSGSurface::Halfspace halfspace)
	Constructor for half-space of a surface. More...
	CSGRegion (const CSGRegion &region_a, const CSGRegion &region_b, const std::string &region_type)
	Constructor for union and intersection. More...
	CSGRegion (const CSGRegion &region, const std::string &region_type)
	Constructor for complement or empty region (clear the region) More...
virtual	~CSGRegion ()=default
	Destructor. More...
const std::string &	toString () const
	gets the string representation of the region More...
RegionType	getRegionType () const
	Get the region type. More...
const std::string	getRegionTypeString () const
	Get the region type as a string. More...
const std::vector< std::reference_wrapper< const CSGSurface > > &	getSurfaces () const
	Get the list of surfaces associated with the region. More...
CSGRegion &	operator &= (const CSGRegion &other_region)
	Operator overload for &= which creates an intersection between the current region and the other_region. More...
CSGRegion &	operator|= (const CSGRegion &other_region)
	Operator overload for |= which creates a union of the current region with the other_region. More...
bool	operator== (const CSGRegion &other) const
	Operator overload for checking if two CSGRegion objects are equal. More...
bool	operator!= (const CSGRegion &other) const
	Operator overload for checking if two CSGRegion objects are not equal. More...

Protected Attributes
std::string	_region_str
	String representation of region - defaults to empty string. More...
MooseEnum	_region_type {"EMPTY=0 HALFSPACE=1 COMPLEMENT=2 INTERSECTION=3 UNION=4"}
	An enum for type of type of operation that defines region. More...
std::vector< std::reference_wrapper< const CSGSurface > >	_surfaces
	Surface list associated with the region. More...

Detailed Description

CSGRegions creates an internal representation of a CSG region, which can refer to an intersection, union, complement, or half-space.

Definition at line 21 of file CSGRegion.h.

Member Enumeration Documentation

RegionType

enum CSG::CSGRegion::RegionType

strong

Enum for representing region types, defined to match _region_type MooseEnum.

Enumerator
EMPTY
HALFSPACE
COMPLEMENT
INTERSECTION
UNION

Definition at line 25 of file CSGRegion.h.

  {
    EMPTY = 0,
    HALFSPACE = 1,
    COMPLEMENT = 2,
    INTERSECTION = 3,
    UNION = 4
  };

Constructor & Destructor Documentation

CSGRegion() [1/4]

CSG::CSGRegion::CSGRegion

(

)

Default Constructor.

Definition at line 15 of file CSGRegion.C.

Referenced by operator|=().

{
  _region_str = "";
  _region_type = "EMPTY";
}

CSGRegion() [2/4]

CSG::CSGRegion::CSGRegion	(	const CSGSurface &	surf,
		const CSGSurface::Halfspace	halfspace
	)

Constructor for half-space of a surface.

Parameters

surf	referance to surface used to define the half-space
halfspace	half-space to apply to surface (POSITIVE or NEGATIVE)

Definition at line 22 of file CSGRegion.C.

{
  _region_type = "HALFSPACE";
  _region_str = ((halfspace == CSGSurface::Halfspace::POSITIVE) ? "+" : "-") + surf.getName();
  _surfaces.push_back(surf);
}

CSGRegion() [3/4]

CSG::CSGRegion::CSGRegion	(	const CSGRegion &	region_a,
		const CSGRegion &	region_b,
		const std::string &	region_type
	)

Constructor for union and intersection.

Parameters

region_a	reference to first region to union or intersect
region_b	reference to second region to union or intersect
region_type	type of region operation (UNION or INTERSECTION)

Definition at line 30 of file CSGRegion.C.

{
  _region_type = region_type;
  if (getRegionType() != RegionType::INTERSECTION && getRegionType() != RegionType::UNION)
    mooseError("Region type " + getRegionTypeString() + " is not supported for two regions.");
  if (region_a.getRegionType() == RegionType::EMPTY ||
      region_b.getRegionType() == RegionType::EMPTY)
    mooseError("Region operation " + getRegionTypeString() +
               " cannot be performed on an empty region.");

  std::string op = (getRegionType() == RegionType::UNION) ? " | " : " & ";
  auto a_string = stripRegionString(region_a.toString(), op);
  auto b_string = stripRegionString(region_b.toString(), op);

  _region_str = "(" + a_string + op + b_string + ")";
  const auto & a_surfs = region_a.getSurfaces();
  const auto & b_surfs = region_b.getSurfaces();
  _surfaces.insert(_surfaces.end(), a_surfs.begin(), a_surfs.end());
  _surfaces.insert(_surfaces.end(), b_surfs.begin(), b_surfs.end());
}

CSGRegion() [4/4]

CSG::CSGRegion::CSGRegion	(	const CSGRegion &	region,
		const std::string &	region_type
	)

Constructor for complement or empty region (clear the region)

Parameters

region	reference to region to apply complement
region_type	type of region to apply (COMPLEMENT or EMPTY)

Definition at line 54 of file CSGRegion.C.

{
  _region_type = region_type;
  if (getRegionType() != RegionType::COMPLEMENT && getRegionType() != RegionType::EMPTY)
    mooseError("Region type " + getRegionTypeString() + " is not supported for a single region.");

  if (getRegionType() == RegionType::COMPLEMENT)
  {
    // no change to surfaces, but update string
    _region_str = "~" + region.toString();
    _surfaces = region.getSurfaces();
  }
  else if (getRegionType() == RegionType::EMPTY)
  {
    // reset the region and make it empty
    _region_str = "";
    _surfaces.clear();
  }
}

~CSGRegion()

virtual CSG::CSGRegion::~CSGRegion ( )

virtualdefault

Destructor.

Member Function Documentation

getRegionType()

RegionType CSG::CSGRegion::getRegionType ( ) const

inline

Get the region type.

Returns

region type enum

Definition at line 83 of file CSGRegion.h.

Referenced by CSGRegion(), and operator==().

{ return _region_type.getEnum<RegionType>(); }

getRegionTypeString()

const std::string CSG::CSGRegion::getRegionTypeString ( ) const

inline

Get the region type as a string.

Returns

region type string

Definition at line 90 of file CSGRegion.h.

Referenced by CSGRegion().

{ return _region_type; }

getSurfaces()

const std::vector<std::reference_wrapper<const CSGSurface> >& CSG::CSGRegion::getSurfaces ( ) const

inline

Get the list of surfaces associated with the region.

Returns

list of pointers to surfaces that define the region

Definition at line 97 of file CSGRegion.h.

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

  {
    return _surfaces;
  }

operator &=()

CSGRegion& CSG::CSGRegion::operator&=

(

const CSGRegion &

other_region

)

Operator overload for &= which creates an intersection between the current region and the other_region.

operator!=()

bool CSG::CSGRegion::operator!=

(

const CSGRegion &

other

)

const

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

Definition at line 188 of file CSGRegion.C.

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

operator==()

bool CSG::CSGRegion::operator==

(

const CSGRegion &

other

)

const

Operator overload for checking if two CSGRegion objects are equal.

Definition at line 164 of file CSGRegion.C.

{
  const bool region_type_eq = this->getRegionType() == other.getRegionType();
  const bool region_str_eq = this->toString() == other.toString();
  if (region_type_eq && region_str_eq)
  {
    const auto & all_surfs = getSurfaces();
    const auto & other_surfs = other.getSurfaces();
    const bool num_cells_eq = all_surfs.size() == other_surfs.size();
    if (num_cells_eq)
    {
      for (const auto i : index_range(all_surfs))
        if (all_surfs[i].get() != other_surfs[i].get())
          return false;
      return true;
    }
    else
      return false;
  }
  else
    return false;
}

operator|=()

CSGRegion & CSG::CSGRegion::operator|=

(

const CSGRegion &

other_region

)

Operator overload for |= which creates a union of the current region with the other_region.

Definition at line 83 of file CSGRegion.C.

{
  if (this != &other_region)
    *this = CSGRegion(*this, other_region, "UNION");
  return *this;
}

toString()

const std::string& CSG::CSGRegion::toString ( ) const

inline

gets the string representation of the region

Returns

string representation of the region

Definition at line 76 of file CSGRegion.h.

Referenced by CSGRegion(), CSG::CSGCell::getRegionAsString(), and operator==().

{ return _region_str; }

Member Data Documentation

_region_str

std::string CSG::CSGRegion::_region_str

protected

String representation of region - defaults to empty string.

Definition at line 116 of file CSGRegion.h.

Referenced by CSGRegion(), and toString().

_region_type

MooseEnum CSG::CSGRegion::_region_type {"EMPTY=0 HALFSPACE=1 COMPLEMENT=2 INTERSECTION=3 UNION=4"}

protected

An enum for type of type of operation that defines region.

Definition at line 119 of file CSGRegion.h.

Referenced by CSGRegion(), getRegionType(), and getRegionTypeString().

_surfaces

std::vector<std::reference_wrapper<const CSGSurface> > CSG::CSGRegion::_surfaces

protected

Surface list associated with the region.

Definition at line 122 of file CSGRegion.h.

Referenced by CSGRegion(), and getSurfaces().

---

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

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