libMesh::TriangulatorInterface::ArbitraryHole Class Reference

Another concrete instantiation of the hole, this one should be sufficiently general for most non-polygonal purposes. More...

#include <mesh_triangle_holes.h>

Inheritance diagram for libMesh::TriangulatorInterface::ArbitraryHole:

Public Member Functions
	ArbitraryHole (const Point &center, std::vector< Point > points)
	The fastest constructor requires a point which lies in the interior of the hole and a reference to a vector of Points defining the hole. More...
	ArbitraryHole (const Point &center, std::vector< Point > points, std::vector< unsigned int > segment_indices)
	ArbitraryHole (std::vector< Point > points)
	If we don't know a center a priori then we can calculate one. More...
	ArbitraryHole (const Hole &orig)
	We can also construct an ArbitraryHole which just copies a hole of any other type. More...
	ArbitraryHole (const ArbitraryHole &orig)=default
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 override
	Starting indices of points for a hole with multiple disconnected boundaries. More...
const std::vector< Point > &	get_points () const
void	set_points (std::vector< Point > points)
virtual unsigned int	n_midpoints () const
	The number of geometric midpoints along each of the sides defining the hole. More...
virtual Point	midpoint (const unsigned int, const unsigned int) const
	Return the midpoint m along the side n defining the hole. More...
bool	contains (Point p) const
	Return true iff p lies inside the hole. More...
Real	area () const
	Return the area of the hole. More...
RealGradient	areavec () const
	Return a vector with right-hand-rule orientation and length of twice area() squared. More...
virtual void	set_refine_boundary_allowed (bool refine_bdy_allowed)
	Set whether or not a triangulator is allowed to refine the hole boundary when refining the mesh interior. More...
virtual bool	refine_boundary_allowed () const
	Get whether or not the triangulation is allowed to refine the mesh boundary when refining the interior. More...

Protected Member Functions
std::vector< Real >	find_ray_intersections (Point ray_start, Point ray_target) const
	Helper function for contains(), also useful for MeshedHole::inside() More...
Point	calculate_inside_point () const
	Calculate an inside point based on our boundary. More...

Protected Attributes
bool	_refine_bdy_allowed = true
	Whether to allow boundary refinement. More...

Private Attributes
Point	_center
	arbitrary (x,y) location inside the hole More...
std::vector< Point >	_points
	Reference to the vector of points which makes up the hole. More...
std::vector< unsigned int >	_segment_indices

Detailed Description

Another concrete instantiation of the hole, this one should be sufficiently general for most non-polygonal purposes.

The user supplies, at the time of construction, a reference to a vector of Points which defines the hole (in order of connectivity) and an arbitrary Point which lies inside the hole.

Definition at line 264 of file mesh_triangle_holes.h.

Constructor & Destructor Documentation

ArbitraryHole() [1/5]

libMesh::TriangulatorInterface::ArbitraryHole::ArbitraryHole	(	const Point &	center,
		std::vector< Point >	points
	)

The fastest constructor requires a point which lies in the interior of the hole and a reference to a vector of Points defining the hole.

Definition at line 383 of file mesh_triangle_holes.C.

References _points, and _segment_indices.

  : _center(center),
    _points(std::move(points))
{
  _segment_indices.push_back(0);
  _segment_indices.push_back(_points.size());
}

ArbitraryHole() [2/5]

libMesh::TriangulatorInterface::ArbitraryHole::ArbitraryHole	(	const Point &	center,
		std::vector< Point >	points,
		std::vector< unsigned int >	segment_indices
	)

Definition at line 393 of file mesh_triangle_holes.C.

  : _center(center),
    _points(std::move(points)),
    _segment_indices(std::move(segment_indices))
{}

ArbitraryHole() [3/5]

libMesh::TriangulatorInterface::ArbitraryHole::ArbitraryHole

(

std::vector< Point >

points

)

If we don't know a center a priori then we can calculate one.

Definition at line 402 of file mesh_triangle_holes.C.

References _center, _points, _segment_indices, and libMesh::TriangulatorInterface::Hole::calculate_inside_point().

  : _points(std::move(points))
{
  _segment_indices.push_back(0);
  _segment_indices.push_back(_points.size());
  _center = this->calculate_inside_point();
}

ArbitraryHole() [4/5]

libMesh::TriangulatorInterface::ArbitraryHole::ArbitraryHole

(

const Hole &

orig

)

We can also construct an ArbitraryHole which just copies a hole of any other type.

Definition at line 411 of file mesh_triangle_holes.C.

References _points, libMesh::make_range(), libMesh::TriangulatorInterface::Hole::n_points(), and libMesh::TriangulatorInterface::Hole::point().

  : _center(orig.inside())
{
  const unsigned int np = orig.n_points();
  _points.reserve(np);
  for (auto i : make_range(np))
    _points.push_back(orig.point(i));
}

ArbitraryHole() [5/5]

libMesh::TriangulatorInterface::ArbitraryHole::ArbitraryHole ( const ArbitraryHole &  orig )

default

Member Function Documentation

area()

Real libMesh::TriangulatorInterface::Hole::area ( ) const

inherited

Return the area of the hole.

This method currently does not take any higher-order hole geometry into account, but treats the hole as a polygon.

Definition at line 184 of file mesh_triangle_holes.C.

References libMesh::TriangulatorInterface::Hole::areavec(), and libMesh::TypeVector< T >::norm().

Referenced by libMesh::TriangulatorInterface::MeshedHole::MeshedHole(), and MeshTriangulationTest::testTriangleHoleArea().

{
  return this->areavec().norm() / 2;
}

areavec()

RealGradient libMesh::TriangulatorInterface::Hole::areavec ( ) const

inherited

Return a vector with right-hand-rule orientation and length of twice area() squared.

This is useful for determining orientation of non-planar or non-counter-clockwise holes.

This method currently does not take any higher-order hole geometry into account, but treats the hole as a polygon.

Definition at line 190 of file mesh_triangle_holes.C.

References libMesh::TypeVector< T >::cross().

Referenced by libMesh::TriangulatorInterface::Hole::area().

{
  const unsigned int np = this->n_points();

  if (np < 3)
    return 0;

  const Point p0 = this->point(0);

  // Every segment (p_{i-1},p_i) from i=2 on defines a triangle w.r.t.
  // p_0.  Add up the cross products of those triangles.  We'll save
  // the division by 2 and the norm for the end.
  //
  // Your hole points had best be coplanar, but this should work
  // regardless of which plane they're in.  If you're in the XY plane,
  // then the standard counter-clockwise hole point ordering gives you
  // a positive areavec(2);

  RealGradient areavec = 0;

  for (unsigned int i=2; i != np; ++i)
    {
      const Point e_0im = this->point(i-1) - p0,
                  e_0i  = this->point(i) - p0;

      areavec += e_0i.cross(e_0im);
    }

  return areavec;
}

calculate_inside_point()

Point libMesh::TriangulatorInterface::Hole::calculate_inside_point ( ) const

protectedinherited

Calculate an inside point based on our boundary.

Definition at line 248 of file mesh_triangle_holes.C.

References libMesh::make_range(), and libMesh::Real.

Referenced by ArbitraryHole(), and set_points().

{
  // Start with the vertex average

  // Turns out "I'm a fully compliant C++17 compiler!" doesn't
  // mean "I have a full C++17 standard library!"
  // inside = std::reduce(points.begin(), points.end());
  Point inside = 0;
  for (auto i : make_range(this->n_points()))
    inside += this->point(i);

  inside /= this->n_points();

  // Count the number of intersections with a ray to the right,
  // keep track of how far they are
  Point ray_target = inside + Point(1);
  std::vector<Real> intersection_distances =
    this->find_ray_intersections(inside, ray_target);

  // The vertex average isn't on the interior, and we found no
  // intersections to the right?  Try looking to the left.
  if (!intersection_distances.size())
    {
      ray_target = inside - Point(1);
      intersection_distances =
        this->find_ray_intersections(inside, ray_target);
    }

  // I'd make this an assert, but I'm not 100% confident we can't
  // get here via some kind of FP error on a weird hole shape.
  libmesh_error_msg_if
    (!intersection_distances.size(),
     "Can't find a center for a MeshedHole!");

  if (intersection_distances.size() % 2)
    return inside;

  // The vertex average is outside.  So go from the vertex average to
  // the closest edge intersection, then halfway to the next-closest.

  // Find the nearest first.
  Real min_distance    = std::numeric_limits<Real>::max(),
       second_distance = std::numeric_limits<Real>::max();
  for (Real d : intersection_distances)
    if (d < min_distance)
      {
        second_distance = min_distance;
        min_distance = d;
      }

  const Point ray = ray_target - inside;
  inside += ray * (min_distance + second_distance)/2;

  return inside;
}

contains()

bool libMesh::TriangulatorInterface::Hole::contains ( Point  p ) const

inherited

Return true iff p lies inside the hole.

This method currently does not take any higher-order hole geometry into account, but treats the hole as a polygon.

Definition at line 305 of file mesh_triangle_holes.C.

Referenced by libMesh::TriangulatorInterface::verify_holes().

{
  // Count the number of intersections with a ray to the right,
  // keep track of how far they are
  Point ray_target = p + Point(1);
  std::vector<Real> intersection_distances =
    this->find_ray_intersections(p, ray_target);

  // Odd number of intersections == we're inside
  // Even number == we're outside
  return intersection_distances.size() % 2;
}

find_ray_intersections()

std::vector< Real > libMesh::TriangulatorInterface::Hole::find_ray_intersections ( Point  ray_start, Point  ray_target  ) const

protectedinherited

Helper function for contains(), also useful for MeshedHole::inside()

Definition at line 224 of file mesh_triangle_holes.C.

References libMesh::make_range(), and libMesh::Real.

{
  const auto np = this->n_points();

  std::vector<Real> intersection_distances;

  for (auto i : make_range(np))
    {
      const Point & p0 = this->point(i),
                  & p1 = this->point((i+1)%np),
                  & p2 = this->point((i+2)%np);
      const Real intersection_distance =
        find_intersection(ray_start, ray_target, p0, p1, p2);
      if (intersection_distance >= 0)
        intersection_distances.push_back
          (intersection_distance);
    }

  return intersection_distances;
}

get_points()

const std::vector<Point>& libMesh::TriangulatorInterface::ArbitraryHole::get_points ( ) const

inline

Definition at line 300 of file mesh_triangle_holes.h.

References _points.

Referenced by libMesh::Poly2TriTriangulator::insert_refinement_points().

  {
    return _points;
  }

inside()

Point libMesh::TriangulatorInterface::ArbitraryHole::inside ( ) const

overridevirtual

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

Implements libMesh::TriangulatorInterface::Hole.

Definition at line 434 of file mesh_triangle_holes.C.

{
  return _center;
}

midpoint()

virtual Point libMesh::TriangulatorInterface::Hole::midpoint ( const unsigned int  , const unsigned int    ) const

inlinevirtualinherited

Return the midpoint m along the side n defining the hole.

Reimplemented in libMesh::TriangulatorInterface::MeshedHole.

Definition at line 80 of file mesh_triangle_holes.h.

  { libmesh_error(); /* by default holes are polygonal */ }

n_midpoints()

virtual unsigned int libMesh::TriangulatorInterface::Hole::n_midpoints ( ) const

inlinevirtualinherited

The number of geometric midpoints along each of the sides defining the hole.

Reimplemented in libMesh::TriangulatorInterface::MeshedHole.

Definition at line 70 of file mesh_triangle_holes.h.

{ return 0; }

n_points()

unsigned int libMesh::TriangulatorInterface::ArbitraryHole::n_points ( ) const

overridevirtual

The number of geometric points which define the hole.

Implements libMesh::TriangulatorInterface::Hole.

Definition at line 421 of file mesh_triangle_holes.C.

{
  return _points.size();
}

point()

Point libMesh::TriangulatorInterface::ArbitraryHole::point ( const unsigned int  n ) const

overridevirtual

Return the nth point defining the hole.

Implements libMesh::TriangulatorInterface::Hole.

Definition at line 427 of file mesh_triangle_holes.C.

{
  libmesh_assert_less (n, _points.size());
  return _points[n];
}

refine_boundary_allowed()

virtual bool libMesh::TriangulatorInterface::Hole::refine_boundary_allowed ( ) const

inlinevirtualinherited

Get whether or not the triangulation is allowed to refine the mesh boundary when refining the interior.

True by default.

Definition at line 140 of file mesh_triangle_holes.h.

References libMesh::TriangulatorInterface::Hole::_refine_bdy_allowed.

Referenced by libMesh::Poly2TriTriangulator::is_refine_boundary_allowed(), and MeshTriangulationTest::testPoly2TriHolesInteriorRefinedBase().

  { return _refine_bdy_allowed; }

segment_indices()

std::vector< unsigned int > libMesh::TriangulatorInterface::ArbitraryHole::segment_indices ( ) const

overridevirtual

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

Reimplemented from libMesh::TriangulatorInterface::Hole.

Definition at line 440 of file mesh_triangle_holes.C.

{
  return _segment_indices;
}

set_points()

void libMesh::TriangulatorInterface::ArbitraryHole::set_points ( std::vector< Point >  points )

inline

Definition at line 305 of file mesh_triangle_holes.h.

References _center, _points, and libMesh::TriangulatorInterface::Hole::calculate_inside_point().

Referenced by libMesh::Poly2TriTriangulator::insert_refinement_points().

  {
    _points = std::move(points);
    _center = this->calculate_inside_point();
  }

set_refine_boundary_allowed()

virtual void libMesh::TriangulatorInterface::Hole::set_refine_boundary_allowed ( bool  refine_bdy_allowed )

inlinevirtualinherited

Set whether or not a triangulator is allowed to refine the hole boundary when refining the mesh interior.

This is true by default, but may be set to false to make the hole boundary more predictable (and so easier to stitch to other meshes) later.

Definition at line 133 of file mesh_triangle_holes.h.

References libMesh::TriangulatorInterface::Hole::_refine_bdy_allowed.

Referenced by MeshTriangulationTest::testPoly2TriHolesInteriorRefinedBase().

  { _refine_bdy_allowed = refine_bdy_allowed; }

Member Data Documentation

_center

Point libMesh::TriangulatorInterface::ArbitraryHole::_center

private

arbitrary (x,y) location inside the hole

Definition at line 315 of file mesh_triangle_holes.h.

Referenced by ArbitraryHole(), and set_points().

_points

std::vector<Point> libMesh::TriangulatorInterface::ArbitraryHole::_points

private

Reference to the vector of points which makes up the hole.

Definition at line 321 of file mesh_triangle_holes.h.

Referenced by ArbitraryHole(), get_points(), and set_points().

_refine_bdy_allowed

bool libMesh::TriangulatorInterface::Hole::_refine_bdy_allowed = true

protectedinherited

Whether to allow boundary refinement.

True by default; specified here so we can use the default constructor.

Definition at line 160 of file mesh_triangle_holes.h.

Referenced by libMesh::TriangulatorInterface::Hole::refine_boundary_allowed(), and libMesh::TriangulatorInterface::Hole::set_refine_boundary_allowed().

_segment_indices

std::vector<unsigned int> libMesh::TriangulatorInterface::ArbitraryHole::_segment_indices

private

Definition at line 323 of file mesh_triangle_holes.h.

Referenced by ArbitraryHole().

---

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

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