ElemExtrema Struct Reference

Helper for defining if at an element's edge, vertex, or neither. More...

#include <ElemExtrema.h>

Inheritance diagram for ElemExtrema:

Public Member Functions
	ElemExtrema ()
	Default constructor: sets entires to invalid (not at vertex or edge)
	ElemExtrema (const unsigned short v1, const unsigned short v2)
bool	atExtrema () const
bool	isInvalid () const
bool	atVertex () const
bool	atVertex (const unsigned short v) const
bool	atEdge () const
bool	atEdge (const unsigned short v1, const unsigned short v2) const
void	invalidate ()
	Invalidates the current state.
unsigned short	vertex () const
const std::pair< unsigned short, unsigned short > &	edgeVertices () const
std::string	print () const
	Prints the current state (at edge, at vertex, not at either)
void	setVertex (const unsigned short vertex)
	Sets the "at vertex" state.
void	setEdge (const unsigned short v1, const unsigned short v2)
	Sets the "at edge" state.
void	setEdge (const std::pair< unsigned short, unsigned short > &vertices)
	Sets the "at edge" state.
const Point &	vertexPoint (const libMesh::Elem *elem) const
std::unique_ptr< const libMesh::Elem >	buildEdge (const Elem *elem) const
bool	isValid (const Elem *const elem, const Point &point) const

Detailed Description

Helper for defining if at an element's edge, vertex, or neither.

Definition at line 25 of file ElemExtrema.h.

Constructor & Destructor Documentation

ElemExtrema() [1/2]

ElemExtrema::ElemExtrema ( )

inline

Default constructor: sets entires to invalid (not at vertex or edge)

Definition at line 30 of file ElemExtrema.h.

    : std::pair<unsigned short, unsigned short>(RayTracingCommon::invalid_vertex,
                                                RayTracingCommon::invalid_vertex)
  {
  }

ElemExtrema() [2/2]

ElemExtrema::ElemExtrema ( const unsigned short  v1, const unsigned short  v2  )

inline

Definition at line 36 of file ElemExtrema.h.

    : std::pair<unsigned short, unsigned short>(v1, v2)
  {
  }

Member Function Documentation

atEdge() [1/2]

bool ElemExtrema::atEdge ( ) const

inline

Returns

true if at an edge

Definition at line 71 of file ElemExtrema.h.

  {
    return first != RayTracingCommon::invalid_vertex && second != RayTracingCommon::invalid_vertex;
  }

Referenced by buildEdge(), edgeVertices(), TraceRay::findExternalBoundarySide(), TraceRayTools::intersectQuad(), isValid(), print(), TEST(), TEST(), TEST(), and TraceRay::trace().

atEdge() [2/2]

bool ElemExtrema::atEdge ( const unsigned short  v1, const unsigned short  v2  ) const

inline

Returns

true if at the edge defined by vertices v1 and v2

Definition at line 78 of file ElemExtrema.h.

  {
    return second != RayTracingCommon::invalid_vertex &&
           ((first == v1 && second == v2) || (first == v2 && second == v1));
  }

atExtrema()

bool ElemExtrema::atExtrema ( ) const

inline

Returns

true if at the extrema (edge or vertex)

Definition at line 44 of file ElemExtrema.h.

{ return first != RayTracingCommon::invalid_vertex; }

Referenced by TraceRay::applyOnExternalBoundary(), TraceRay::applyOnInternalBoundary(), TraceRay::exitsElem(), TraceRay::findExternalBoundarySide(), TraceRay::getNeighbors(), TraceRay::onTrajectoryChanged(), TEST(), and TraceRay::trace().

atVertex() [1/2]

bool ElemExtrema::atVertex ( ) const

inline

Returns

true if at a vertex

Definition at line 56 of file ElemExtrema.h.

  {
    return first != RayTracingCommon::invalid_vertex && second == RayTracingCommon::invalid_vertex;
  }

Referenced by TraceRay::exitsElem(), TraceRay::getNeighbors(), isValid(), print(), TEST(), vertex(), and TraceRayTools::withinExtremaOnSide().

atVertex() [2/2]

bool ElemExtrema::atVertex ( const unsigned short  v ) const

inline

Returns

true if at vertex v

Definition at line 63 of file ElemExtrema.h.

  {
    return first == v && second == RayTracingCommon::invalid_vertex;
  }

buildEdge()

std::unique_ptr< const libMesh::Elem > ElemExtrema::buildEdge

(

const Elem *

elem

)

const

Returns

The edge when at an edge

Definition at line 22 of file ElemExtrema.C.

{
  mooseAssert(atEdge(), "Did not intersect edge");
  mooseAssert(first < elem->n_vertices(), "Invalid first vertex for given element");
  mooseAssert(second < elem->n_vertices(), "Invalid second vertex for given element");
 
  for (const auto e : elem->edge_index_range())
    if (elem->is_node_on_edge(first, e) && elem->is_node_on_edge(second, e))
      return elem->build_edge_ptr(e);
 
  mooseError("Element does not contain vertices in ElemExtrema");
}

Referenced by isValid(), RayTracingStudyTest::RayTracingStudyTest(), TEST(), and TraceRayTools::withinEdgeOnSideTempl().

edgeVertices()

const std::pair< unsigned short, unsigned short > & ElemExtrema::edgeVertices ( ) const

inline

Returns

The vertices that contain the edge when at an edge

Definition at line 104 of file ElemExtrema.h.

  {
    mooseAssert(atEdge(), "Not at an edge");
    return *this;
  }

Referenced by TraceRay::getNeighbors(), and TEST().

invalidate()

void ElemExtrema::invalidate ( )

inline

Invalidates the current state.

Definition at line 87 of file ElemExtrema.h.

  {
    first = RayTracingCommon::invalid_vertex;
    second = RayTracingCommon::invalid_vertex;
  }

Referenced by TraceRay::applyOnInternalBoundary(), TraceRay::exitsElem(), BoundingBoxIntersectionHelper::intersection(), TraceRayTools::intersectQuad(), TraceRay::moveThroughNeighbor(), TEST(), TEST(), TEST(), and TraceRay::trace().

isInvalid()

bool ElemExtrema::isInvalid ( ) const

inline

Returns

true if the data is invalid

Definition at line 48 of file ElemExtrema.h.

  {
    return first == RayTracingCommon::invalid_vertex && second == RayTracingCommon::invalid_vertex;
  }

Referenced by TraceRay::exitsElem(), TraceRay::findExternalBoundarySide(), TraceRayTools::intersectQuad(), TraceRay::moveThroughNeighbors(), TraceRayTools::sideIntersectedByLine(), TraceRayTools::sideIntersectedByLine(), TEST(), TEST(), TraceRayTools::withinEdgeOnSideTempl(), TraceRayTools::withinEdgeTempl(), and TraceRayTools::withinExtremaOnSide().

isValid()

bool ElemExtrema::isValid	(	const Elem *const	elem,
		const Point &	point
	)		const

Returns

Whether or not the current state (at vertex/edge) is valid for the given elem and point.

This ONLY checks for validity when atExtrema().

Definition at line 49 of file ElemExtrema.C.

{
  mooseAssert(first == RayTracingCommon::invalid_vertex || first < elem->n_vertices(),
              "Invalid first vertex for given element");
  mooseAssert(second == RayTracingCommon::invalid_vertex || second < elem->n_vertices(),
              "Invalid second vertex for given element");
 
  if (atVertex())
    return vertexPoint(elem).absolute_fuzzy_equals(point);
  if (elem->dim() == 3 && atEdge())
    return buildEdge(elem)->contains_point(point);
 
  return true;
}

Referenced by TraceRay::possiblyAddToBoundaryElems(), and TEST().

print()

std::string ElemExtrema::print

(

)

const

Prints the current state (at edge, at vertex, not at either)

Definition at line 36 of file ElemExtrema.C.

{
  std::stringstream oss;
  if (atVertex())
    oss << "at vertex " << vertex();
  else if (atEdge())
    oss << "at edge with vertices " << first << " and " << second;
  else
    oss << "not at extrema";
  return oss.str();
}

Referenced by operator<<().

setEdge() [1/2]

void ElemExtrema::setEdge ( const std::pair< unsigned short, unsigned short > &  vertices )

inline

Sets the "at edge" state.

Definition at line 137 of file ElemExtrema.h.

  {
    setEdge(vertices.first, vertices.second);
  }

setEdge() [2/2]

void ElemExtrema::setEdge ( const unsigned short  v1, const unsigned short  v2  )

inline

Sets the "at edge" state.

Definition at line 127 of file ElemExtrema.h.

  {
    mooseAssert(v1 != RayTracingCommon::invalid_vertex, "Setting invalid vertex");
    mooseAssert(v2 != RayTracingCommon::invalid_vertex, "Setting invalid vertex");
    first = v1;
    second = v2;
  }

Referenced by TraceRayTools::intersectTriangle(), setEdge(), TEST(), TraceRayTools::withinEdgeOnSideTempl(), and TraceRayTools::withinEdgeTempl().

setVertex()

void ElemExtrema::setVertex ( const unsigned short  vertex )

inline

Sets the "at vertex" state.

Definition at line 118 of file ElemExtrema.h.

  {
    mooseAssert(vertex != RayTracingCommon::invalid_vertex, "Setting invalid vertex");
    first = vertex;
    second = RayTracingCommon::invalid_vertex;
  }

Referenced by TraceRay::applyOnInternalBoundary(), TraceRayTools::intersectTriangle(), TraceRayTools::sideIntersectedByLine(), and TEST().

vertex()

unsigned short ElemExtrema::vertex ( ) const

inline

Returns

The vertex ID when at a vertex

Definition at line 96 of file ElemExtrema.h.

  {
    mooseAssert(atVertex(), "Not at a vertex");
    return first;
  }

Referenced by TraceRay::getNeighbors(), print(), setVertex(), TEST(), and vertexPoint().

vertexPoint()

const Point & ElemExtrema::vertexPoint

(

const libMesh::Elem *

elem

)

const

Returns

The vertex point when at a vertex

Definition at line 16 of file ElemExtrema.C.

{
  return elem->point(vertex());
}

Referenced by isValid(), TraceRayTools::sideIntersectedByLine(), and TEST().

---

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

• ray_tracing/include/raytracing/ElemExtrema.h
• ray_tracing/src/raytracing/ElemExtrema.C