NeighborInfo Struct Reference

Struct for containing the necessary information about a cached neighbor for ray tracing. More...

#include <NeighborInfo.h>

Public Member Functions
	NeighborInfo (const Elem *const elem, const std::vector< unsigned short > &sides)
	Constructor without bounds (used for neighbors that exist only at a point) More...
	NeighborInfo (const Elem *const elem, const std::vector< unsigned short > &sides, const Real lower_bound, const Real upper_bound)
	Constructor with bounds (used for neighbors that span an edge) More...

Public Attributes
const Elem *const	_elem
	The element. More...
const std::vector< unsigned short >	_sides
	The sides on the element that the neighboring portion is contained in. More...
std::vector< Point >	_side_normals
	The normals of each side in _sides. More...
const Real	_lower_bound
	The lower bound (used for neighbors that span an edge) More...
const Real	_upper_bound
	The lower bound (used for neighbors that span an edge) More...
bool	_valid
	Whether or not this neighbor is valid (needed for neighbors that span an edge) More...

Detailed Description

Struct for containing the necessary information about a cached neighbor for ray tracing.

Definition at line 27 of file NeighborInfo.h.

Constructor & Destructor Documentation

NeighborInfo() [1/2]

NeighborInfo::NeighborInfo ( const Elem *const  elem, const std::vector< unsigned short > &  sides  )

inline

Constructor without bounds (used for neighbors that exist only at a point)

Definition at line 32 of file NeighborInfo.h.

    : _elem(elem),
      _sides(sides),
      _side_normals(sides.size(), RayTracingCommon::invalid_point),
      _lower_bound(-1),
      _upper_bound(-1),
      _valid(true)
  {
  }

NeighborInfo() [2/2]

NeighborInfo::NeighborInfo ( const Elem *const  elem, const std::vector< unsigned short > &  sides, const Real  lower_bound, const Real  upper_bound  )

inline

Constructor with bounds (used for neighbors that span an edge)

Definition at line 45 of file NeighborInfo.h.

    : _elem(elem),
      _sides(sides),
      _side_normals(sides.size(), RayTracingCommon::invalid_point),
      _lower_bound(lower_bound),
      _upper_bound(upper_bound),
      _valid(true)
  {
  }

Member Data Documentation

_elem

const Elem* const NeighborInfo::_elem

The element.

Definition at line 59 of file NeighborInfo.h.

Referenced by TraceRay::moveThroughNeighbor().

_lower_bound

const Real NeighborInfo::_lower_bound

The lower bound (used for neighbors that span an edge)

Definition at line 65 of file NeighborInfo.h.

_side_normals

std::vector<Point> NeighborInfo::_side_normals

The normals of each side in _sides.

Definition at line 63 of file NeighborInfo.h.

Referenced by TraceRay::moveThroughNeighbor().

_sides

const std::vector<unsigned short> NeighborInfo::_sides

The sides on the element that the neighboring portion is contained in.

Definition at line 61 of file NeighborInfo.h.

Referenced by TraceRay::moveThroughNeighbor().

_upper_bound

const Real NeighborInfo::_upper_bound

The lower bound (used for neighbors that span an edge)

Definition at line 67 of file NeighborInfo.h.

_valid

bool NeighborInfo::_valid

Whether or not this neighbor is valid (needed for neighbors that span an edge)

Definition at line 69 of file NeighborInfo.h.

Referenced by TraceRay::moveThroughNeighbor().

---

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

• ray_tracing/include/raytracing/NeighborInfo.h