A triFace with additional (region) index. More...

#include <labelledTri.H>

Inheritance diagram for labelledTri:

Collaboration diagram for labelledTri:

Public Member Functions
	labelledTri ()
	Default construct, with invalid point labels and region (-1).
	labelledTri (const triFace &tri, const label region=0)
	Construct from triFace and optional region index (0 if unspecified).
	labelledTri (const label p0, const label p1, const label p2, const label region=0)
	Construct from three point labels and optional region index (0 if unspecified).
	labelledTri (const labelUList &list)
	Construct from a list of 3 or 4 labels. Default region is 0.
	labelledTri (std::initializer_list< label >)
	Construct from a list of 3 or 4 labels. Default region is 0.
	labelledTri (const labelUList &list, const FixedList< label, 3 > &triIndices, const label region=0)
	Copy construct from a subset of point labels and optional region index (0 if unspecified).
	labelledTri (const labelUList &list, const labelledTri &triIndices)
	Copy construct from a subset of point labels with region index from input labelledTri.
	labelledTri (Istream &is)
	Construct from Istream.
label	index () const noexcept
	Return the index (eg, the region).
label &	index () noexcept
	Non-const access to the index (eg, the region).
void	setIndex (const label idx) noexcept
	Set the index (eg, the region).
label	region () const noexcept
	Return the region index.
label &	region () noexcept
	Non-const access to the region index.
Public Member Functions inherited from triFace
void	front ()=delete
	The front() accessor (from FixedList) has no purpose.
void	back ()=delete
	The back() accessor (from FixedList) has no purpose.
	triFace ()
	Default construct, with invalid vertex labels (-1).
	triFace (const label p0, const label p1, const label p2) noexcept
	Construct from three vertex labels.
	triFace (std::initializer_list< label > list)
	Construct from an initializer list of three vertex labels.
	triFace (const labelUList &list)
	Copy construct from a list of three vertex labels.
	triFace (const labelUList &list, const FixedList< label, 3 > &indices)
	Copy construct from a subset of vertex labels.
	triFace (Istream &is)
	Construct from Istream.
label	a () const noexcept
	The first vertex.
label	b () const noexcept
	The second vertex.
label	c () const noexcept
	The third vertex.
label &	a () noexcept
	The first vertex.
label &	b () noexcept
	The second vertex.
label &	c () noexcept
	The third vertex.
bool	good () const noexcept
	True if vertices are unique and non-negative.
label	collapse ()
	'Collapse' face by marking duplicate vertex labels.
void	flip ()
	Flip the face in-place.
pointField	points (const UList< point > &pts) const
	Return the points corresponding to this face.
face	triFaceFace () const
	Return triangle as a face.
triPointRef	tri (const UList< point > &points) const
	Return the triangle.
point	centre (const UList< point > &points) const
	Return centre (centroid).
template<class Type>
Type	average (const UList< point > &unused, const Field< Type > &fld) const
	Calculate average value at centroid of face.
vector	areaNormal (const UList< point > &points) const
	The area normal - with magnitude equal to area of face.
vector	unitNormal (const UList< point > &points) const
	The unit normal.
	FOAM_DEPRECATED_FOR (2018-12, "areaNormal() or unitNormal()") vector normal(const UList< point > &points) const
	Legacy name for areaNormal().
scalar	mag (const UList< point > &points) const
	Magnitude of face area.
scalar	magSqr (const UList< point > &points) const
	Magnitude squared of face area.
Pair< point >	box (const UList< point > &points) const
	The enclosing (bounding) box for the face.
label	nTriangles () const noexcept
	Number of triangles after splitting == 1.
triFace	reverseFace () const
	Return face with reverse direction.
label	which (const label vertex) const
	Find local vertex on face for the vertex label, same as find().
label	nextLabel (const label i) const
	Next vertex on face.
label	prevLabel (const label i) const
	Previous vertex on face.
label	thisLabel (const label i) const
	The vertex on face - identical to operator[], but with naming similar to nextLabel(), prevLabel().
scalar	sweptVol (const UList< point > &opts, const UList< point > &npts) const
	Return swept-volume from old-points to new-points.
tensor	inertia (const UList< point > &points, const point &refPt=vector::zero, scalar density=1.0) const
	Return the inertia tensor, with optional reference.
pointHit	ray (const point &p, const vector &q, const UList< point > &points, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction dir=intersection::VECTOR) const
	Return point intersection with a ray starting at p, in direction q.
pointHit	intersection (const point &p, const vector &q, const UList< point > &points, const intersection::algorithm alg, const scalar tol=0.0) const
	Fast intersection with a ray.
pointHit	intersection (const point &p, const vector &q, const point &ctr, const UList< point > &points, const intersection::algorithm alg, const scalar tol=0.0) const
pointHit	nearestPoint (const point &p, const UList< point > &points) const
	Return nearest point to face.
pointHit	nearestPointClassify (const point &p, const UList< point > &points, label &nearType, label &nearLabel) const
	Return nearest point to face and classify it:
int	sign (const point &p, const UList< point > &points, const scalar tol=SMALL) const
	The sign for which side of the face plane the point is on.
label	nEdges () const noexcept
	Return number of edges == 3.
Foam::edge	edge (const label edgei) const
	Return i-th face edge (forward walk order).
vector	edge (const label edgei, const UList< point > &pts) const
	Return vector of i-th face edge (forward walk order).
Foam::edge	rcEdge (const label edgei) const
	Return i-th face edge in reverse walk order.
vector	rcEdge (const label edgei, const UList< point > &pts) const
	Return vector of i-th face edge in reverse walk order.
edgeList	edges () const
	Return list of edges in forward walk order.
edgeList	rcEdges () const
	Return list of edges in reverse walk order.
bool	contains (const Foam::edge &e) const
	True if face contains(edge).
label	find (const Foam::edge &e) const
	Find the edge within the face.
int	edgeDirection (const Foam::edge &e) const
	Test the edge direction on the face.
void	operator+= (const label vertexOffset)
	Increment (offset) vertices by given amount.
unsigned	hash_code (unsigned seed=0) const
	The (commutative) hash value for triFace.
bool	valid () const noexcept
	Same as good().
Foam::edge	faceEdge (label edgei) const
	Identical to edge().
Public Member Functions inherited from FixedList< label, 3 >
	FixedList ()=default
	Default construct.
autoPtr< FixedList< label, N > >	clone () const
	Clone.
const label *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
label *	data () noexcept
	Return pointer to the underlying array serving as data storage.
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,.
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,.
label &	get () noexcept
	Element access using compile-time indexing.
label &	front () noexcept
	Access first element of the list, position [0].
label &	back () noexcept
	Access last element of the list, position [N-1].
label	fcIndex (const label i) const noexcept
	Return the forward circular index, i.e. next index which returns to the first at the end of the list.
const label &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
label	rcIndex (const label i) const noexcept
	Return the reverse circular index, i.e. previous index which returns to the last at the beginning of the list.
const label &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
void	checkStart (const label start) const
	Check start is within valid range [0,size).
void	checkSize (const label size) const
	Check size is identical to template parameter N.
void	checkIndex (const label i) const
	Check index is within valid range [0,N).
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
bool	contains (const label &val) const
	True if the value is contained in the list.
label	find (const label &val) const
	Find index of the first occurrence of the value.
label	rfind (const label &val, label pos=-1) const
	Find index of the last occurrence of the value.
void	resize (const label n)
	Dummy function, to make FixedList consistent with List Any resizing is ignored (Fatal with bad sizing in full debug).
void	resize_fill (const label n, const label &val)
	Set val for all elements. Any resizing is ignored (Fatal with bad sizing in full debug).
void	resize_nocopy (const label n)
	Dummy function, to make FixedList consistent with List Any resizing is ignored (Fatal with bad sizing in full debug).
void	setSize (const label n)
	Dummy function, to make FixedList consistent with List.
void	fill (const label &val)
	Assign all entries to the given value.
void	moveFirst (const label i)
	Move element to the first position.
void	moveLast (const label i)
	Move element to the last position.
void	swapFirst (const label i)
	Swap element with the first element.
void	swapLast (const label i)
	Swap element with the last element.
void	transfer (FixedList< label, N > &list)
	Transfer by swapping using a move assignment for the content of the individual list elements.
label &	operator[] (const label i)
	Return element of FixedList.
void	operator= (const UList< label > &list)
	Assignment to UList operator. Takes linear time.
iterator	begin () noexcept
	Return an iterator to begin traversing the FixedList.
iterator	end () noexcept
	Return an iterator to end traversing the FixedList.
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant FixedList.
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant FixedList.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the FixedList.
reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the FixedList.
const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing FixedList.
const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing FixedList.
void	swap (FixedList< label, N > &other)
	Swap lists by swapping the content of the individual list elements.
bool	operator== (const FixedList< label, N > &list) const
	Equality operation on FixedLists of the same type.
bool	operator!= (const FixedList< label, N > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const FixedList< label, N > &list) const
	Compare two FixedLists lexicographically. Takes linear time.
bool	operator> (const FixedList< label, N > &list) const
	Compare two FixedLists lexicographically. Takes linear time.
bool	operator<= (const FixedList< label, N > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const FixedList< label, N > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read from Istream, discarding contents of existing List.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
label &	first () noexcept
	Access first element of the list, position [0] - front().
label &	last () noexcept
	Access last element of the list, position [N-1] - back().
bool	found (const label &val, label pos=0) const
	Same as contains().

Friends
Istream &	operator>> (Istream &, labelledTri &)
Ostream &	operator<< (Ostream &, const labelledTri &)

Additional Inherited Members
Public Types inherited from FixedList< label, 3 >
typedef label	value_type
	The value type the FixedList contains.
typedef label *	pointer
	The pointer type for non-const access to value_type items.
typedef const label *	const_pointer
	The pointer type for const access to value_type items.
typedef label &	reference
	The type used for storing into value_type objects.
typedef const label &	const_reference
	The type used for reading from constant value_type objects.
typedef label *	iterator
	Random access iterator for traversing FixedList.
typedef const label *	const_iterator
	Random access iterator for traversing FixedList.
typedef label	size_type
	The type to represent the size of a FixedList.
typedef label	difference_type
	The difference between iterator objects.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access).
Static Public Member Functions inherited from triFace
static int	compare (const triFace &a, const triFace &b)
	Compare triFaces.
Static Public Member Functions inherited from FixedList< label, 3 >
static const FixedList< label, N > &	null () noexcept
	Return a null FixedList (reference to a nullObject). Read/write access is questionable.
static std::streamsize	size_bytes () noexcept
	Number of contiguous bytes for the list data,.
static std::streamsize	byteSize ()
	Number of contiguous bytes for the list data, runtime FatalError if type is not contiguous.
static constexpr bool	empty () noexcept
	Always false since zero-sized FixedList is compile-time disabled.
static constexpr label	size () noexcept
	Return the number of elements in the FixedList.
static constexpr unsigned	max_size () noexcept
	The dimensioned size (template parameter N) of the FixedList.
Protected Member Functions inherited from FixedList< label, 3 >
void	writeEntry (Ostream &os) const
	Write the FixedList with its compound type.