libMesh::TriangleInterface::PolygonHole Class Reference

A concrete instantiation of the Hole class that describes polygonal (triangular, square, pentagonal, ...) holes. More...

#include <mesh_triangle_holes.h>

Inheritance diagram for libMesh::TriangleInterface::PolygonHole:

Public Member Functions
	PolygonHole (const Point &center, Real radius, unsigned int n_points)
	Constructor specifying the center, radius, and number of points which comprise the hole. More...
virtual unsigned int	n_points () const override
	The number of geometric points which define the hole. More...
virtual Point	point (const unsigned int n) const override
	Return the nth point defining the hole. More...
virtual Point	inside () const override
	Return an (arbitrary) point which lies inside the hole. More...
virtual std::vector< unsigned int >	segment_indices () const
	Starting indices of points for a hole with multiple disconnected boundaries. More...

Private Attributes
Point	_center
	(x,y) location of the center of the hole More...
Real	_radius
	circular hole radius More...
unsigned int	_n_points
	number of points used to describe the hole. More...

Detailed Description

A concrete instantiation of the Hole class that describes polygonal (triangular, square, pentagonal, ...) holes.

Definition at line 97 of file mesh_triangle_holes.h.

Constructor & Destructor Documentation

PolygonHole()

libMesh::TriangleInterface::PolygonHole::PolygonHole	(	const Point &	center,
		Real	radius,
		unsigned int	n_points
	)

Constructor specifying the center, radius, and number of points which comprise the hole.

The points will all lie on a circle of radius r.

Definition at line 32 of file mesh_triangle_holes.C.

                                                                      :
  _center(center),
  _radius(radius),
  _n_points(n_points_in)
{}

Member Function Documentation

inside()

Point libMesh::TriangleInterface::PolygonHole::inside ( ) const

overridevirtual

Return an (arbitrary) point which lies inside the hole.

Implements libMesh::TriangleInterface::Hole.

Definition at line 56 of file mesh_triangle_holes.C.

{
  // The center of the hole is definitely inside.
  return _center;
}

n_points()

unsigned int libMesh::TriangleInterface::PolygonHole::n_points ( ) const

overridevirtual

The number of geometric points which define the hole.

Implements libMesh::TriangleInterface::Hole.

Definition at line 41 of file mesh_triangle_holes.C.

{
  return _n_points;
}

point()

Point libMesh::TriangleInterface::PolygonHole::point ( const unsigned int  n ) const

overridevirtual

Return the nth point defining the hole.

Implements libMesh::TriangleInterface::Hole.

Definition at line 46 of file mesh_triangle_holes.C.

{
  // The nth point lies at the angle theta = 2 * pi * n / _n_points
  const Real theta = static_cast<Real>(n) * 2.0 * libMesh::pi / static_cast<Real>(_n_points);
 
  return Point(_center(0) + _radius*std::cos(theta), // x=r*cos(theta)
               _center(1) + _radius*std::sin(theta), // y=r*sin(theta)
               0.);
}

References libMesh::pi, and libMesh::Real.

segment_indices()

virtual std::vector<unsigned int> libMesh::TriangleInterface::Hole::segment_indices ( ) const

inlinevirtualinherited

Starting indices of points for a hole with multiple disconnected boundaries.

Reimplemented in libMesh::TriangleInterface::ArbitraryHole.

Definition at line 79 of file mesh_triangle_holes.h.

  {
    // default to only one enclosing boundary
    std::vector<unsigned int> seg;
    seg.push_back(0);
    seg.push_back(n_points());
    return seg;
  }

References libMesh::TriangleInterface::Hole::n_points().

Member Data Documentation

_center

Point libMesh::TriangleInterface::PolygonHole::_center

private

(x,y) location of the center of the hole

Definition at line 117 of file mesh_triangle_holes.h.

_n_points

unsigned int libMesh::TriangleInterface::PolygonHole::_n_points

private

number of points used to describe the hole.

The actual points can be generated knowing the center and radius. For example, n_points=3 would generate a triangular hole.

Definition at line 129 of file mesh_triangle_holes.h.

_radius

Real libMesh::TriangleInterface::PolygonHole::_radius

private

circular hole radius

Definition at line 122 of file mesh_triangle_holes.h.

---

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

• include/mesh/mesh_triangle_holes.h
• src/mesh/mesh_triangle_holes.C