libMesh
Public Member Functions | Private Attributes | List of all members
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:
[legend]

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...
 

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 81 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.

Member Function Documentation

◆ inside()

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

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

Implements libMesh::TriangleInterface::Hole.

◆ n_points()

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

The number of geometric points which define the hole.

Implements libMesh::TriangleInterface::Hole.

◆ point()

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

Return the nth point defining the hole.

Implements libMesh::TriangleInterface::Hole.

Member Data Documentation

◆ _center

Point libMesh::TriangleInterface::PolygonHole::_center
private

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

Definition at line 101 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 113 of file mesh_triangle_holes.h.

◆ _radius

Real libMesh::TriangleInterface::PolygonHole::_radius
private

circular hole radius

Definition at line 106 of file mesh_triangle_holes.h.


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