CSGXCylinder creates an internal representation of a Constructive Solid Geometry (CSG) x-axis aligned cylinder, represented in the following form (y - y0)^2 + (z - z0)^2 = r^2. More...

#include <CSGXCylinder.h>

Inheritance diagram for CSG::CSGXCylinder:

[legend]

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
	CSGXCylinder (const std::string &name, const Real y0, const Real z0, const Real r)
	Construct a cylinder surface aligned with the x axis. More...

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

virtual std::unordered_map< std::string, Real >	getCoeffs () const override
	Get the coefficients (y0, z0, and r) that define the cylindrical surface with the equation: (y - y0)^2 + (z - z0)^2 = r^2. More...

virtual Real	evaluateSurfaceEquationAtPoint (const Point &p) const override
	given a point, determine its evaluation based on the equation of the cylinder More...

const std::string &	getSurfaceType () const
	Get the Surface Type. 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...

Protected Member Functions
void	checkRadius () const

void	setName (const std::string &name)


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

Protected Attributes
Real	_y0
	Value of y0 in equation of an x-axis aligned cylinder. More...

Real	_z0
	Value of z0 in equation of an x-axis aligned cylinder. More...

Real	_r
	Value of r in equation of an x-axis aligned cylinder. More...

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...

Detailed Description

CSGXCylinder creates an internal representation of a Constructive Solid Geometry (CSG) x-axis aligned cylinder, represented in the following form (y - y0)^2 + (z - z0)^2 = r^2.

Definition at line 23 of file CSGXCylinder.h.

Member Enumeration Documentation

◆ Halfspace

enum CSG::CSGSurface::Halfspace

stronginherited

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

◆ CSGXCylinder()

CSG::CSGXCylinder::CSGXCylinder	(	const std::string &	name,
		const Real	y0,
		const Real	z0,
		const Real	r
	)

Construct a cylinder surface aligned with the x axis.

Parameters

name	unique name of surface
y0	y coordinate of center
z0	z coordinate of center
r	radius

Definition at line 15 of file CSGXCylinder.C.

   : CSGSurface(name, MooseUtils::prettyCppType<CSGXCylinder>()), _y0(y0), _z0(z0), _r(r)
 {
   checkRadius();
 }

◆ ~CSGXCylinder()

virtual CSG::CSGXCylinder::~CSGXCylinder ( )

virtualdefault

Destructor.

Member Function Documentation

◆ checkRadius()

void CSG::CSGXCylinder::checkRadius ( ) const

protected

Definition at line 39 of file CSGXCylinder.C.

Referenced by CSGXCylinder().

 {
   if (_r <= 0.0)
     mooseError("Radius of x-cylinder must be positive.");
 }

◆ evaluateSurfaceEquationAtPoint()

Real CSG::CSGXCylinder::evaluateSurfaceEquationAtPoint ( const Point & p ) const

overridevirtual

given a point, determine its evaluation based on the equation of the cylinder

Parameters

p point

Returns: evaluation of point based on surface equation

Implements CSG::CSGSurface.

Definition at line 29 of file CSGXCylinder.C.

 {
   // Compute distance from the cylinder center to determine if inside (< r^2)
   // or outside (> r^2) the cylinder
   const Real dist_sq = Utility::pow<2>((p(1) - _y0)) + Utility::pow<2>((p(2) - _z0));
 
   return dist_sq - Utility::pow<2>(_r);
 }

◆ FRIEND_TEST()

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

protectedinherited

Friends for unit testing.

◆ getCoeffs()

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

overridevirtual

Get the coefficients (y0, z0, and r) that define the cylindrical surface with the equation: (y - y0)^2 + (z - z0)^2 = r^2.

Returns: map of coefficients to their value

Implements CSG::CSGSurface.

Definition at line 22 of file CSGXCylinder.C.

 {
   std::unordered_map<std::string, Real> coeffs = {{"y0", _y0}, {"z0", _z0}, {"r", _r}};
   return coeffs;
 }

◆ getHalfspaceFromPoint()

CSGSurface::Halfspace CSG::CSGSurface::getHalfspaceFromPoint ( const Point & p ) const

inherited

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 21 of file CSGSurface.C.

 {
   auto eval = evaluateSurfaceEquationAtPoint(p);
   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

inlineinherited

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::CSGRegion::CSGRegion(), CSG::CSGSurface::operator==(), and CSG::CSGSurfaceList::renameSurface().

95 { return _name; }

CSG::CSGSurface::_name

std::string _name

Name of surface.

Definition: CSGSurface.h:109

◆ getSurfaceType()

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

inlineinherited

Get the Surface Type.

Returns: type of surface

Definition at line 61 of file CSGSurface.h.

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

61 { return _surface_type; }

CSG::CSGSurface::_surface_type

const std::string _surface_type

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

Definition: CSGSurface.h:113

◆ operator!=()

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

inherited

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

Definition at line 45 of file CSGSurface.C.

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

◆ operator==()

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

inherited

Operator overload for checking if two CSGSurface objects are equal.

Definition at line 37 of file CSGSurface.C.

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