geom::AnnulusGeomObject Class Reference

Defines annulus rectangle. More...

#include <complexGeomObjects.h>

Inheritance diagram for geom::AnnulusGeomObject:

Collaboration diagram for geom::AnnulusGeomObject:

Public Member Functions
	AnnulusGeomObject ()
	Constructor.
	AnnulusGeomObject (GeomObject *in, GeomObject *out, std::string description="")
	Constructor.
	AnnulusGeomObject (const AnnulusGeomObject &other)
	Copy constructor.
	~AnnulusGeomObject ()
	Destructor.
AnnulusGeomObject &	operator= (const AnnulusGeomObject &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
GeomObject *	d_outObj_p
	Outer object.
GeomObject *	d_inObj_p
	Inner object.
size_t	d_dim
	Dimension objects live in.
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 annulus rectangle.

Definition at line 27 of file complexGeomObjects.h.

Constructor & Destructor Documentation

AnnulusGeomObject() [1/3]

geom::AnnulusGeomObject::AnnulusGeomObject ( )

inline

Constructor.

Definition at line 42 of file complexGeomObjects.h.

      : GeomObject("annulus_object", ""),
        d_outObj_p(nullptr),
        d_inObj_p(nullptr),
        d_dim(0) {
    };

AnnulusGeomObject() [2/3]

geom::AnnulusGeomObject::AnnulusGeomObject ( GeomObject *  in, GeomObject *  out, std::string  description = ""  )

inline

Constructor.

Parameters

in	Inner object
out	Outer object
description	Description of object (e.g., further classification or any tag)

Definition at line 56 of file complexGeomObjects.h.

      : GeomObject("annulus_object", description),
        d_outObj_p(out),
        d_inObj_p(in),
        d_dim(0) {
      d_dim = getGeomTypeToDim(d_outObj_p->d_name); // assume all types have same dim
    };

References d_dim, geom::GeomObject::d_name, d_outObj_p, and geom::getGeomTypeToDim().

Here is the call graph for this function:

AnnulusGeomObject() [3/3]

geom::AnnulusGeomObject::AnnulusGeomObject ( const AnnulusGeomObject &  other )

inline

Copy constructor.

Parameters

other

Object to copy from

Note

This performs a deep copy of the inner and outer objects

Definition at line 69 of file complexGeomObjects.h.

      : GeomObject(other.d_name, other.d_description),
        d_outObj_p(nullptr),
        d_inObj_p(nullptr),
        d_dim(other.d_dim) {
      // Copy tags from base class
      d_tags = other.d_tags;
 
      // Deep copy inner and outer objects using utility function
      d_inObj_p = createGeomDeepCopy(other.d_inObj_p);
      d_outObj_p = createGeomDeepCopy(other.d_outObj_p);
    }

References geom::createGeomDeepCopy(), d_inObj_p, d_outObj_p, and geom::GeomObject::d_tags.

Here is the call graph for this function:

~AnnulusGeomObject()

geom::AnnulusGeomObject::~AnnulusGeomObject ( )

inline

Destructor.

Definition at line 85 of file complexGeomObjects.h.

                         {
      delete d_inObj_p;
      delete d_outObj_p;
    }

References d_inObj_p, and d_outObj_p.

Member Function Documentation

boundingRadius()

double geom::AnnulusGeomObject::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 77 of file complexGeomObjects.cpp.

                                                   {
 
      return d_outObj_p->boundingRadius();
    }

References geom::GeomObject::boundingRadius(), and d_outObj_p.

Here is the call graph for this function:

box() [1/2]

std::pair< util::Point, util::Point > geom::AnnulusGeomObject::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 62 of file complexGeomObjects.cpp.

                     {
      return d_outObj_p->box();
    }

References geom::GeomObject::box(), and d_outObj_p.

Referenced by 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::AnnulusGeomObject::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 67 of file complexGeomObjects.cpp.

                                      {
      return d_outObj_p->box(tol);
    }

References geom::GeomObject::box(), and d_outObj_p.

Here is the call graph for this function:

center()

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

overridevirtual

Computes the center of object.

Returns

Point Coordinates of center

Reimplemented from geom::GeomObject.

Definition at line 48 of file complexGeomObjects.cpp.

                                              {
 
      // we use the formula for centroid of composite objects
      // x = sum_i sign(i) V_i x_i / sum_i sign(i) V_i
      // where sign(i) = +1 if object is filling
      // sign(i) = -1 if object is empty
      auto vol = volume();
      if (util::isGreater(vol, 0.))
        return (1./vol) * (d_outObj_p->volume() * d_outObj_p->center()
                - d_inObj_p->volume() * d_inObj_p->center());
      else
        return d_outObj_p->center();
    }

References geom::GeomObject::center(), d_inObj_p, d_outObj_p, util::isGreater(), geom::GeomObject::volume(), and volume().

Referenced by mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::embedPointInAnnulus2D(), mesh_gen::anonymous_namespace{annulusMesh3D.cpp}::embedPointInAnnulus3D(), printStr(), and transform().

Here is the call graph for this function:

Here is the caller graph for this function:

doesIntersect() [1/2]

bool geom::AnnulusGeomObject::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 142 of file complexGeomObjects.cpp.

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

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

Here is the call graph for this function:

doesIntersect() [2/2]

bool geom::AnnulusGeomObject::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 109 of file complexGeomObjects.cpp.

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

References isNearBoundary().

Here is the call graph for this function:

inscribedRadius()

double geom::AnnulusGeomObject::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 72 of file complexGeomObjects.cpp.

                                                    {
 
      return d_outObj_p->inscribedRadius();
    }

References d_outObj_p, and geom::GeomObject::inscribedRadius().

Here is the call graph for this function:

isInside() [1/2]

bool geom::AnnulusGeomObject::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 115 of file complexGeomObjects.cpp.

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

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

Here is the call graph for this function:

isInside() [2/2]

bool geom::AnnulusGeomObject::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 83 of file complexGeomObjects.cpp.

                                                        {
 
      // should be outside inner object and inside outer object
      return !d_inObj_p->isInside(x) && d_outObj_p->isInside(x);
    }

References d_inObj_p, d_outObj_p, and geom::GeomObject::isInside().

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::AnnulusGeomObject::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 135 of file complexGeomObjects.cpp.

                                     {
 
      return d_outObj_p->isNear(box, tol) || d_inObj_p->isNear(box, tol);
    }

References box(), d_inObj_p, d_outObj_p, and geom::GeomObject::isNear().

Here is the call graph for this function:

isNear() [2/2]

bool geom::AnnulusGeomObject::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 94 of file complexGeomObjects.cpp.

                                                                            {
 
      return d_outObj_p->isNear(x, tol) || d_inObj_p->isNear(x, tol);
    }

References d_inObj_p, d_outObj_p, and geom::GeomObject::isNear().

Here is the call graph for this function:

isNearBoundary()

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

overridevirtual

cons

cons

Reimplemented from geom::GeomObject.

Definition at line 100 of file complexGeomObjects.cpp.

                                                                          {
 
      return d_outObj_p->isNearBoundary(x, tol, within) ||
             d_inObj_p->isNearBoundary(x, tol, within);
    }

References d_inObj_p, d_outObj_p, and geom::GeomObject::isNearBoundary().

Referenced by doesIntersect().

Here is the call graph for this function:

Here is the caller graph for this function:

isOutside() [1/2]

bool geom::AnnulusGeomObject::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 125 of file complexGeomObjects.cpp.

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

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

Here is the call graph for this function:

isOutside() [2/2]

bool geom::AnnulusGeomObject::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 90 of file complexGeomObjects.cpp.

                                                         {
      return !isInside(x);
    }

References isInside().

Here is the call graph for this function:

operator=()

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

inline

Assignment operator.

Parameters

other

Object to copy from

Returns

Reference to this object

Definition at line 95 of file complexGeomObjects.h.

                                                                 {
      if (this != &other) {
        // Clean up existing objects
        delete d_inObj_p;
        delete d_outObj_p;
        d_inObj_p = nullptr;
        d_outObj_p = nullptr;
 
        // Copy base class members
        d_tags = other.d_tags;
        d_dim = other.d_dim;
 
        // Deep copy inner and outer objects using utility function
        d_inObj_p = createGeomDeepCopy(other.d_inObj_p);
        d_outObj_p = createGeomDeepCopy(other.d_outObj_p);
      }
      return *this;
    }

References geom::createGeomDeepCopy(), d_dim, d_inObj_p, d_outObj_p, and geom::GeomObject::d_tags.

Here is the call graph for this function:

print() [1/2]

void geom::AnnulusGeomObject::print ( ) const

inlineoverridevirtual

Prints the information about the object.

Reimplemented from geom::GeomObject.

Definition at line 257 of file complexGeomObjects.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::AnnulusGeomObject::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 250 of file complexGeomObjects.h.

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

References printStr().

Here is the call graph for this function:

printStr()

std::string geom::AnnulusGeomObject::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 154 of file complexGeomObjects.cpp.

                                                     {
 
      auto tabS = util::io::getTabS(nt);
 
      std::ostringstream oss;
 
      oss << tabS << "------- AnnulusGeomObject --------" << std::endl
          << std::endl;
      oss << tabS << "Name = " << d_name << std::endl;
      oss << tabS << "Center = " << center().printStr() << std::endl;
      oss << tabS << "Inner object info:" << std::endl;
      oss << d_inObj_p->printStr(nt + 1, lvl);
      oss << tabS << "Outer object info:" << std::endl;
      oss << d_outObj_p->printStr(nt + 1, lvl);
 
      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(), center(), d_inObj_p, geom::GeomObject::d_name, d_outObj_p, util::io::getTabS(), util::io::printBoxStr(), geom::GeomObject::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::AnnulusGeomObject::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. If rotationPoint is null and both inner and outer exist, pivot is center() (composite centroid of the annular solid). If only one child is present, that child’s center() is used.

Reimplemented from geom::GeomObject.

Definition at line 119 of file complexGeomObjects.h.

                                                           {
      const util::Point *pivot = rotationPoint;
      util::Point pivotStore;
      if (pivot == nullptr) {
        if (d_inObj_p && d_outObj_p) {
          pivotStore = center();
          pivot = &pivotStore;
        } else if (d_inObj_p) {
          pivotStore = d_inObj_p->center();
          pivot = &pivotStore;
        } else if (d_outObj_p) {
          pivotStore = d_outObj_p->center();
          pivot = &pivotStore;
        }
      }
      if (d_inObj_p) d_inObj_p->transform(translation, scale, angle, axis, pivot);
      if (d_outObj_p) d_outObj_p->transform(translation, scale, angle, axis, pivot);
    }

References geom::GeomObject::center(), center(), d_inObj_p, d_outObj_p, and geom::GeomObject::transform().

Here is the call graph for this function:

volume()

double geom::AnnulusGeomObject::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 44 of file complexGeomObjects.cpp.

                                           {
      return d_outObj_p->volume() - d_inObj_p->volume();
    }

References d_inObj_p, d_outObj_p, and geom::GeomObject::volume().

Referenced by center().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

d_dim

size_t geom::AnnulusGeomObject::d_dim

Dimension objects live in.

Definition at line 36 of file complexGeomObjects.h.

Referenced by AnnulusGeomObject(), mesh_gen::buildAnnulus2DInCurrentModel(), mesh_gen::buildAnnulus3DInCurrentModel(), doesIntersect(), isInside(), isOutside(), anonymous_namespace{testMeshGen.cpp}::meshDimForBuiltin(), and operator=().

d_inObj_p

GeomObject* geom::AnnulusGeomObject::d_inObj_p

Inner object.

Definition at line 33 of file complexGeomObjects.h.

Referenced by AnnulusGeomObject(), mesh_gen::buildAnnulus2DInCurrentModel(), mesh_gen::buildAnnulus3DInCurrentModel(), mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::buildCircleAnnulus2D(), mesh_gen::anonymous_namespace{annulusMesh3D.cpp}::buildCuboidAnnulus3D(), mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::buildEllipseAnnulus2D(), mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::buildRectangleAnnulus2D(), mesh_gen::anonymous_namespace{annulusMesh3D.cpp}::buildSphereAnnulus3D(), center(), mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::embedPointInAnnulus2D(), mesh_gen::anonymous_namespace{annulusMesh3D.cpp}::embedPointInAnnulus3D(), isInside(), isNear(), isNear(), isNearBoundary(), operator=(), printStr(), transform(), volume(), and ~AnnulusGeomObject().

d_outObj_p

GeomObject* geom::AnnulusGeomObject::d_outObj_p

Outer object.

Definition at line 30 of file complexGeomObjects.h.

Referenced by AnnulusGeomObject(), AnnulusGeomObject(), boundingRadius(), box(), box(), mesh_gen::buildAnnulus2DInCurrentModel(), mesh_gen::buildAnnulus3DInCurrentModel(), mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::buildCircleAnnulus2D(), mesh_gen::anonymous_namespace{annulusMesh3D.cpp}::buildCuboidAnnulus3D(), mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::buildEllipseAnnulus2D(), mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::buildRectangleAnnulus2D(), mesh_gen::anonymous_namespace{annulusMesh3D.cpp}::buildSphereAnnulus3D(), center(), mesh_gen::anonymous_namespace{annulusMesh2D.cpp}::embedPointInAnnulus2D(), mesh_gen::anonymous_namespace{annulusMesh3D.cpp}::embedPointInAnnulus3D(), inscribedRadius(), isInside(), isNear(), isNear(), isNearBoundary(), operator=(), printStr(), transform(), volume(), and ~AnnulusGeomObject().

---

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

• /home/user/project/src/geom/complexGeomObjects.h
• /home/user/project/src/geom/complexGeomObjects.cpp