#include <geomObjects.h>

Inheritance diagram for geom::Square:

Collaboration diagram for geom::Square:

Public Member Functions
	Square ()
	Constructor.

	Square (double L, util::Point x=util::Point(), std::string description="")
	Constructor.

	Square (util::Point x1, util::Point x2, std::string description="")
	Constructor.

	Square (const Square &other)
	Copy constructor.

Square &	operator= (const Square &other)
	Assignment operator.

void	transform (const util::Point &translation, const double &scale, const double &angle, const util::Point &axis, const util::Point *rotationPoint) override
	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.

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 geom::GeomObject
	GeomObject (std::string name="", std::string description="")
	Constructor.

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

Data Fields
std::vector< util::Point >	d_vertices
	Vertices.

util::Point	d_x
	Center.

double	d_L
	Edge length of a square.

double	d_r
	Radius of bounding circle.

Data Fields inherited from geom::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 Square.

Definition at line 1017 of file geomObjects.h.

Constructor & Destructor Documentation

◆ Square() [1/4]

geom::Square::Square ( )

inline

Constructor.

Definition at line 1036 of file geomObjects.h.

      : GeomObject("square", ""),
        d_L(0.),
        d_r(0.),
        d_x(util::Point()),
        d_vertices({
          util::Point(), util::Point(),
          util::Point(), util::Point()
        }) {
    };

◆ Square() [2/4]

geom::Square::Square	(	double	L,
		util::Point	x = `util::Point()`,
		std::string	description = `""`
	)

inline

Constructor.

Parameters

L	Length along x and y-directions (Square)
x	Center point
description	Description of object (e.g., further classification or any tag)

Definition at line 1054 of file geomObjects.h.

      : GeomObject("square", description),
        d_L(L),
        d_r(L / std::sqrt(2)),
        d_x(x),
        d_vertices({
          x + util::Point(-0.5 * L, -0.5 * L, 0.),
          x + util::Point(0.5 * L, -0.5 * L, 0.),
          x + util::Point(0.5 * L, 0.5 * L, 0.),
          x + util::Point(-0.5 * L, 0.5 * L, 0.)
        }) {
    };

◆ Square() [3/4]

geom::Square::Square	(	util::Point	x1,
		util::Point	x2,
		std::string	description = `""`
	)

inline

Constructor.

Parameters

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

Definition at line 1075 of file geomObjects.h.

      : GeomObject("square", description),
        d_L((x1 - x2).length() * (1. / std::sqrt(2))),
        d_r((x1 - x2).length() / 2.),
        d_x(0.5 * (x1 + x2)) {
      d_vertices.push_back(x1);
      d_vertices.push_back(util::Point(x1.d_x + d_L, x1.d_y, x1.d_z));
      d_vertices.push_back(x2);
      d_vertices.push_back(util::Point(x2.d_x - d_L, x2.d_y, x2.d_z));
    };

References d_L, d_vertices, util::Point::d_x, util::Point::d_y, and util::Point::d_z.

◆ Square() [4/4]

geom::Square::Square ( const Square & other )

inline

Copy constructor.

Parameters

other Object to copy from

Definition at line 1090 of file geomObjects.h.

      : GeomObject(other.d_name, other.d_description),
        d_L(other.d_L),
        d_r(other.d_r),
        d_x(other.d_x),
        d_vertices(other.d_vertices) {
      d_tags = other.d_tags;
    }

References geom::GeomObject::d_tags.

Member Function Documentation

◆ boundingRadius()

double geom::Square::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 geom::GeomObject.

Definition at line 450 of file geomObjects.cpp.

                                      {
 
    return d_r;
  }

References d_r.

◆ box() [1/2]

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

overridevirtual

Computes the bounding box of object.

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

Reimplemented from geom::GeomObject.

Definition at line 432 of file geomObjects.cpp.

                                                  {
 
    return box(0.);
  }

References box().

Referenced by box(), doesIntersect(), isInside(), isNear(), isNear(), isOutside(), and printStr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ box() [2/2]

std::pair< util::Point, util::Point > geom::Square::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 geom::GeomObject.

Definition at line 436 of file geomObjects.cpp.

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

References d_vertices, and d_x.

◆ center()

util::Point geom::Square::center ( ) const

overridevirtual

Computes the center of object.

Returns: Point Coordinates of center

Reimplemented from geom::GeomObject.

Definition at line 428 of file geomObjects.cpp.

                                 {
    return d_x;
  }

References d_x.

◆ doesIntersect() [1/2]

bool geom::Square::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 geom::GeomObject.

Definition at line 521 of file geomObjects.cpp.

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

References box(), geom::getCornerPoints(), and isInside().

Here is the call graph for this function:

◆ doesIntersect() [2/2]

bool geom::Square::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 geom::GeomObject.

Definition at line 489 of file geomObjects.cpp.

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

References isNearBoundary().

Here is the call graph for this function:

◆ inscribedRadius()

double geom::Square::inscribedRadius ( ) const

overridevirtual

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

Returns: Radius Radius of inscribed circle/sphere

Reimplemented from geom::GeomObject.

Definition at line 445 of file geomObjects.cpp.

                                       {
 
    return 0.5*d_L;
  }

References d_L.

◆ isInside() [1/2]

bool geom::Square::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 geom::GeomObject.

Definition at line 494 of file geomObjects.cpp.

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

References box(), geom::getCornerPoints(), and isInside().

Here is the call graph for this function:

◆ isInside() [2/2]

bool geom::Square::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 geom::GeomObject.

Definition at line 455 of file geomObjects.cpp.

                                                {
    return geom::isPointInsideRectangle(x, d_vertices[0], d_vertices[2]);
  }

References d_vertices, and geom::isPointInsideRectangle().

Referenced by doesIntersect(), isInside(), isOutside(), and isOutside().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isNear() [1/2]

bool geom::Square::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 geom::GeomObject.

Definition at line 515 of file geomObjects.cpp.

                                                                             {
 
    return geom::areBoxesNear(this->box(), box, tol, 2);
  }

References geom::areBoxesNear(), and box().

Here is the call graph for this function:

◆ isNear() [2/2]

bool geom::Square::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 geom::GeomObject.

Definition at line 463 of file geomObjects.cpp.

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

References box(), and geom::isPointInsideBox().

Referenced by isNearBoundary().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isNearBoundary()

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

overridevirtual

cons

Reimplemented from geom::GeomObject.

Definition at line 472 of file geomObjects.cpp.

                                                                {
 
    // check if particle is inside the object
    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[2].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[2].d_y), tol);
 
    return near_x_edge || near_y_edge;
  }

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

Referenced by doesIntersect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isOutside() [1/2]

bool geom::Square::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 geom::GeomObject.

Definition at line 504 of file geomObjects.cpp.

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

References box(), geom::getCornerPoints(), and isInside().

Here is the call graph for this function:

◆ isOutside() [2/2]

bool geom::Square::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 geom::GeomObject.

Definition at line 459 of file geomObjects.cpp.

                                                 {
    return !isInside(x);
  }

References isInside().

Here is the call graph for this function:

◆ operator=()

Square & geom::Square::operator= ( const Square & other )

inline

Assignment operator.

Parameters

other Object to copy from

Returns: Reference to this object

Definition at line 1104 of file geomObjects.h.

                                           {
      if (this != &other) {
        // Copy base class members
        d_tags = other.d_tags;
        
        // Copy member variables
        d_L = other.d_L;
        d_r = other.d_r;
        d_x = other.d_x;
        d_vertices = other.d_vertices;
      }
      return *this;
    }

References d_L, d_r, geom::GeomObject::d_tags, d_vertices, and d_x.

◆ print() [1/2]

void geom::Square::print ( ) const

inlineoverridevirtual

Prints the information about the object.

Reimplemented from geom::GeomObject.

Definition at line 1248 of file geomObjects.h.

1248{ print(0, 0); };

geom::Square::print

void print() const override

Prints the information about the object.

Definition geomObjects.h:1248

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 geom::Square::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 geom::GeomObject.

Definition at line 1241 of file geomObjects.h.

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

References printStr().

Here is the call graph for this function:

◆ printStr()

std::string geom::Square::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 geom::GeomObject.

Definition at line 532 of file geomObjects.cpp.

                                                  {
 
    auto tabS = util::io::getTabS(nt);
 
    std::ostringstream oss;
 
    oss << tabS << "------- Rectangle --------" << std::endl << std::endl;
    oss << tabS << "Name = " << d_name << std::endl;
    oss << tabS << "Length = " << d_L << std::endl;
    oss << tabS << "Bounding radius = " << d_r << std::endl;
    oss << tabS << "Center = " << d_x.printStr(0, lvl) << 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 box(), d_L, geom::GeomObject::d_name, d_r, d_vertices, d_x, util::io::getTabS(), util::io::printBoxStr(), util::io::printStr(), and util::Point::printStr().

Referenced by print().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transform()

void geom::Square::transform	(	const util::Point &	translation,
		const double &	scale,
		const double &	angle,
		const util::Point &	axis,
		const util::Point *	rotationPoint
	)

inlineoverridevirtual

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

Definition at line 1118 of file geomObjects.h.

                                                                                                       {
      // Scale the dimensions
      d_L *= scale;
      d_r *= scale;
 
      const util::Point c0 = d_x;
      for (auto &v : d_vertices) {
        v = mapSimilarity(v, c0, translation, scale, angle, axis, rotationPoint);
      }
      d_x = mapSimilarity(c0, c0, translation, scale, angle, axis, rotationPoint);
    }

References d_L, d_r, d_vertices, d_x, and geom::mapSimilarity().

Here is the call graph for this function:

◆ volume()

double geom::Square::volume ( ) const

overridevirtual

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

Returns: Volume Volume of object

Reimplemented from geom::GeomObject.

Definition at line 424 of file geomObjects.cpp.

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

References d_L.

Field Documentation

◆ d_L

double geom::Square::d_L

Edge length of a square.

Definition at line 1027 of file geomObjects.h.

Referenced by inscribedRadius(), operator=(), printStr(), Square(), transform(), and volume().

◆ d_r

double geom::Square::d_r

Radius of bounding circle.

Definition at line 1030 of file geomObjects.h.

Referenced by boundingRadius(), operator=(), printStr(), and transform().

◆ d_vertices

std::vector<util::Point> geom::Square::d_vertices

Vertices.

Definition at line 1021 of file geomObjects.h.

Referenced by box(), isInside(), isNearBoundary(), operator=(), printStr(), Square(), and transform().

◆ d_x

util::Point geom::Square::d_x

Center.

Definition at line 1024 of file geomObjects.h.

Referenced by box(), center(), operator=(), printStr(), and transform().

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

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

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ Square() [1/4]

◆ Square() [2/4]

◆ Square() [3/4]

◆ Square() [4/4]

Member Function Documentation

◆ boundingRadius()

◆ box() [1/2]

◆ box() [2/2]

◆ center()

◆ doesIntersect() [1/2]

◆ doesIntersect() [2/2]

◆ inscribedRadius()

◆ isInside() [1/2]

◆ isInside() [2/2]

◆ isNear() [1/2]

◆ isNear() [2/2]

◆ isNearBoundary()

◆ isOutside() [1/2]

◆ isOutside() [2/2]

◆ operator=()

◆ print() [1/2]

◆ print() [2/2]

◆ printStr()

◆ transform()

◆ volume()

Field Documentation

◆ d_L

◆ d_r

◆ d_vertices

◆ d_x