util::geometry::Cube Class Reference

Defines cube. More...

#include <geomObjects.h>

Inheritance diagram for util::geometry::Cube:

Collaboration diagram for util::geometry::Cube:

Public Member Functions
	Cube ()
	Constructor.
	Cube (double L, util::Point x=util::Point(), std::string description="")
	Constructor.
	Cube (util::Point x1, util::Point x2, std::string description="")
	Constructor.
double	volume () const override
	Computes the volume (area in 2d, length in 1d) of object.
util::Point	center () const override
	Computes the center of object.
std::pair< util::Point, util::Point >	box () const override
	Computes the bounding box of object.
std::pair< util::Point, util::Point >	box (const double &tol) const override
	Computes the bounding box of object.
double	inscribedRadius () const override
	Computes the radius of biggest circle/sphere completely within the object.
double	boundingRadius () const override
	Computes the radius of smallest circle/sphere such that object can be fit into it.
std::string	printStr (int nt, int lvl) const override
	Returns the string containing printable information about the object.
void	print (int nt, int lvl) const override
	Prints the information about the object.
void	print () const override
	Prints the information about the object.
Interaction with point
bool	isInside (const util::Point &x) const override
	Checks if point is inside this object.
bool	isOutside (const util::Point &x) const override
	Checks if point is outside of this object.
bool	isNear (const util::Point &x, const double &tol) const override
	Checks if point is within given distance of this object.
bool	isNearBoundary (const util::Point &x, const double &tol, const bool &within) const override
	cons
bool	doesIntersect (const util::Point &x) const override
	Checks if point lies exactly on the boundary.
Interaction with box
bool	isInside (const std::pair< util::Point, util::Point > &box) const override
	Checks if box is completely inside.
bool	isOutside (const std::pair< util::Point, util::Point > &box) const override
	Checks if box is outside of the object.
bool	isNear (const std::pair< util::Point, util::Point > &box, const double &tol) const override
	Checks if box is within given distance of this object.
bool	doesIntersect (const std::pair< util::Point, util::Point > &box) const override
	Checks if box intersects this object.
Public Member Functions inherited from util::geometry::GeomObject
	GeomObject (std::string name="", std::string description="")
	Constructor.

Data Fields
std::vector< util::Point >	d_vertices
	Vertices.
util::Point	d_x
	Center.
double	d_L
	Edge length of cube.
double	d_r
	Radius of bounding circle.
Data Fields inherited from util::geometry::GeomObject
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 cube.

Definition at line 1439 of file geomObjects.h.

Constructor & Destructor Documentation

Cube() [1/3]

util::geometry::Cube::Cube ( )

inline

Constructor.

Definition at line 1445 of file geomObjects.h.

                    : GeomObject("cube", ""),
                      d_L(0.),
                      d_r(0.),
                      d_x(util::Point()),
                      d_vertices(std::vector<util::Point>(8, util::Point())) {};

Cube() [2/3]

util::geometry::Cube::Cube ( double  L, util::Point  x = util::Point(), std::string  description = ""  )

inline

Constructor.

Parameters

L	Length along x, y, and z-direction
x	Coordinate of center
description	Description of object (e.g., further classification or any tag)

Definition at line 1459 of file geomObjects.h.

                    : GeomObject("cube", description),
                      d_L(L),
                      d_r(0.5 * std::sqrt(3.) * L),
                      d_x(x),
                      d_vertices(std::vector<util::Point>(8, util::Point())) {
              // numbering assuming x - left-right, y - back-front, z - bottom-top
              // counterclockwise in bottom plane (i.e.,
              // 0 - left-back-bottom, 1 - right-back-bottom,
              // 2 - right-front-bottom, 3 - left-front-bottom
              // similarly, in top plane
              d_vertices[0] =
                      d_x + util::Point(-0.5 * d_L, -0.5 * d_L, -0.5 * d_L);
              d_vertices[1] =
                      d_x + util::Point(0.5 * d_L, -0.5 * d_L, -0.5 * d_L);
              d_vertices[2] =
                      d_x + util::Point(0.5 * d_L, 0.5 * d_L, -0.5 * d_L);
              d_vertices[3] =
                      d_x + util::Point(-0.5 * d_L, 0.5 * d_L, -0.5 * d_L);
 
              d_vertices[4] =
                      d_x + util::Point(-0.5 * d_L, -0.5 * d_L, 0.5 * d_L);
              d_vertices[5] =
                      d_x + util::Point(0.5 * d_L, -0.5 * d_L, 0.5 * d_L);
              d_vertices[6] =
                      d_x + util::Point(0.5 * d_L, 0.5 * d_L, 0.5 * d_L);
              d_vertices[7] =
                      d_x + util::Point(-0.5 * d_L, 0.5 * d_L, 0.5 * d_L);
            };

References d_L, d_vertices, and d_x.

Cube() [3/3]

util::geometry::Cube::Cube ( util::Point  x1, util::Point  x2, std::string  description = ""  )

inline

Constructor.

Parameters

x1	Left-bottom-back corner point
x2	Right-top-front corner point
description	Description of object (e.g., further classification or any tag)

Definition at line 1497 of file geomObjects.h.

                    : GeomObject("cube", description),
                      d_L((x2 - x1).length() / std::sqrt(3.)),
                      d_r(0.5 * (x2 - x1).length()),
                      d_x(0.5 * (x1 + x2)),
                      d_vertices(std::vector<util::Point>(8, util::Point())) {
              // numbering assuming x - left-right, y - back-front, z - bottom-top
              // counterclockwise in bottom plane (i.e.,
              // 0 - left-back-bottom, 1 - right-back-bottom,
              // 2 - right-front-bottom, 3 - left-front-bottom
              // similarly, in top plane
              d_vertices[0] =
                      d_x + util::Point(-0.5 * d_L, -0.5 * d_L, -0.5 * d_L);
              d_vertices[1] =
                      d_x + util::Point(0.5 * d_L, -0.5 * d_L, -0.5 * d_L);
              d_vertices[2] =
                      d_x + util::Point(0.5 * d_L, 0.5 * d_L, -0.5 * d_L);
              d_vertices[3] =
                      d_x + util::Point(-0.5 * d_L, 0.5 * d_L, -0.5 * d_L);
 
              d_vertices[4] =
                      d_x + util::Point(-0.5 * d_L, -0.5 * d_L, 0.5 * d_L);
              d_vertices[5] =
                      d_x + util::Point(0.5 * d_L, -0.5 * d_L, 0.5 * d_L);
              d_vertices[6] =
                      d_x + util::Point(0.5 * d_L, 0.5 * d_L, 0.5 * d_L);
              d_vertices[7] =
                      d_x + util::Point(-0.5 * d_L, 0.5 * d_L, 0.5 * d_L);
            };

References d_L, d_vertices, and d_x.

Member Function Documentation

boundingRadius()

double util::geometry::Cube::boundingRadius ( ) const

overridevirtual

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

Returns

Radius Radius of bounding circle/sphere

Reimplemented from util::geometry::GeomObject.

Definition at line 940 of file geomObjects.cpp.

                                                  {
 
      return d_r;
    }

box() [1/2]

std::pair< util::Point, util::Point > util::geometry::Cube::box ( ) const

overridevirtual

Computes the bounding box of object.

Returns

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

Reimplemented from util::geometry::GeomObject.

Definition at line 922 of file geomObjects.cpp.

                                                              {
 
      return box(0.);
    }

box() [2/2]

std::pair< util::Point, util::Point > util::geometry::Cube::box ( const double &  tol ) const

overridevirtual

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 from util::geometry::GeomObject.

Definition at line 927 of file geomObjects.cpp.

                                                                                       {
      return {util::Point(d_vertices[0].d_x - tol, d_vertices[0].d_y - tol,
                          d_vertices[0].d_z - tol),
              util::Point(d_vertices[6].d_x + tol, d_vertices[6].d_y + tol,
                          d_vertices[6].d_z + tol)};
    }

center()

util::Point util::geometry::Cube::center ( ) const

overridevirtual

Computes the center of object.

Returns

Point Coordinates of center

Reimplemented from util::geometry::GeomObject.

Definition at line 918 of file geomObjects.cpp.

                                             {
      return d_x;
    }

doesIntersect() [1/2]

bool util::geometry::Cube::doesIntersect ( const std::pair< util::Point, util::Point > &  box ) const

overridevirtual

Checks if box intersects this object.

Parameters

box

Box

Returns

True True if intersects

Reimplemented from util::geometry::GeomObject.

Definition at line 1015 of file geomObjects.cpp.

                                                            {
 
      // need to check all four corner points
      for (auto p: util::getCornerPoints(3, box))
        if (this->isInside(p))
          return true;
 
      return false;
    }

References util::getCornerPoints().

Here is the call graph for this function:

doesIntersect() [2/2]

bool util::geometry::Cube::doesIntersect ( const util::Point &  x ) const

overridevirtual

Checks if point lies exactly on the boundary.

Parameters

x

Point

Returns

True True if it lies on the boundary

Reimplemented from util::geometry::GeomObject.

Definition at line 982 of file geomObjects.cpp.

                                                                 {
 
      return isNearBoundary(x, 1.0E-8, false);
    }

inscribedRadius()

double util::geometry::Cube::inscribedRadius ( ) const

overridevirtual

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

Returns

Radius Radius of inscribed circle/sphere

Reimplemented from util::geometry::GeomObject.

Definition at line 935 of file geomObjects.cpp.

                                                   {
 
      return d_L;
    }

isInside() [1/2]

bool util::geometry::Cube::isInside ( const std::pair< util::Point, util::Point > &  box ) const

overridevirtual

Checks if box is completely inside.

Parameters

box

Box

Returns

True True if box lies inside

Reimplemented from util::geometry::GeomObject.

Definition at line 987 of file geomObjects.cpp.

                                                            {
 
      for (auto p: util::getCornerPoints(3, box))
        if (!this->isInside(p))
          return false;
 
      return true;
    }

References util::getCornerPoints().

Here is the call graph for this function:

isInside() [2/2]

bool util::geometry::Cube::isInside ( const util::Point &  x ) const

overridevirtual

Checks if point is inside this object.

Parameters

x

Point

Returns

True If point lies inside

Reimplemented from util::geometry::GeomObject.

Definition at line 945 of file geomObjects.cpp.

                                                            {
      return util::isPointInsideCuboid(x, d_vertices[0], d_vertices[6]);
    }

References util::isPointInsideCuboid().

Here is the call graph for this function:

isNear() [1/2]

bool util::geometry::Cube::isNear ( const std::pair< util::Point, util::Point > &  box, const double &  tol  ) const

overridevirtual

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 from util::geometry::GeomObject.

Definition at line 1008 of file geomObjects.cpp.

          {
 
      return util::areBoxesNear(box(), bbox, tol, 3);
    }

References util::areBoxesNear().

Here is the call graph for this function:

isNear() [2/2]

bool util::geometry::Cube::isNear ( const util::Point &  x, const double &  tol  ) const

overridevirtual

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 from util::geometry::GeomObject.

Definition at line 953 of file geomObjects.cpp.

                                                                 {
 
      // get a bigger box containing this object
      auto bbox = box(tol);
 
      return util::isPointInsideBox(x, 3, bbox);
    }

References util::isPointInsideBox().

Here is the call graph for this function:

isNearBoundary()

bool util::geometry::Cube::isNearBoundary ( const util::Point &  x, const double &  tol, const bool &  within  ) const

overridevirtual

cons

cons

Reimplemented from util::geometry::GeomObject.

Definition at line 962 of file geomObjects.cpp.

                                                               {
 
      // check if particle is within the tolerance distance
      if (!isNear(x, within ? 0. : tol))
        return false;
 
      bool near_x_edge = util::isLess(std::abs(x.d_x - d_vertices[0].d_x), tol) or
                         util::isLess(std::abs(x.d_x - d_vertices[6].d_x), tol);
 
      bool near_y_edge = util::isLess(std::abs(x.d_y - d_vertices[0].d_y), tol) or
                         util::isLess(std::abs(x.d_y - d_vertices[6].d_y), tol);
 
      bool near_z_edge = util::isLess(std::abs(x.d_z - d_vertices[0].d_z), tol) or
                         util::isLess(std::abs(x.d_z - d_vertices[6].d_z), tol);
 
      return near_x_edge || near_y_edge || near_z_edge;
    }

References util::Point::d_x, util::Point::d_y, util::Point::d_z, and util::isLess().

Here is the call graph for this function:

isOutside() [1/2]

bool util::geometry::Cube::isOutside ( const std::pair< util::Point, util::Point > &  box ) const

overridevirtual

Checks if box is outside of the object.

Parameters

box

Box

Returns

True True if box lies outside

Reimplemented from util::geometry::GeomObject.

Definition at line 997 of file geomObjects.cpp.

                                                            {
 
      bool intersect = false;
      for (auto p: util::getCornerPoints(3, box))
        if (!intersect)
          intersect = this->isInside(p);
 
      return !intersect;
    }

References util::getCornerPoints().

Here is the call graph for this function:

isOutside() [2/2]

bool util::geometry::Cube::isOutside ( const util::Point &  x ) const

overridevirtual

Checks if point is outside of this object.

Parameters

x

Point

Returns

True If point lies outside

Reimplemented from util::geometry::GeomObject.

Definition at line 949 of file geomObjects.cpp.

                                                             {
      return !isInside(x);
    }

print() [1/2]

void util::geometry::Cube::print ( ) const

inlineoverridevirtual

Prints the information about the object.

Reimplemented from util::geometry::GeomObject.

Definition at line 1644 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]

void util::geometry::Cube::print ( int  nt, int  lvl  ) const

inlineoverridevirtual

Prints the information about the object.

Parameters

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

Reimplemented from util::geometry::GeomObject.

Definition at line 1637 of file geomObjects.h.

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

References printStr().

Here is the call graph for this function:

printStr()

std::string util::geometry::Cube::printStr ( int  nt, int  lvl  ) const

overridevirtual

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 from util::geometry::GeomObject.

Definition at line 1026 of file geomObjects.cpp.

                                                              {
 
      auto tabS = util::io::getTabS(nt);
 
      std::ostringstream oss;
 
      oss << tabS << "------- Cube --------" << std::endl << std::endl;
      oss << tabS << "Name = " << d_name << std::endl;
      oss << tabS << "Length = " << d_L << std::endl;
      oss << tabS << "Bounding sphere radius = " << d_r << std::endl;
      oss << tabS << "Center = " << d_x.printStr(0, 0) << std::endl;
      oss << tabS << "Vertices = " << util::io::printStr(d_vertices, 0) << std::endl;
      oss << std::endl;
 
      if (lvl > 0)
        oss << tabS << "Bounding box: "
            << util::io::printBoxStr(box(0.), nt + 1);
 
      if (lvl == 0)
        oss << std::endl;
 
      return oss.str();
    }

References util::io::getTabS(), util::io::printBoxStr(), and util::io::printStr().

Referenced by print().

Here is the call graph for this function:

Here is the caller graph for this function:

volume()

double util::geometry::Cube::volume ( ) const

overridevirtual

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

Returns

Volume Volume of object

Reimplemented from util::geometry::GeomObject.

Definition at line 914 of file geomObjects.cpp.

                                          {
      return std::pow(d_L, 3);
    }

Field Documentation

d_L

double util::geometry::Cube::d_L

Edge length of cube.

Definition at line 1653 of file geomObjects.h.

Referenced by Cube(), and Cube().

d_r

double util::geometry::Cube::d_r

Radius of bounding circle.

Definition at line 1656 of file geomObjects.h.

d_vertices

std::vector<util::Point> util::geometry::Cube::d_vertices

Vertices.

Definition at line 1647 of file geomObjects.h.

Referenced by Cube(), and Cube().

d_x

util::Point util::geometry::Cube::d_x

Center.

Definition at line 1650 of file geomObjects.h.

Referenced by Cube(), and Cube().

---

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

• /home/user/project/src/util/geomObjects.h
• /home/user/project/src/util/geomObjects.cpp