Defines complex geometrical object. More...

#include <complexGeomObjects.h>

Inheritance diagram for geom::ComplexGeomObject:

Collaboration diagram for geom::ComplexGeomObject:

Public Member Functions
	ComplexGeomObject ()
	Constructor.

	ComplexGeomObject (std::vector< std::shared_ptr< GeomObject > > &obj, std::vector< std::string > obj_flag, std::string description="")
	Constructor.

	ComplexGeomObject (const ComplexGeomObject &other)
	Copy constructor.

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

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

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< std::shared_ptr< GeomObject > >	d_obj
	Object.

std::vector< std::string >	d_objFlag
	Object flag.

std::vector< int >	d_objFlagInt
	Object integer flags. Here, +1 means object is filling and -1 means object is void.

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 complex geometrical object.

Definition at line 264 of file complexGeomObjects.h.

Constructor & Destructor Documentation

◆ ComplexGeomObject() [1/3]

geom::ComplexGeomObject::ComplexGeomObject ( )

inline

Constructor.

Definition at line 292 of file complexGeomObjects.h.

292 : GeomObject("complex", ""), d_dim(0) {

293 };

geom::ComplexGeomObject::d_dim

size_t d_dim

Dimension objects live in.

Definition complexGeomObjects.h:286

geom::GeomObject::GeomObject

GeomObject(std::string name="", std::string description="")

Constructor.

Definition geomObjects.h:140

◆ ComplexGeomObject() [2/3]

geom::ComplexGeomObject::ComplexGeomObject	(	std::vector< std::shared_ptr< GeomObject > > &	obj,
		std::vector< std::string >	obj_flag,
		std::string	description = `""`
	)

inline

Constructor.

Parameters

obj	Vector of geometrical objects
obj_flag	Specifies which objects are filling and which are void
description	Description of object (e.g., further classification or any tag)

Definition at line 302 of file complexGeomObjects.h.

      : GeomObject("complex", description),
        d_obj(obj),
        d_objFlag(obj_flag),
        d_dim(0) {
 
      d_dim = getGeomTypeToDim(d_obj[0]->d_name); // assume all types have same dim
 
      for (const auto &s: d_objFlag)
        if (s == "plus")
          d_objFlagInt.push_back(1);
        else if (s == "minus")
          d_objFlagInt.push_back(-1);
        else {
          throw std::invalid_argument(
              util::io::Msg()
              << "Error: Check object flag " + s +
                     " passed to create ComplexGeomObject\n");
        }
    };

References d_dim, geom::GeomObject::d_name, d_obj, d_objFlag, d_objFlagInt, and geom::getGeomTypeToDim().

Here is the call graph for this function:

◆ ComplexGeomObject() [3/3]

geom::ComplexGeomObject::ComplexGeomObject ( const ComplexGeomObject & other )

inline

Copy constructor.

Parameters

other Object to copy from

Definition at line 329 of file complexGeomObjects.h.

      : GeomObject(other.d_name, other.d_description),
        d_objFlag(other.d_objFlag),
        d_objFlagInt(other.d_objFlagInt),
        d_dim(other.d_dim) {
      d_tags = other.d_tags;
 
      // Deep copy each geometric object
      d_obj.reserve(other.d_obj.size());
      for (const auto& obj : other.d_obj) {
        if (obj) {
          // Create a raw pointer copy first
          GeomObject* raw_copy = createGeomDeepCopy(obj.get());
          // Convert to shared_ptr and store
          d_obj.push_back(std::shared_ptr<GeomObject>(raw_copy));
        } else {
          d_obj.push_back(nullptr);
        }
      }
    }

References geom::createGeomDeepCopy(), d_obj, and geom::GeomObject::d_tags.

Here is the call graph for this function:

Member Function Documentation

◆ boundingRadius()

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

                                                   {
 
      auto box = this->box();
      return 0.5 * (box.first - box.second).length();
    }

References box().

Here is the call graph for this function:

◆ box() [1/2]

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

                     {
 
      return box(0.);
    }

References box().

Referenced by boundingRadius(), box(), doesIntersect(), inscribedRadius(), 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::ComplexGeomObject::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 223 of file complexGeomObjects.cpp.

                                      {
 
      auto p1 = d_obj[0]->box(tol).first;
      auto p2 = d_obj[0]->box(tol).second;
 
      for (size_t i = 1; i < d_objFlag.size(); i++) {
 
        auto q1 = d_obj[i]->box(tol).first;
        auto q2 = d_obj[i]->box(tol).second;
 
        for (size_t i = 0; i < 3; i++) {
          if (q1[i] < p1[i])
            p1[i] = q1[i];
          if (q2[i] > p2[i])
            p2[i] = q2[i];
        }
      }
 
      return std::make_pair(p1, p2);
    }

References d_obj, and d_objFlag.

◆ center()

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

overridevirtual

Computes the center of object.

Returns: Point Coordinates of center

Reimplemented from geom::GeomObject.

Definition at line 194 of file complexGeomObjects.cpp.

                                              {
 
      // use formula for centroid of composite objects
      auto vol = volume();
      if (util::isGreater(vol, 0.)) {
        auto center = util::Point();
        for (size_t i = 0; i < d_objFlag.size(); i++)
          center += d_obj[i]->volume() * d_objFlagInt[i] * d_obj[i]->center();
        return (1./vol) * center;
      }
      else {
 
        // find biggest object that has positive d_objFlagInt
        // (that is it is a filling and not void object)
        std::vector<double> vol_vec(d_obj.size());
        for (size_t i = 0; i < d_obj.size(); i++)
          vol_vec[i] = d_obj[i]->volume() * d_objFlagInt[i];
 
        auto max_vol_obj = util::methods::maxIndex(vol_vec);
        return d_obj[max_vol_obj]->center();
      }
    }

References center(), d_obj, d_objFlag, d_objFlagInt, util::isGreater(), util::methods::maxIndex(), and volume().

Referenced by center(), printStr(), and transform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doesIntersect() [1/2]

bool geom::ComplexGeomObject::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 348 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::ComplexGeomObject::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 308 of file complexGeomObjects.cpp.

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

References isNearBoundary().

Here is the call graph for this function:

◆ inscribedRadius()

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

                                                    {
 
      auto box = this->box();
      return 0.5 * (box.first - box.second).length();
    }

References box().

Here is the call graph for this function:

◆ isInside() [1/2]

bool geom::ComplexGeomObject::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 314 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::ComplexGeomObject::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 258 of file complexGeomObjects.cpp.

                                                        {
 
      // point inside means x should be inside in the object with plus flag and
      // outside in the object with minus flag
      bool point_inside = d_obj[0]->isInside(x);
      for (size_t i = 1; i < d_objFlag.size(); i++) {
 
        const auto &obj_i = d_obj[i];
        if (d_objFlagInt[i] < 0)
          point_inside = point_inside and !obj_i->isInside(x);
        else
          point_inside = point_inside or obj_i->isInside(x);
      }
 
      return point_inside;
    }

References d_obj, d_objFlag, and d_objFlagInt.

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

Here is the caller graph for this function:

◆ isNear() [1/2]

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

                                     {
 
      bool is_near = d_obj[0]->isNear(box, tol);
      for (size_t i = 1; i < d_objFlag.size(); i++) {
 
        const auto &obj_i = d_obj[i];
        is_near = is_near or obj_i->isNear(box, tol);
      }
 
      return is_near;
    }

References box(), d_obj, and d_objFlag.

Here is the call graph for this function:

◆ isNear() [2/2]

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

                                                                            {
 
      bool is_near = d_obj[0]->isNear(x, tol);
      for (size_t i = 1; i < d_objFlag.size(); i++) {
 
        const auto &obj_i = d_obj[i];
        is_near = is_near or obj_i->isNear(x, tol);
      }
 
      return is_near;
    }

References d_obj, and d_objFlag.

◆ isNearBoundary()

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

overridevirtual

cons

Reimplemented from geom::GeomObject.

Definition at line 293 of file complexGeomObjects.cpp.

                                                                          {
 
      bool is_near = d_obj[0]->isNearBoundary(x, tol, within);
      for (size_t i = 1; i < d_objFlag.size(); i++) {
 
        const auto &obj_i = d_obj[i];
        is_near = is_near or obj_i->isNearBoundary(x, tol, within);
      }
 
      return is_near;
    }

References d_obj, and d_objFlag.

Referenced by doesIntersect().

Here is the caller graph for this function:

◆ isOutside() [1/2]

bool geom::ComplexGeomObject::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 324 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::ComplexGeomObject::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 276 of file complexGeomObjects.cpp.

                                                         {
      return !isInside(x);
    }

References isInside().

Here is the call graph for this function:

◆ operator=()

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

inline

Assignment operator.

Parameters

other Object to copy from

Returns: Reference to this object

Definition at line 355 of file complexGeomObjects.h.

                                                                 {
      if (this != &other) {
        // Copy base class members
        d_tags = other.d_tags;
        
        // Copy flags and dimension
        d_objFlag = other.d_objFlag;
        d_objFlagInt = other.d_objFlagInt;
        d_dim = other.d_dim;
 
        // Deep copy each geometric object
        d_obj.clear();
        d_obj.reserve(other.d_obj.size());
        for (const auto& obj : other.d_obj) {
          if (obj) {
            // Create a raw pointer copy first
            GeomObject* raw_copy = createGeomDeepCopy(obj.get());
            // Convert to shared_ptr and store
            d_obj.push_back(std::shared_ptr<GeomObject>(raw_copy));
          } else {
            d_obj.push_back(nullptr);
          }
        }
      }
      return *this;
    }

References geom::createGeomDeepCopy(), d_dim, d_obj, d_objFlag, d_objFlagInt, and geom::GeomObject::d_tags.

Here is the call graph for this function:

◆ print() [1/2]

void geom::ComplexGeomObject::print ( ) const

inlineoverridevirtual

Prints the information about the object.

Reimplemented from geom::GeomObject.

Definition at line 516 of file complexGeomObjects.h.

516{ print(0, 0); };

geom::ComplexGeomObject::print

void print() const override

Prints the information about the object.

Definition complexGeomObjects.h:516

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::ComplexGeomObject::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 509 of file complexGeomObjects.h.

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

References printStr().

Here is the call graph for this function:

◆ printStr()

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

                                                     {
 
      auto tabS = util::io::getTabS(nt);
 
      std::ostringstream oss;
 
      oss << tabS << "------- ComplexGeomObject --------" << std::endl
          << std::endl;
      oss << tabS << "Name = " << d_name << std::endl;
      oss << tabS << "Center = " << center().printStr() << std::endl;
      oss << tabS << "Object info:" << std::endl;
      auto ocount = 0;
      for (const auto &p: d_obj) {
        oss << tabS << "Object id: " << ocount << std::endl;
        oss << tabS << "Object flag: " << d_objFlag[ocount] << std::endl;
        oss << tabS << "Object int flag: " << d_objFlagInt[ocount] << std::endl;
        oss << p->printStr(nt + 1, lvl);
        ocount++;
      }
 
      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(), geom::GeomObject::d_name, d_obj, d_objFlag, d_objFlagInt, 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::ComplexGeomObject::transform	(	const util::Point &	translation,
		const double &	scale,
		const double &	angle,
		const util::Point &	axis,
		const util::Point *	rotationPoint
	)

inlineoverridevirtual

If rotationPoint is null, pivot is center() (signed-volume centroid of the composite).

Reimplemented from geom::GeomObject.

Definition at line 385 of file complexGeomObjects.h.

                                                           {
      const util::Point *pivot = rotationPoint;
      util::Point pivotStore;
      if (pivot == nullptr) {
        pivotStore = center();
        pivot = &pivotStore;
      }
      for (auto &obj : d_obj) {
        if (obj) obj->transform(translation, scale, angle, axis, pivot);
      }
    }

References center(), and d_obj.

Here is the call graph for this function:

◆ volume()

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

                                           {
 
      double volume = 0.;
      for (size_t i = 0; i < d_objFlag.size(); i++)
        volume += d_obj[i]->volume() * d_objFlagInt[i];
 
      return volume;
    }

References d_obj, d_objFlag, d_objFlagInt, and volume().

Referenced by center(), and volume().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ d_dim

size_t geom::ComplexGeomObject::d_dim

Dimension objects live in.

Definition at line 286 of file complexGeomObjects.h.

Referenced by ComplexGeomObject(), doesIntersect(), isInside(), isOutside(), and operator=().

◆ d_obj

std::vector<std::shared_ptr<GeomObject> > geom::ComplexGeomObject::d_obj

Object.

Definition at line 268 of file complexGeomObjects.h.

Referenced by box(), mesh_gen::anonymous_namespace{builtinGmshGeometry.cpp}::buildComplexRectangles2DOcc(), center(), ComplexGeomObject(), ComplexGeomObject(), isInside(), isNear(), isNear(), isNearBoundary(), operator=(), printStr(), transform(), and volume().

◆ d_objFlag

std::vector<std::string> geom::ComplexGeomObject::d_objFlag

Object flag.

Ordering of objects is important. To describe a rectangle with circular hole, we will have d_obj = {rectangle, circle} and have flag = {plus, minus}. This means final object is rectangle - circle

Definition at line 278 of file complexGeomObjects.h.

Referenced by box(), center(), ComplexGeomObject(), isInside(), isNear(), isNear(), isNearBoundary(), operator=(), printStr(), and volume().

◆ d_objFlagInt

std::vector<int> geom::ComplexGeomObject::d_objFlagInt

Object integer flags. Here, +1 means object is filling and -1 means object is void.

Definition at line 283 of file complexGeomObjects.h.

Referenced by mesh_gen::anonymous_namespace{builtinGmshGeometry.cpp}::buildComplexRectangles2DOcc(), center(), ComplexGeomObject(), isInside(), operator=(), printStr(), and volume().

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

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ ComplexGeomObject() [1/3]

◆ ComplexGeomObject() [2/3]

◆ ComplexGeomObject() [3/3]

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_dim

◆ d_obj

◆ d_objFlag

◆ d_objFlagInt