geom::Rectangle Class Reference

Defines Rectangle. More...

#include <geomObjects.h>

Inheritance diagram for geom::Rectangle:

Collaboration diagram for geom::Rectangle:

Public Member Functions
	Rectangle ()
	Constructor.
	Rectangle (double Lx, double Ly, util::Point x=util::Point(), std::string description="")
	Constructor.
	Rectangle (const Rectangle &other)
	Copy constructor.
	Rectangle (util::Point x1, util::Point x2, std::string description="")
	Constructor.
Rectangle &	operator= (const Rectangle &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.
bool	wallContactQuery (const util::Point &x, WallContactHit &hit) const override
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.

Data Fields
std::vector< util::Point >	d_vertices
	Vertices.
util::Point	d_x
	Center.
double	d_Lx
	Edge length of a rectangle in x-direction.
double	d_Ly
	Edge length of a rectangle in y-direction.
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 Rectangle.

Definition at line 1254 of file geomObjects.h.

Constructor & Destructor Documentation

Rectangle() [1/4]

geom::Rectangle::Rectangle ( )

inline

Constructor.

Definition at line 1275 of file geomObjects.h.

      : GeomObject("rectangle", ""),
        d_Lx(0.),
        d_Ly(0.),
        d_r(0.),
        d_x(util::Point()),
        d_vertices({
          util::Point(), util::Point(),
          util::Point(), util::Point()
        }) {
    };

Rectangle() [2/4]

geom::Rectangle::Rectangle ( double  Lx, double  Ly, util::Point  x = util::Point(), std::string  description = ""  )

inline

Constructor.

Parameters

Lx	Length along x-direction
Ly	Length along y-direction
x	Center point
description	Description of object (e.g., further classification or any tag)

Definition at line 1295 of file geomObjects.h.

      : GeomObject("rectangle", description),
        d_Lx(Lx),
        d_Ly(Ly),
        d_r(0.5 * std::sqrt(std::pow(Lx, 2) + std::pow(Ly, 2))),
        d_x(x) {
      d_vertices.push_back(
        x + util::Point(-0.5 * d_Lx, -0.5 * d_Ly, 0.));
      d_vertices.push_back(
        x + util::Point(0.5 * d_Lx, -0.5 * d_Ly, 0.));
      d_vertices.push_back(x + util::Point(0.5 * d_Lx, 0.5 * d_Ly, 0.));
      d_vertices.push_back(
        x + util::Point(-0.5 * d_Lx, 0.5 * d_Ly, 0.));
    };

References d_Lx, d_Ly, and d_vertices.

Rectangle() [3/4]

geom::Rectangle::Rectangle ( const Rectangle &  other )

inline

Copy constructor.

Parameters

other

Object to copy from

Definition at line 1315 of file geomObjects.h.

      : GeomObject(other.d_name, other.d_description),
        d_Lx(other.d_Lx),
        d_Ly(other.d_Ly),
        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.

Rectangle() [4/4]

geom::Rectangle::Rectangle ( 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 1332 of file geomObjects.h.

      : GeomObject("rectangle", description),
        d_Lx(x2.d_x - x1.d_x),
        d_Ly(x2.d_y - x1.d_y),
        d_r(0.5 *
            std::sqrt(std::pow(d_Lx, 2) + std::pow(d_Ly, 2))),
        d_x(0.5 * (x1 + x2)) {
      d_vertices.push_back(x1);
      d_vertices.push_back(util::Point(x1.d_x + d_Lx, x1.d_y, x1.d_z));
      d_vertices.push_back(x2);
      d_vertices.push_back(util::Point(x2.d_x - d_Lx, x2.d_y, x2.d_z));
    };

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

Member Function Documentation

boundingRadius()

double geom::Rectangle::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 657 of file geomObjects.cpp.

                                           {
 
      return d_r;
    }

References d_r.

box() [1/2]

std::pair< util::Point, util::Point > geom::Rectangle::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 638 of file geomObjects.cpp.

                                                       {
 
      return box(0.);
    }

References box().

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

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::Rectangle::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 643 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::Rectangle::center ( ) const

overridevirtual

Computes the center of object.

Returns

Point Coordinates of center

Reimplemented from geom::GeomObject.

Definition at line 634 of file geomObjects.cpp.

                                      {
      return d_x;
    }

References d_x.

doesIntersect() [1/2]

bool geom::Rectangle::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 729 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::Rectangle::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 696 of file geomObjects.cpp.

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

References isNearBoundary().

Here is the call graph for this function:

inscribedRadius()

double geom::Rectangle::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 652 of file geomObjects.cpp.

                                            {
 
      return util::isLess(d_Lx, d_Ly) ? d_Lx : d_Ly;
    }

References d_Lx, d_Ly, and util::isLess().

Here is the call graph for this function:

isInside() [1/2]

bool geom::Rectangle::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 701 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::Rectangle::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 662 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::Rectangle::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 722 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::Rectangle::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 670 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::Rectangle::isNearBoundary ( const util::Point &  x, const double &  tol, const bool &  within  ) const

overridevirtual

cons

cons

Reimplemented from geom::GeomObject.

Definition at line 679 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::Rectangle::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 711 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::Rectangle::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 666 of file geomObjects.cpp.

                                                      {
      return !isInside(x);
    }

References isInside().

Here is the call graph for this function:

operator=()

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

inline

Assignment operator.

Parameters

other

Object to copy from

Returns

Reference to this object

Definition at line 1351 of file geomObjects.h.

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

References d_Lx, d_Ly, d_r, geom::GeomObject::d_tags, d_vertices, and d_x.

print() [1/2]

void geom::Rectangle::print ( ) const

inlineoverridevirtual

Prints the information about the object.

Reimplemented from geom::GeomObject.

Definition at line 1503 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 geom::Rectangle::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 1496 of file geomObjects.h.

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

References printStr().

Here is the call graph for this function:

printStr()

std::string geom::Rectangle::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 740 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 << "Lengths (Lx, Ly) = (" << d_Lx << ", " << d_Ly << ")" << std::endl;
      oss << tabS << "Bounding circle radius = " << d_r << 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_Lx, d_Ly, geom::GeomObject::d_name, d_r, d_vertices, 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:

transform()

void geom::Rectangle::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 1368 of file geomObjects.h.

                                                                                                       {
      // Scale the dimensions
      d_Lx *= scale;
      d_Ly *= 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_Lx, d_Ly, d_r, d_vertices, d_x, and geom::mapSimilarity().

Here is the call graph for this function:

volume()

double geom::Rectangle::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 630 of file geomObjects.cpp.

                                   {
      return d_Lx * d_Ly;
    }

References d_Lx, and d_Ly.

wallContactQuery()

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

overridevirtual

Axis-aligned / vertex box surface (outward from filled rectangle).

Reimplemented from geom::GeomObject.

Definition at line 560 of file geomObjects.cpp.

                                                                {
      hit = WallContactHit();
      // Axis-aligned SDF from current bounding box (walls are typically AA).
      const auto bb = box();
      const double x0 = bb.first.d_x;
      const double y0 = bb.first.d_y;
      const double x1 = bb.second.d_x;
      const double y1 = bb.second.d_y;
      if (!(x1 > x0) || !(y1 > y0))
        return false;
 
      const double dx = std::max(x0 - x.d_x, x.d_x - x1);
      const double dy = std::max(y0 - x.d_y, x.d_y - y1);
      const bool outside = dx > 0. || dy > 0.;
 
      if (outside) {
        // Closest point on AABB, gap = exterior distance.
        util::Point c = x;
        if (x.d_x < x0)
          c.d_x = x0;
        else if (x.d_x > x1)
          c.d_x = x1;
        if (x.d_y < y0)
          c.d_y = y0;
        else if (x.d_y > y1)
          c.d_y = y1;
        c.d_z = x.d_z;
        const util::Point d = x - c;
        const double dist = d.length();
        if (!(dist > 1.e-16)) {
          // On a face: pick dominant exterior axis.
          if (dx >= dy) {
            hit.outward_n = util::Point(x.d_x < x0 ? -1. : 1., 0., 0.);
          } else {
            hit.outward_n = util::Point(0., x.d_y < y0 ? -1. : 1., 0.);
          }
          hit.signed_gap = 0.;
          hit.closest = c;
        } else {
          hit.outward_n = d / dist;
          hit.signed_gap = dist;
          hit.closest = c;
        }
      } else {
        // Inside: negative distance to nearest face.
        const double dl = x.d_x - x0;
        const double dr = x1 - x.d_x;
        const double db = x.d_y - y0;
        const double dt = y1 - x.d_y;
        const double m = std::min(std::min(dl, dr), std::min(db, dt));
        hit.signed_gap = -m;
        if (m == dl) {
          hit.outward_n = util::Point(-1., 0., 0.);
          hit.closest = util::Point(x0, x.d_y, x.d_z);
        } else if (m == dr) {
          hit.outward_n = util::Point(1., 0., 0.);
          hit.closest = util::Point(x1, x.d_y, x.d_z);
        } else if (m == db) {
          hit.outward_n = util::Point(0., -1., 0.);
          hit.closest = util::Point(x.d_x, y0, x.d_z);
        } else {
          hit.outward_n = util::Point(0., 1., 0.);
          hit.closest = util::Point(x.d_x, y1, x.d_z);
        }
      }
      hit.active = true;
      return true;
    }

References geom::WallContactHit::active, box(), geom::WallContactHit::closest, util::Point::d_x, util::Point::d_y, util::Point::d_z, util::Point::length(), geom::WallContactHit::outward_n, and geom::WallContactHit::signed_gap.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

d_Lx

double geom::Rectangle::d_Lx

Edge length of a rectangle in x-direction.

Definition at line 1263 of file geomObjects.h.

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

d_Ly

double geom::Rectangle::d_Ly

Edge length of a rectangle in y-direction.

Definition at line 1266 of file geomObjects.h.

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

d_r

double geom::Rectangle::d_r

Radius of bounding circle.

Definition at line 1269 of file geomObjects.h.

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

d_vertices

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

Vertices.

Definition at line 1257 of file geomObjects.h.

Referenced by mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::assertRectangleAnnulusValid(), box(), mesh_gen::anonymous_namespace{builtinGmshGeometry.cpp}::buildComplexRectangles2DOcc(), mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::embedPointInAnnulus2D(), isInside(), isNearBoundary(), operator=(), printStr(), Rectangle(), Rectangle(), and transform().

d_x

util::Point geom::Rectangle::d_x

Center.

Definition at line 1260 of file geomObjects.h.

Referenced by box(), center(), operator=(), 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