CSG::CSGSurface Class Reference

CSGSurface creates an internal representation of a Constructive Solid Geometry (CSG) surface, represented as some polynomial in x, y, and z. More...

#include <CSGSurface.h>

Inheritance diagram for CSG::CSGSurface:

Public Types
enum	Halfspace { Halfspace::POSITIVE, Halfspace::NEGATIVE }
	Enum for the sign of the half-space being represented by a point and surface. More...

Public Member Functions
	CSGSurface (const std::string &name)
	Default constructor. More...
	CSGSurface (const std::string &name, const std::string &surf_type)
	Construct a new CSGSurface. More...
virtual	~CSGSurface ()=default
	Destructor. More...
const std::string &	getSurfaceType () const
	Get the Surface Type. More...
virtual std::unordered_map< std::string, Real >	getCoeffs () const =0
	Get the coefficients that define the surface. More...
virtual Real	evaluateSurfaceEquationAtPoint (const Point &p) const =0
	given a point, determine its evaluation based on the surface equation. More...
CSGSurface::Halfspace	getHalfspaceFromPoint (const Point &p) const
	given a point, determine if it is in the positive or negative half-space for the surface More...
const std::string &	getName () const
	Get the name of surface. More...
bool	operator== (const CSGSurface &other) const
	Operator overload for checking if two CSGSurface objects are equal. More...
bool	operator!= (const CSGSurface &other) const
	Operator overload for checking if two CSGSurface 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 std::unique_ptr< CSGSurface >	clone () const =0
	Create clone of current surface, to be implemented by derived class. 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 (CSGSurfaceTest, testSetName)
	Friends for unit testing. More...
	FRIEND_TEST (CSGSurfaceTest, testSurfaceEquality)
	FRIEND_TEST (CSGSurfaceTest, testHalfspaceWithTransform)
	Friends for unit testing. More...
	FRIEND_TEST (CSGSurfaceTest, testHalfspaceWithNullTransform)

Protected Attributes
std::string	_name
	Name of surface. More...
const std::string	_surface_type
	Type of surface that is being represented string is taken directly from the surface class name. More...
std::vector< std::pair< TransformationType, std::tuple< Real, Real, Real > > >	_transformations
	List of transformations applied to this object. More...

Friends
class	CSGSurfaceList
class	CSGBase

Detailed Description

CSGSurface creates an internal representation of a Constructive Solid Geometry (CSG) surface, represented as some polynomial in x, y, and z.

Definition at line 26 of file CSGSurface.h.

Member Enumeration Documentation

Halfspace

enum CSG::CSGSurface::Halfspace

strong

Enum for the sign of the half-space being represented by a point and surface.

Enumerator
POSITIVE
NEGATIVE

Definition at line 30 of file CSGSurface.h.

  {
    POSITIVE,
    NEGATIVE
  };

Constructor & Destructor Documentation

CSGSurface() [1/2]

CSG::CSGSurface::CSGSurface

(

const std::string &

name

)

Default constructor.

Parameters

name	unique name of surface

CSGSurface() [2/2]

CSG::CSGSurface::CSGSurface	(	const std::string &	name,
		const std::string &	surf_type
	)

Construct a new CSGSurface.

Parameters

name	unique name of surface
surf_type	surface type

Definition at line 16 of file CSGSurface.C.

  : _name(name), _surface_type(surf_type)
{
  CSGUtils::checkValidCSGName(name);
}

~CSGSurface()

virtual CSG::CSGSurface::~CSGSurface ( )

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

virtual std::unique_ptr<CSGSurface> CSG::CSGSurface::clone ( ) const

protectedpure virtual

Create clone of current surface, to be implemented by derived class.

Returns

unique_ptr to cloned surface

Implemented in CSG::CSGPlane, CSG::CSGSphere, CSG::CSGXCylinder, CSG::CSGYCylinder, and CSG::CSGZCylinder.

evaluateSurfaceEquationAtPoint()

virtual Real CSG::CSGSurface::evaluateSurfaceEquationAtPoint ( const Point &  p ) const

pure virtual

given a point, determine its evaluation based on the surface equation.

A positive value indicates a point that lies in the positive half-space with regards to the surface, a negative value indicates a point that lies in the negative side of the surface, and a value of 0 indicates that the point lies on the surface.

Parameters

p

point

Returns

evaluation of point based on surface equation

Implemented in CSG::CSGPlane, CSG::CSGSphere, CSG::CSGXCylinder, CSG::CSGYCylinder, and CSG::CSGZCylinder.

Referenced by getHalfspaceFromPoint().

FRIEND_TEST() [1/4]

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

protectedinherited

Friends for unit testing.

FRIEND_TEST() [2/4]

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

protectedinherited

FRIEND_TEST() [3/4]

CSG::CSGSurface::FRIEND_TEST ( CSGSurfaceTest  , testSetName    )

protected

Friends for unit testing.

FRIEND_TEST() [4/4]

CSG::CSGSurface::FRIEND_TEST ( CSGSurfaceTest  , testSurfaceEquality    )

protected

getCoeffs()

virtual std::unordered_map<std::string, Real> CSG::CSGSurface::getCoeffs ( ) const

pure virtual

Get the coefficients that define the surface.

Returns

map of coefficients and their values

Implemented in CSG::CSGPlane, CSG::CSGSphere, CSG::CSGXCylinder, CSG::CSGYCylinder, and CSG::CSGZCylinder.

Referenced by operator==().

getHalfspaceFromPoint()

CSGSurface::Halfspace CSG::CSGSurface::getHalfspaceFromPoint

(

const Point &

p

)

const

given a point, determine if it is in the positive or negative half-space for the surface

Parameters

p

point

Returns

sign of the half-space

Definition at line 23 of file CSGSurface.C.

{
  // if transformations are present on the surface, apply them in reverse to the point and pass that
  // new point to the evaluation to ensure transformations are considered.

  // Create a local transformed copy - the original p in the calling scope is NOT modified
  const Point p_trans = getTransformations().size() ? applyReverseTransformsToPoint(p) : p;

  auto eval = evaluateSurfaceEquationAtPoint(p_trans);
  if (MooseUtils::absoluteFuzzyGreaterThan(eval, 0))
    return Halfspace::POSITIVE;
  else if (MooseUtils::absoluteFuzzyLessThan(eval, 0))
    return Halfspace::NEGATIVE;
  else
    mooseError("Point ",
               p,
               " used to determine halfspace evaluation lies on the surface ",
               _name,
               ", leading to an ambiguously defined halfspace.");
}

getName()

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

inline

Get the name of surface.

Returns

std::string name of surface

Definition at line 95 of file CSGSurface.h.

Referenced by CSG::CSGSurfaceList::addSurface(), CSG::CSGBase::addTransformation(), CSG::CSGBase::checkSurfaceInBase(), CSG::CSGBase::deleteSurface(), operator==(), and CSG::CSGSurfaceList::renameSurface().

{ return _name; }

getSurfaceType()

const std::string& CSG::CSGSurface::getSurfaceType ( ) const

inline

Get the Surface Type.

Returns

type of surface

Definition at line 61 of file CSGSurface.h.

Referenced by operator==().

{ return _surface_type; }

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

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::CSGSurface::operator!=

(

const CSGSurface &

other

)

const

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

Definition at line 54 of file CSGSurface.C.

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

operator==()

bool CSG::CSGSurface::operator==

(

const CSGSurface &

other

)

const

Operator overload for checking if two CSGSurface objects are equal.

Definition at line 45 of file CSGSurface.C.

{
  return (this->getName() == other.getName()) &&
         (this->getSurfaceType() == other.getSurfaceType()) &&
         (this->getCoeffs() == other.getCoeffs()) &&
         (this->getTransformations() == other.getTransformations());
}

setName()

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

inlineprotected

Definition at line 113 of file CSGSurface.h.

{ _name = name; }

Friends And Related Function Documentation

CSGBase

friend class CSGBase

friend

Definition at line 124 of file CSGSurface.h.

CSGSurfaceList

friend class CSGSurfaceList

friend

Definition at line 123 of file CSGSurface.h.

Member Data Documentation

_name

std::string CSG::CSGSurface::_name

protected

Name of surface.

Definition at line 116 of file CSGSurface.h.

Referenced by CSG::CSGXCylinder::clone(), CSG::CSGYCylinder::clone(), CSG::CSGZCylinder::clone(), CSG::CSGSphere::clone(), CSG::CSGPlane::clone(), getHalfspaceFromPoint(), getName(), and setName().

_surface_type

const std::string CSG::CSGSurface::_surface_type

protected

Type of surface that is being represented string is taken directly from the surface class name.

Definition at line 120 of file CSGSurface.h.

Referenced by getSurfaceType().

_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/CSGSurface.h
• src/csg/CSGSurface.C