geom::GeomObject Class Reference

Defines abstract geometrical domain. More...

#include <geomObjects.h>

Inheritance diagram for geom::GeomObject:

Collaboration diagram for geom::GeomObject:

Public Member Functions
	GeomObject (std::string name="", std::string description="")
	Constructor.
virtual double	volume () const
	Computes the volume (area in 2d, length in 1d) of object.
virtual util::Point	center () const
	Computes the center of object.
virtual std::pair< util::Point, util::Point >	box () const
	Computes the bounding box of object.
virtual std::pair< util::Point, util::Point >	box (const double &tol) const
	Computes the bounding box of object.
virtual double	inscribedRadius () const
	Computes the radius of biggest circle/sphere completely within the object.
virtual double	boundingRadius () const
	Computes the radius of smallest circle/sphere such that object can be fit into it.
virtual std::string	printStr (int nt, int lvl) const
	Returns the string containing printable information about the object.
virtual void	print (int nt, int lvl) const
	Prints the information about the object.
virtual void	print () const
	Prints the information about the object.
virtual void	transform (const util::Point &translation, const double &scale, const double &angle, const util::Point &axis, const util::Point *rotationPoint=nullptr)
	Similarity about pivot \(\mathbf p\) (default: old center d_x), then rigid displacement \(\mathbf t\) = translation: \(\mathbf y = \mathbf p + s\,\mathbf R(\mathbf x-\mathbf p) + \mathbf t\). When \(\theta=0\) and \(s=1\), \(\mathbf y = \mathbf x + \mathbf t\) for every point and the center.
virtual bool	wallContactQuery (const util::Point &x, WallContactHit &hit) const
	Closest-point / signed-gap query for analytical wall contact. Default: unsupported (returns false, clears hit).
Interaction with point
virtual bool	isInside (const util::Point &x) const
	Checks if point is inside this object.
virtual bool	isOutside (const util::Point &x) const
	Checks if point is outside of this object.
virtual bool	isNear (const util::Point &x, const double &tol) const
	Checks if point is within given distance of this object.
virtual bool	isNearBoundary (const util::Point &x, const double &tol, const bool &within) const
	Checks if point is within given distance of this object.
virtual bool	doesIntersect (const util::Point &x) const
	Checks if point lies exactly on the boundary.
Interaction with box
virtual bool	isInside (const std::pair< util::Point, util::Point > &box) const
	Checks if box is completely inside.
virtual bool	isOutside (const std::pair< util::Point, util::Point > &box) const
	Checks if box is outside of the object.
virtual bool	isNear (const std::pair< util::Point, util::Point > &box, const double &tol) const
	Checks if box is within given distance of this object.
virtual bool	doesIntersect (const std::pair< util::Point, util::Point > &box) const
	Checks if box intersects this object.

Data Fields
const std::string	d_name
	name of object
const std::string	d_description
	Further description of object.
std::vector< std::string >	d_tags
	Tags/attributes about the object.

Detailed Description

Defines abstract geometrical domain.

Definition at line 122 of file geomObjects.h.

Constructor & Destructor Documentation

GeomObject()

geom::GeomObject::GeomObject ( std::string  name = "", std::string  description = ""  )

inlineexplicit

Constructor.

Parameters

name	Name of the geometric object
description	Description of object (e.g., further classification or any tag)

Definition at line 140 of file geomObjects.h.

      : d_name(name), d_description(description) {
    };

Member Function Documentation

boundingRadius()

virtual double geom::GeomObject::boundingRadius ( ) const

inlinevirtual

Computes the radius of smallest circle/sphere such that object can be fit into it.

Returns

Radius Radius of bounding circle/sphere

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::Plane, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 187 of file geomObjects.h.

{ return 0.; };

Referenced by geom::AnnulusGeomObject::boundingRadius().

Here is the caller graph for this function:

box() [1/2]

virtual std::pair< util::Point, util::Point > geom::GeomObject::box ( ) const

inlinevirtual

Computes the bounding box of object.

Returns

Pair Left-bottom-back and right-top-front corner points of box

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::Plane, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 161 of file geomObjects.h.

                                                      {
      return {util::Point(), util::Point()};
    };

Referenced by geom::AnnulusGeomObject::box(), geom::AnnulusGeomObject::box(), and mesh_gen::anonymous_namespace{builtinGmshGeometry.cpp}::buildOccBoxFromAabb().

Here is the caller graph for this function:

box() [2/2]

virtual std::pair< util::Point, util::Point > geom::GeomObject::box ( const double &  tol ) const

inlinevirtual

Computes the bounding box of object.

Parameters

tol	Tolerance/padding used in creating bounding box

Returns

Pair Left-bottom-back and right-top-front corner points of box

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::Plane, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 171 of file geomObjects.h.

                                 {
      return {util::Point(), util::Point()};
    };

center()

virtual util::Point geom::GeomObject::center ( ) const

inlinevirtual

Computes the center of object.

Returns

Point Coordinates of center

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::Plane, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 155 of file geomObjects.h.

{ return {}; };

Referenced by geom::AnnulusGeomObject::center(), and geom::AnnulusGeomObject::transform().

Here is the caller graph for this function:

doesIntersect() [1/2]

virtual bool geom::GeomObject::doesIntersect ( const std::pair< util::Point, util::Point > &  box ) const

inlinevirtual

Checks if box intersects this object.

Parameters

box

Box

Returns

True True if intersects

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 281 of file geomObjects.h.

                                                      {
      return false;
    };

doesIntersect() [2/2]

virtual bool geom::GeomObject::doesIntersect ( const util::Point &  x ) const

inlinevirtual

Checks if point lies exactly on the boundary.

Parameters

x

Point

Returns

True True if it lies on the boundary

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::Plane, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 236 of file geomObjects.h.

{ return false; };

inscribedRadius()

virtual double geom::GeomObject::inscribedRadius ( ) const

inlinevirtual

Computes the radius of biggest circle/sphere completely within the object.

Returns

Radius Radius of inscribed circle/sphere

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::Plane, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 180 of file geomObjects.h.

{ return 0.; };

Referenced by geom::AnnulusGeomObject::inscribedRadius().

Here is the caller graph for this function:

isInside() [1/2]

virtual bool geom::GeomObject::isInside ( const std::pair< util::Point, util::Point > &  box ) const

inlinevirtual

Checks if box is completely inside.

Parameters

box

Box

Returns

True True if box lies inside

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 250 of file geomObjects.h.

                                                             {
      return false;
    };

isInside() [2/2]

virtual bool geom::GeomObject::isInside ( const util::Point &  x ) const

inlinevirtual

Checks if point is inside this object.

Parameters

x

Point

Returns

True If point lies inside

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::Plane, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 198 of file geomObjects.h.

{ return false; };

Referenced by geom::AnnulusGeomObject::isInside().

Here is the caller graph for this function:

isNear() [1/2]

virtual bool geom::GeomObject::isNear ( const std::pair< util::Point, util::Point > &  box, const double &  tol  ) const

inlinevirtual

Checks if box is within given distance of this object.

Parameters

box	Box
tol	Tolerance used in checking the nearness

Returns

True True if box is inside within the tol distance

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 270 of file geomObjects.h.

                                                 {
      return false;
    };

isNear() [2/2]

virtual bool geom::GeomObject::isNear ( const util::Point &  x, const double &  tol  ) const

inlinevirtual

Checks if point is within given distance of this object.

Parameters

x	Point
tol	Tolerance used in checking the nearness

Returns

True True if within the tol distance

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::Plane, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 214 of file geomObjects.h.

                                                                     {
      return false;
    };

Referenced by geom::AnnulusGeomObject::isNear(), and geom::AnnulusGeomObject::isNear().

Here is the caller graph for this function:

isNearBoundary()

virtual bool geom::GeomObject::isNearBoundary ( const util::Point &  x, const double &  tol, const bool &  within  ) const

inlinevirtual

Checks if point is within given distance of this object.

Parameters

x	Point
tol	Tolerance used in checking the nearness
within	Check if the point is within (inside) the object

Returns

True True if it is near within tol distance

Reimplemented in geom::Plane, geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 225 of file geomObjects.h.

                                                          {
      return false;
    };

Referenced by geom::AnnulusGeomObject::isNearBoundary().

Here is the caller graph for this function:

isOutside() [1/2]

virtual bool geom::GeomObject::isOutside ( const std::pair< util::Point, util::Point > &  box ) const

inlinevirtual

Checks if box is outside of the object.

Parameters

box

Box

Returns

True True if box lies outside

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 260 of file geomObjects.h.

                                                              {
      return false;
    };

isOutside() [2/2]

virtual bool geom::GeomObject::isOutside ( const util::Point &  x ) const

inlinevirtual

Checks if point is outside of this object.

Parameters

x

Point

Returns

True If point lies outside

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::Plane, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 206 of file geomObjects.h.

{ return false; };

print() [1/2]

virtual void geom::GeomObject::print ( ) const

inlinevirtual

Prints the information about the object.

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::NullGeomObject, geom::Plane, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 321 of file geomObjects.h.

{ print(0, 0); };

References print().

Referenced by print().

Here is the call graph for this function:

Here is the caller graph for this function:

print() [2/2]

virtual void geom::GeomObject::print ( int  nt, int  lvl  ) const

inlinevirtual

Prints the information about the object.

Parameters

nt	Number of tabs to append before printing
lvl	Information level (higher means more information)

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::NullGeomObject, geom::Plane, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 316 of file geomObjects.h.

                                              {
      std::cout << printStr(nt, lvl);
    };

References printStr().

Here is the call graph for this function:

printStr()

virtual std::string geom::GeomObject::printStr ( int  nt, int  lvl  ) const

inlinevirtual

Returns the string containing printable information about the object.

Parameters

nt	Number of tabs to append before printing
lvl	Information level (higher means more information)

Returns

string String containing printable information about the object

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::NullGeomObject, geom::Plane, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 295 of file geomObjects.h.

                                                      {
      auto tabS = util::io::getTabS(nt);
      std::ostringstream oss;
 
      oss << tabS << "------- GeomObject --------" << std::endl
          << std::endl;
      oss << tabS << "Base geometrical object" << std::endl;
      oss << tabS << "Base implementation of GeomObject." << std::endl;
      oss << tabS << "Name of GeomObject = " << d_name << std::endl;
      oss << tabS << "Description of GeomObject = " << d_description
          << std::endl;
 
      return oss.str();
    };

References d_description, d_name, and util::io::getTabS().

Referenced by print(), and geom::AnnulusGeomObject::printStr().

Here is the call graph for this function:

Here is the caller graph for this function:

transform()

virtual void geom::GeomObject::transform ( const util::Point &  translation, const double &  scale, const double &  angle, const util::Point &  axis, const util::Point *  rotationPoint = nullptr  )

inlinevirtual

Similarity about pivot \(\mathbf p\) (default: old center d_x), then rigid displacement \(\mathbf t\) = translation: \(\mathbf y = \mathbf p + s\,\mathbf R(\mathbf x-\mathbf p) + \mathbf t\). When \(\theta=0\) and \(s=1\), \(\mathbf y = \mathbf x + \mathbf t\) for every point and the center.

Parameters

translation	Rigid translation vector \(\mathbf t\) (added after rotate+scale about \(\mathbf p\))
scale	Uniform scale factor
angle	Rotation angle (radians)
axis	Axis of rotation
rotationPoint	If non-null, use as \(\mathbf p\); if null, use old d_x as pivot.

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::NullGeomObject, geom::Plane, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 335 of file geomObjects.h.

                                                                   {
      // Base implementation does nothing
    }

Referenced by geom::AnnulusGeomObject::transform().

Here is the caller graph for this function:

volume()

virtual double geom::GeomObject::volume ( ) const

inlinevirtual

Computes the volume (area in 2d, length in 1d) of object.

Returns

Volume Volume of object

Reimplemented in geom::AnnulusGeomObject, geom::ComplexGeomObject, geom::Plane, geom::Line, geom::Triangle, geom::Square, geom::Rectangle, geom::Hexagon, geom::Drum2D, geom::Cube, geom::Cuboid, geom::Circle, geom::Ellipse, geom::Sphere, geom::Ellipsoid, geom::Cylinder, geom::OpenCuboidChannel3D, and geom::OpenRectChannel2D.

Definition at line 149 of file geomObjects.h.

{ return 0.; };

Referenced by geom::AnnulusGeomObject::center(), and geom::AnnulusGeomObject::volume().

Here is the caller graph for this function:

wallContactQuery()

virtual bool geom::GeomObject::wallContactQuery ( const util::Point &  x, WallContactHit &  hit  ) const

inlinevirtual

Closest-point / signed-gap query for analytical wall contact. Default: unsupported (returns false, clears hit).

Reimplemented in geom::Plane, geom::Line, and geom::Rectangle.

Definition at line 345 of file geomObjects.h.

                                                             {
      (void)x;
      hit = WallContactHit();
      return false;
    }

Referenced by anonymous_namespace{main.cpp}::checkWallSpringOnly(), and anonymous_namespace{main.cpp}::minGrainWallGap().

Here is the caller graph for this function:

Field Documentation

d_description

const std::string geom::GeomObject::d_description

Further description of object.

Definition at line 129 of file geomObjects.h.

Referenced by printStr().

d_name

const std::string geom::GeomObject::d_name

name of object

Definition at line 126 of file geomObjects.h.

Referenced by geom::AnnulusGeomObject::AnnulusGeomObject(), mesh_gen::buildAnnulus2DInCurrentModel(), mesh_gen::buildAnnulus3DInCurrentModel(), mesh_gen::buildGmshGeometryInCurrentModel(), geom::ComplexGeomObject::ComplexGeomObject(), geom::createGeomDeepCopy(), mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::embedPointInAnnulus2D(), mesh_gen::anonymous_namespace{annulusMesh3D.cpp}::embedPointInAnnulus3D(), printStr(), geom::AnnulusGeomObject::printStr(), geom::ComplexGeomObject::printStr(), geom::NullGeomObject::printStr(), geom::Line::printStr(), geom::Triangle::printStr(), geom::Square::printStr(), geom::Rectangle::printStr(), geom::Hexagon::printStr(), geom::Drum2D::printStr(), geom::Cube::printStr(), geom::Cuboid::printStr(), geom::Circle::printStr(), geom::Ellipse::printStr(), geom::Sphere::printStr(), geom::Ellipsoid::printStr(), and geom::Cylinder::printStr().

d_tags

std::vector<std::string> geom::GeomObject::d_tags

Tags/attributes about the object.

Definition at line 132 of file geomObjects.h.

Referenced by geom::AnnulusGeomObject::AnnulusGeomObject(), geom::Circle::Circle(), geom::ComplexGeomObject::ComplexGeomObject(), geom::Cube::Cube(), geom::Cuboid::Cuboid(), geom::Cylinder::Cylinder(), geom::Ellipse::Ellipse(), geom::Ellipsoid::Ellipsoid(), geom::Hexagon::Hexagon(), geom::Line::Line(), geom::NullGeomObject::NullGeomObject(), geom::OpenCuboidChannel3D::OpenCuboidChannel3D(), geom::OpenRectChannel2D::OpenRectChannel2D(), geom::AnnulusGeomObject::operator=(), geom::Circle::operator=(), geom::ComplexGeomObject::operator=(), geom::Cube::operator=(), geom::Cuboid::operator=(), geom::Cylinder::operator=(), geom::Drum2D::operator=(), geom::Ellipse::operator=(), geom::Ellipsoid::operator=(), geom::Hexagon::operator=(), geom::Line::operator=(), geom::NullGeomObject::operator=(), geom::OpenCuboidChannel3D::operator=(), geom::OpenRectChannel2D::operator=(), geom::Plane::operator=(), geom::Rectangle::operator=(), geom::Sphere::operator=(), geom::Square::operator=(), geom::Triangle::operator=(), geom::Plane::Plane(), geom::Rectangle::Rectangle(), geom::Sphere::Sphere(), geom::Square::Square(), and geom::Triangle::Triangle().

---

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

• /home/user/project/src/geom/geomObjects.h