geom::Ellipse Class Reference

Filled ellipse in the plane z = center.d_z, semi-axes in the xy plane. More...

#include <geomObjects.h>

Inheritance diagram for geom::Ellipse:

Collaboration diagram for geom::Ellipse:

Public Member Functions
	Ellipse ()
	Ellipse (double a, double b, double theta, util::Point x=util::Point(), std::string description="")
	Ellipse (const Ellipse &other)
Ellipse &	operator= (const Ellipse &other)
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.
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
	Checks if point is within given distance of this object.
bool	doesIntersect (const util::Point &x) const override
	Checks if point lies exactly on the boundary.
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.
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.
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
util::Point	d_x
	Center.
double	d_a
	Semi-axis along local x before rotation (in-plane)
double	d_b
	Semi-axis along local y before rotation (in-plane)
double	d_theta
	Counter-clockwise rotation about +z through the center (radians)
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

Filled ellipse in the plane z = center.d_z, semi-axes in the xy plane.

Definition at line 2747 of file geomObjects.h.

Constructor & Destructor Documentation

Ellipse() [1/3]

geom::Ellipse::Ellipse ( )

inline

Definition at line 2762 of file geomObjects.h.

      : GeomObject("ellipse", ""),
        d_x(util::Point()),
        d_a(0.),
        d_b(0.),
        d_theta(0.) {};

Ellipse() [2/3]

geom::Ellipse::Ellipse ( double  a, double  b, double  theta, util::Point  x = util::Point(), std::string  description = ""  )

inline

Parameters

a	Semi-axis (local x)
b	Semi-axis (local y)
theta	Rotation about +z (radians)
x	Center (z sets the plane of the ellipse)

Definition at line 2775 of file geomObjects.h.

      : GeomObject("ellipse", description),
        d_x(x),
        d_a(a),
        d_b(b),
        d_theta(theta) {};

Ellipse() [3/3]

geom::Ellipse::Ellipse ( const Ellipse &  other )

inline

Definition at line 2783 of file geomObjects.h.

      : GeomObject(other.d_name, other.d_description),
        d_x(other.d_x),
        d_a(other.d_a),
        d_b(other.d_b),
        d_theta(other.d_theta) {
      d_tags = other.d_tags;
    }

References geom::GeomObject::d_tags.

Member Function Documentation

boundingRadius()

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

                                         {
      return (d_a > d_b) ? d_a : d_b;
    }

References d_a, and d_b.

Referenced by isNear().

Here is the caller graph for this function:

box() [1/2]

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

                                                     {
      return box(0.);
    }

References box().

Referenced by box(), doesIntersect(), isInside(), 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::Ellipse::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 1537 of file geomObjects.cpp.

                                                                      {
 
      const double at = d_a + tol;
      const double bt = d_b + tol;
      const double ex = std::hypot(at * std::cos(d_theta), bt * std::sin(d_theta));
      const double ey = std::hypot(at * std::sin(d_theta), bt * std::cos(d_theta));
 
      return {util::Point(d_x.d_x - ex, d_x.d_y - ey, 0.),
              util::Point(d_x.d_x + ex, d_x.d_y + ey, 0.)};
    }

References d_a, d_b, d_theta, d_x, util::Point::d_x, and util::Point::d_y.

center()

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

overridevirtual

Computes the center of object.

Returns

Point Coordinates of center

Reimplemented from geom::GeomObject.

Definition at line 1529 of file geomObjects.cpp.

                                    {
      return d_x;
    }

References d_x.

doesIntersect() [1/2]

bool geom::Ellipse::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 1625 of file geomObjects.cpp.

                                                                              {
 
      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::Ellipse::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 1583 of file geomObjects.cpp.

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

References isNearBoundary().

Here is the call graph for this function:

inscribedRadius()

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

                                          {
      return (d_a < d_b) ? d_a : d_b;
    }

References d_a, and d_b.

isInside() [1/2]

bool geom::Ellipse::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 1587 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::Ellipse::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 1556 of file geomObjects.cpp.

                                                   {
      double u = 0., v = 0.;
      ellipseLocal(*this, x, u, v);
      return ellipseMetricInside(u, v, d_a, d_b);
    }

References d_a, and d_b.

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

Here is the caller graph for this function:

isNear() [1/2]

bool geom::Ellipse::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 1606 of file geomObjects.cpp.

                                                                                          {
 
      if (this->isInside(box))
        return true;
 
      for (auto p : geom::getCornerPoints(2, box)) {
        if (isNear(p, tol))
          return true;
      }
 
      auto dxc = geom::getCenter(2, box) - d_x;
      auto r = geom::inscribedRadiusInBox(2, box);
      if (util::isLess(dxc.length(), boundingRadius() + r + tol))
        return true;
 
      r = geom::circumscribedRadiusInBox(2, box);
      return util::isLess(dxc.length(), boundingRadius() + r + tol);
    }

References boundingRadius(), box(), geom::circumscribedRadiusInBox(), d_x, geom::getCenter(), geom::getCornerPoints(), geom::inscribedRadiusInBox(), isInside(), util::isLess(), and isNear().

Here is the call graph for this function:

isNear() [2/2]

bool geom::Ellipse::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 1566 of file geomObjects.cpp.

                                                                    {
      double u = 0., v = 0.;
      ellipseLocal(*this, x, u, v);
      return ellipseMetricInside(u, v, d_a + tol, d_b + tol);
    }

References d_a, and d_b.

Referenced by isNear().

Here is the caller graph for this function:

isNearBoundary()

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

overridevirtual

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

Definition at line 1572 of file geomObjects.cpp.

                                                                                                {
 
      double u = 0., v = 0.;
      ellipseLocal(*this, x, u, v);
      const bool inOuter = ellipseMetricInside(u, v, d_a + tol, d_b + tol);
      const bool inInner = ellipseMetricInside(u, v, d_a - tol, d_b - tol);
      if (within)
        return inOuter && !inInner;
      return inOuter;
    }

References d_a, and d_b.

Referenced by doesIntersect().

Here is the caller graph for this function:

isOutside() [1/2]

bool geom::Ellipse::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 1596 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::Ellipse::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 1562 of file geomObjects.cpp.

                                                    {
      return !isInside(x);
    }

References isInside().

Here is the call graph for this function:

operator=()

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

inline

Definition at line 2792 of file geomObjects.h.

                                             {
      if (this != &other) {
        d_tags = other.d_tags;
        d_x = other.d_x;
        d_a = other.d_a;
        d_b = other.d_b;
        d_theta = other.d_theta;
      }
      return *this;
    }

References d_a, d_b, geom::GeomObject::d_tags, d_theta, and d_x.

print() [1/2]

void geom::Ellipse::print ( ) const

inlineoverridevirtual

Prints the information about the object.

Reimplemented from geom::GeomObject.

Definition at line 2833 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::Ellipse::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 2832 of file geomObjects.h.

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

References printStr().

Here is the call graph for this function:

printStr()

std::string geom::Ellipse::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 1634 of file geomObjects.cpp.

                                                     {
 
      auto tabS = util::io::getTabS(nt);
 
      std::ostringstream oss;
 
      oss << tabS << "------- Ellipse --------" << std::endl << std::endl;
      oss << tabS << "Name = " << d_name << std::endl;
      oss << tabS << "Center = " << d_x.printStr(0, lvl) << std::endl;
      oss << tabS << "Semi-axes a, b = " << d_a << ", " << d_b << std::endl;
      oss << tabS << "Theta (rad) = " << d_theta << 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_a, d_b, geom::GeomObject::d_name, d_theta, d_x, util::io::getTabS(), util::io::printBoxStr(), 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::Ellipse::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 2803 of file geomObjects.h.

                                                                                   {
      const util::Point c0 = d_x;
      // Assumption: axis of rotation is the z-axis; d_theta is in-plane on top of world map
      d_a *= scale;
      d_b *= scale;
      d_theta += angle;
      d_x = mapSimilarity(c0, c0, translation, scale, angle, axis, rotationPoint);
    }

References d_a, d_b, d_theta, d_x, and geom::mapSimilarity().

Here is the call graph for this function:

volume()

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

                                 {
      return M_PI * d_a * d_b;
    }

References d_a, and d_b.

Field Documentation

d_a

double geom::Ellipse::d_a

Semi-axis along local x before rotation (in-plane)

Definition at line 2753 of file geomObjects.h.

Referenced by mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::addEllipseDiskOcc(), mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::assertEllipseAnnulusValid(), boundingRadius(), box(), mesh_gen::buildEllipseOcc(), inscribedRadius(), isInside(), isNear(), isNearBoundary(), operator=(), printStr(), transform(), and volume().

d_b

double geom::Ellipse::d_b

Semi-axis along local y before rotation (in-plane)

Definition at line 2756 of file geomObjects.h.

Referenced by mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::addEllipseDiskOcc(), mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::assertEllipseAnnulusValid(), boundingRadius(), box(), mesh_gen::buildEllipseOcc(), inscribedRadius(), isInside(), isNear(), isNearBoundary(), operator=(), printStr(), transform(), and volume().

d_theta

double geom::Ellipse::d_theta

Counter-clockwise rotation about +z through the center (radians)

Definition at line 2759 of file geomObjects.h.

Referenced by mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::addEllipseDiskOcc(), mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::assertEllipseAnnulusValid(), box(), mesh_gen::buildEllipseOcc(), geom::anonymous_namespace{geomObjects.cpp}::ellipseLocal(), operator=(), printStr(), and transform().

d_x

util::Point geom::Ellipse::d_x

Center.

Definition at line 2750 of file geomObjects.h.

Referenced by mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::addEllipseDiskOcc(), mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::assertEllipseAnnulusValid(), box(), mesh_gen::buildEllipseOcc(), center(), geom::anonymous_namespace{geomObjects.cpp}::ellipseLocal(), mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::embedPointInAnnulus2D(), isNear(), 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