An edge is a list of two vertex labels. This can correspond to a directed graph edge or an edge on a mesh. More...

#include <edge.H>

Inheritance diagram for edge:

[legend]

Collaboration diagram for edge:

Classes
struct	hasher
	Hashing functor for edge (commutative). More...
struct	Hash
	Deprecated(2021-04) hashing functor. Use hasher(). More...

Public Member Functions
	edge ()
	Default construct, with invalid vertex labels (-1).
	edge (label from, label to)
	Construct from two vertex labels.
	edge (const labelPair &pair)
	Construct from two vertex labels.
	edge (const FixedList< label, 2 > &pair)
	Construct from two vertex labels.
	edge (const UList< label > &list, const FixedList< label, 2 > &indices)
	Copy construct from a subset of vertex labels.
	edge (Istream &is)
	Construct from Istream.
label	a () const noexcept
	The first vertex.
label &	a () noexcept
	The first vertex.
label	b () const noexcept
	The second vertex.
label &	b () noexcept
	The second vertex.
label	start () const noexcept
	The start (first) vertex label.
label &	start () noexcept
	The start (first) vertex label.
label &	end () noexcept
	The end (second/last) vertex label.
label	end () const noexcept
	The end (last/second) vertex label.
edge	reverseEdge () const
	Return reverse edge as copy.
label	min () const noexcept
	Return the smallest vertex label used by the edge.
label	max () const noexcept
	Return the largest vertex label used by the edge.
bool	good () const noexcept
	True if the vertices are unique and non-negative.
bool	contains (const label vertex) const noexcept
	Return true if the vertex label is contained in the edge.
label	which (const label vertex) const
	Return local index (0,1) of vertex label in edge -1 on failure.
bool	connected (const edge &other) const
	True if the edge has at least one vertex in common with other.
label	commonVertex (const edge &other) const
	Return vertex common with other edge or -1 on failure.
label	otherVertex (const label vertex) const
	Given one vertex label, return the other one.
bool	connects (const edge &other) const
	Do the edges share a common vertex index?
label	collapse ()
	'Collapse' edge by marking duplicate vertex labels as '-1', the lower vertex is retained.
label	count () const
	Return the number of unique, valid (non -1) vertex labels.
bool	empty () const noexcept
	Return true if edge has no valid vertex labels.
void	clear ()
	'Clears' edge by setting both ends to invalid vertex labels.
bool	insert (const label vertex)
	Fill any open slot with the vertex label (if not previously contained in the edge).
template<class InputIterator>
label	insert (InputIterator begIter, InputIterator endIter)
	Insert values, using begin/end iterators.
label	insert (std::initializer_list< label > list)
	Fill open slots with the indices if they did not previously exist.
template<unsigned N>
label	insert (const FixedList< label, N > &list)
	Fill open slots with the indices if they did not previously exist.
label	insert (const labelUList &list)
	Fill open slots with the indices if they did not previously exist.
label	erase (const label vertex)
	Remove an existing vertex from the edge and set its location to '-1'. A negative vertex label never removes.
template<class InputIterator>
label	erase (InputIterator begIter, InputIterator endIter)
	Remove values, using begin/end iterators.
label	erase (std::initializer_list< label > list)
	Remove existing indices from the edge and set locations to '-1'.
template<unsigned N>
label	erase (const FixedList< label, N > &list)
	Remove existing indices from the edge and set locations to '-1'.
label	erase (const labelUList &list)
	Remove existing indices from the edge and set locations to '-1'.
point	centre (const UList< point > &pts) const
	Return centre point (centroid) of the edge.
vector	vec (const UList< point > &pts) const
	Return the vector (from first to second).
vector	unitVec (const UList< point > &pts) const
	Return the unit vector (from first to second).
scalar	mag (const UList< point > &pts) const
	The length (L2-norm) of the edge vector.
scalar	magSqr (const UList< point > &pts) const
	The length (L2-norm) squared of the edge vector.
Pair< point >	box (const UList< point > &pts) const
	The enclosing (bounding) box for the edge.
linePointRef	line (const UList< point > &pts) const
	Return edge line.
label &	operator[] (const label i)
	Return edge element. Index should be limited to 0/1.
const label &	operator[] (const label i) const
	Return constant edge element. Index should be limited to 0/1.
unsigned	hash_code (unsigned seed=0) const
	The (commutative) hash value for edge, hashes lower value first.
	edge (label from, label to, bool doSort)
	Construct from two vertex labels, sorted with first less-than second.
	edge (const FixedList< label, 2 > &pair, bool doSort)
	Construct from list, sorted with first less-than second.
bool	found (label vertex) const
	Same as contains().
bool	valid () const noexcept
	Same as good().
label	minVert () const noexcept
	Same as min().
label	maxVert () const noexcept
	Same as max().
template<class InputIterator>
Foam::label	insert (InputIterator begIter, InputIterator endIter)
template<unsigned N>
Foam::label	insert (const FixedList< label, N > &list)
template<class InputIterator>
Foam::label	erase (InputIterator begIter, InputIterator endIter)
template<unsigned N>
Foam::label	erase (const FixedList< label, N > &list)
Public Member Functions inherited from Pair< label >
	Pair ()=default
	Default construct.
void	front ()=delete
	The front() accessor (from FixedList) has no purpose.
void	back ()=delete
	The back() accessor (from FixedList) has no purpose.
	Pair (const label &f, const label &s)
	Copy construct from components.
	Pair (label &&f, label &&s)
	Move construct from components.
	Pair (const std::pair< label, label > &vals)
	Copy construct from std::pair.
	Pair (std::pair< label, label > &&vals)
	Move construct from std::pair.
	Pair (const FixedList< label, 2 > &list)
	Copy construct FixedList of two items.
	Pair (const label &f, const label &s, const bool doSort)
	Copy construct, optionally sorted with first less-than second.
	Pair (const FixedList< label, 2 > &list, const bool doSort)
	Copy construct, optionally sorted with first less-than second.
	Pair (Istream &is)
	Construct from Istream.
const label &	first () const noexcept
	Access the first element.
label &	first () noexcept
	Access the first element.
const label &	second () const noexcept
	Access the second element.
label &	second () noexcept
	Access the second element.
const label &	other (const label &a) const
	Return other element.
bool	is_sorted () const
	True if first() is less-than-equal second().
void	flip ()
	Flip the Pair in-place.
void	sort ()
	Sort so that first() is less-than second().
Public Member Functions inherited from FixedList< T, N >
	FixedList ()=default
	Default construct.
	FixedList (const T &val)
	Construct and initialize all entries to given value.
	FixedList (Foam::zero)
	Construct and initialize all entries to zero.
	FixedList (const FixedList< T, N > &list)
	Copy construct.
	FixedList (FixedList< T, N > &&list)
	Move construct by using move assignment for the individual list elements.
	FixedList (std::initializer_list< T > list)
	Construct from an initializer list. Runtime size check.
	FixedList (const UList< T > &list)
	Construct from UList. Runtime size check.
template<unsigned AnyNum>
	FixedList (const FixedList< T, AnyNum > &list, const FixedList< label, N > &indices)
	Copy construct from a subset of the input. No size check.
	FixedList (const UList< T > &list, const FixedList< label, N > &indices)
	Copy construct from a subset of the input. No size check.
	FixedList (Istream &is)
	Construct from Istream.
autoPtr< FixedList< T, N > >	clone () const
	Clone.
const T *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
T *	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,.
template<unsigned Index>
T &	get () noexcept
	Element access using compile-time indexing.
template<unsigned Index>
const T &	get () const noexcept
	Element access using compile-time indexing.
T &	front () noexcept
	Access first element of the list, position [0].
const T &	front () const noexcept
	Access first element of the list, position [0].
T &	back () noexcept
	Access last element of the list, position [N-1].
const T &	back () const 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 T &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
T &	fcValue (const label i)
	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 T &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
T &	rcValue (const label i)
	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 T &val) const
	True if the value is contained in the list.
bool	contains (const T &val, label pos, label len=-1) const
	Is the value contained in the list?
label	find (const T &val) const
	Find index of the first occurrence of the value.
label	find (const T &val, label pos, label len=-1) const
	Find index of the first occurrence of the value.
label	rfind (const T &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 T &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 T &val)
	Assign all entries to the given value.
void	fill (Foam::zero)
	Assign all entries to zero.
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< T, N > &list)
	Transfer by swapping using a move assignment for the content of the individual list elements.
T &	operator[] (const label i)
	Return element of FixedList.
const T &	operator[] (const label i) const
	Return element of constant FixedList.
void	operator= (const UList< T > &list)
	Assignment to UList operator. Takes linear time.
void	operator= (std::initializer_list< T > list)
	Assignment to an initializer list. Takes linear time.
void	operator= (const T &val)
	Assign all entries to the given value. fill().
void	operator= (Foam::zero)
	Assign all entries to zero. fill().
void	operator= (const FixedList< T, N > &list)
	Copy assignment.
void	operator= (FixedList< T, N > &&list)
	Move assignment.
iterator	begin () noexcept
	Return an iterator to begin traversing the FixedList.
iterator	end () noexcept
	Return an iterator to end traversing the FixedList.
iterator	begin (const int i) noexcept
	Return iterator at offset i from begin, clamped to [0,N] range.
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.
const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant FixedList.
const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant FixedList.
const_iterator	cbegin (const int i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,N] range.
const_iterator	begin (const int i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,N] range.
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.
const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing FixedList.
const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing FixedList.
void	swap (FixedList< T, N > &other)
	Swap lists by swapping the content of the individual list elements.
bool	operator== (const FixedList< T, N > &list) const
	Equality operation on FixedLists of the same type.
bool	operator!= (const FixedList< T, N > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const FixedList< T, N > &list) const
	Compare two FixedLists lexicographically. Takes linear time.
bool	operator> (const FixedList< T, N > &list) const
	Compare two FixedLists lexicographically. Takes linear time.
bool	operator<= (const FixedList< T, N > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const FixedList< T, N > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read from Istream, discarding contents of existing List.
void	writeEntry (const word &keyword, Ostream &os) const
	Write the list as a dictionary entry with keyword.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
T &	first () noexcept
	Access first element of the list, position [0] - front().
const T &	first () const noexcept
	Access first element of the list, position [0] - front().
T &	last () noexcept
	Access last element of the list, position [N-1] - back().
const T &	last () const noexcept
	Access last element of the list, position [N-1] - back().
bool	found (const T &val, label pos=0) const
	Same as contains().
	FixedList (const T list[N])
	Deprecated: copy construct from C-array.
void	operator= (const T list[N])
	Deprecated: assignment from C-array.

Static Public Member Functions
static edge	sorted (label from, label to)
	Create (in ascending order) from two vertex labels.
static edge	sorted (const labelPair &pair)
	Create (in ascending order) from two vertex labels.
static edge	sorted (const FixedList< label, 2 > &pair)
	Create (in ascending order) from two vertex labels.
static int	compare (const edge &a, const edge &b)
	Compare edges.
Static Public Member Functions inherited from Pair< label >
static int	compare (const Pair< label > &a, const Pair< label > &b)
	Compare Pairs.
Static Public Member Functions inherited from FixedList< T, N >
static const FixedList< T, 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.

Static Public Attributes
static const char *const	typeName = "edge"
	The typeName ("edge").

Additional Inherited Members
Public Types inherited from FixedList< T, N >
typedef T	value_type
	The value type the FixedList contains.
typedef T *	pointer
	The pointer type for non-const access to value_type items.
typedef const T *	const_pointer
	The pointer type for const access to value_type items.
typedef T &	reference
	The type used for storing into value_type objects.
typedef const T &	const_reference
	The type used for reading from constant value_type objects.
typedef T *	iterator
	Random access iterator for traversing FixedList.
typedef const T *	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).
Protected Member Functions inherited from FixedList< T, N >
void	writeEntry (Ostream &os) const
	Write the FixedList with its compound type.

Detailed Description

An edge is a list of two vertex labels. This can correspond to a directed graph edge or an edge on a mesh.

The edge is implemented as a Pair/FixedList of labels. As well as geometrically relevant methods, it also provides methods similar to HashSet for additional convenience. Valid vertex labels are always non-negative (eg, since they correspond to addressing within the mesh). The value '-1' is used to tag invalid point labels that correspond conceptually to open 'slots', which can be filled with a HashSet-like functionality.

Source files

Definition at line 59 of file edge.H.

Constructor & Destructor Documentation

◆ edge() [1/8]

edge ( )

inline

Default construct, with invalid vertex labels (-1).

Definition at line 62 of file edgeI.H.

Referenced by commonVertex(), compare(), connected(), connects(), cellShape::edge(), edge(), edge(), edge(), erase(), edge::hasher::operator()(), sorted(), sorted(), and sorted().

Here is the caller graph for this function:

◆ edge() [2/8]

edge	(	label	from,
		label	to )

inline

Construct from two vertex labels.

Definition at line 68 of file edgeI.H.

◆ edge() [3/8]

edge ( const labelPair & pair )

inline

Construct from two vertex labels.

Definition at line 74 of file edgeI.H.

References Pair< label >::first(), and Pair< label >::second().

Here is the call graph for this function:

◆ edge() [4/8]

edge ( const FixedList< label, 2 > & pair )

inline

Construct from two vertex labels.

Definition at line 80 of file edgeI.H.

References FixedList< T, N >::get().

Here is the call graph for this function:

◆ edge() [5/8]

edge	(	const UList< label > &	list,
		const FixedList< label, 2 > &	indices )

inline

Copy construct from a subset of vertex labels.

References edge().

Here is the call graph for this function:

◆ edge() [6/8]

edge ( Istream & is )

inline

Construct from Istream.

Definition at line 96 of file edgeI.H.

◆ edge() [7/8]

edge	(	label	from,
		label	to,
		bool	doSort )

inline

Construct from two vertex labels, sorted with first less-than second.

Definition at line 470 of file edge.H.

References edge(), and Pair< label >::sort().

Here is the call graph for this function:

◆ edge() [8/8]

edge	(	const FixedList< label, 2 > &	pair,
		bool	doSort )

inline

Construct from list, sorted with first less-than second.

Definition at line 479 of file edge.H.

References edge(), and Pair< label >::sort().

Here is the call graph for this function:

Member Function Documentation

◆ sorted() [1/3]

Foam::edge sorted	(	label	from,
		label	to )

inlinestatic

Create (in ascending order) from two vertex labels.

Definition at line 32 of file edgeI.H.

References edge().

Here is the call graph for this function:

◆ sorted() [2/3]

Foam::edge sorted ( const labelPair & pair )

inlinestatic

Create (in ascending order) from two vertex labels.

Definition at line 38 of file edgeI.H.

References edge(), Pair< T >::first(), and Pair< T >::second().

Here is the call graph for this function:

◆ sorted() [3/3]

Foam::edge sorted ( const FixedList< label, 2 > & pair )

inlinestatic

Create (in ascending order) from two vertex labels.

Definition at line 49 of file edgeI.H.

References edge(), and FixedList< T, N >::get().

Here is the call graph for this function:

◆ a() [1/2]

label a ( ) const

inlinenoexcept

The first vertex.

Definition at line 135 of file edge.H.

References Pair< label >::first(), and Foam::noexcept.

Referenced by compare(), and erase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ a() [2/2]

label & a ( )

inlinenoexcept

The first vertex.

Definition at line 140 of file edge.H.

References Pair< label >::first(), and Foam::noexcept.

Here is the call graph for this function:

◆ b() [1/2]

label b ( ) const

inlinenoexcept

The second vertex.

Definition at line 145 of file edge.H.

References Foam::noexcept, and Pair< label >::second().

Referenced by compare(), and erase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ b() [2/2]

label & b ( )

inlinenoexcept

The second vertex.

Definition at line 150 of file edge.H.

References Foam::noexcept, and Pair< label >::second().

Here is the call graph for this function:

◆ start() [1/2]

label start ( ) const

inlinenoexcept

The start (first) vertex label.

Definition at line 155 of file edge.H.

References Pair< label >::first(), and Foam::noexcept.

Referenced by directionInfo::edgeToFaceIndex(), cellFeatures::isFeaturePoint(), PrimitivePatch< FaceList, PointField >::meshEdge(), PrimitivePatch< FaceList, PointField >::meshEdges(), slidingInterface::modifyMotionPoints(), line< Point, PointRef >::nearestDist(), Foam::polyMeshZipUpCells(), PatchTools::sortedPointEdges(), and extendedEdgeMesh::sortPointsAndEdges().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ start() [2/2]

label & start ( )

inlinenoexcept

The start (first) vertex label.

Definition at line 160 of file edge.H.

References Pair< label >::first(), and Foam::noexcept.

Here is the call graph for this function:

◆ end() [1/2]

label & end ( )

inlinenoexcept

The end (second/last) vertex label.

Definition at line 165 of file edge.H.

References Foam::noexcept, and Pair< label >::second().

Referenced by directionInfo::edgeToFaceIndex(), cellFeatures::isFeaturePoint(), slidingInterface::modifyMotionPoints(), line< Point, PointRef >::nearestDist(), Foam::polyMeshZipUpCells(), PatchTools::sortedPointEdges(), and extendedEdgeMesh::sortPointsAndEdges().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ end() [2/2]

label end ( ) const

inlinenoexcept

The end (last/second) vertex label.

Definition at line 170 of file edge.H.

References Foam::noexcept, and Pair< label >::second().

Here is the call graph for this function:

◆ reverseEdge()

Foam::edge reverseEdge ( ) const

inline

Return reverse edge as copy.

No special handling of negative vertex labels.

Definition at line 211 of file edgeI.H.

References Pair< label >::first(), and Pair< label >::second().

Here is the call graph for this function:

◆ min()

Foam::label min ( ) const

inlinenoexcept

Return the smallest vertex label used by the edge.

No special handling of negative vertex labels.

Definition at line 104 of file edgeI.H.

References Pair< label >::first(), Foam::noexcept, and Pair< label >::second().

Referenced by minVert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ max()

Foam::label max ( ) const

inlinenoexcept

Return the largest vertex label used by the edge.

No special handling of negative vertex labels.

Definition at line 110 of file edgeI.H.

References Pair< label >::first(), Foam::noexcept, and Pair< label >::second().

Referenced by maxVert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ good()

bool good ( ) const

inlinenoexcept

True if the vertices are unique and non-negative.

Definition at line 116 of file edgeI.H.

References Pair< label >::first(), Foam::noexcept, and Pair< label >::second().

Referenced by multiWorldConnections::addConnectionById(), multiWorldConnections::addConnectionByName(), multiWorldConnections::getCommById(), multiWorldConnections::getCommByName(), and valid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ contains()

bool contains ( const label vertex ) const

inlinenoexcept

Return true if the vertex label is contained in the edge.

Always false for a negative vertex label.

Definition at line 122 of file edgeI.H.

References Pair< label >::first(), and Pair< label >::second().

Referenced by found().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ which()

Foam::label which ( const label vertex ) const

inline

Return local index (0,1) of vertex label in edge -1 on failure.

Always return -1 for a negative vertex label.

Definition at line 133 of file edgeI.H.

References Pair< label >::first(), and Pair< label >::second().

Here is the call graph for this function:

◆ connected()

bool connected ( const edge & other ) const

inline

True if the edge has at least one vertex in common with other.

Definition at line 152 of file edgeI.H.

References edge(), Pair< label >::first(), Pair< label >::other(), and Pair< label >::second().

Referenced by Foam::calcProximityOfFeatureEdges(), and connects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ commonVertex()

Foam::label commonVertex ( const edge & other ) const

inline

Return vertex common with other edge or -1 on failure.

Negative vertex labels are never considered common between edges.

Definition at line 158 of file edgeI.H.

References edge(), Pair< label >::first(), Pair< label >::other(), and Pair< label >::second().

Referenced by removePoints::countPointUsage(), and GTSsurfaceFormat< Face >::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ otherVertex()

Foam::label otherVertex ( const label vertex ) const

inline

Given one vertex label, return the other one.

No special treatment for negative vertex labels.

Definition at line 174 of file edgeI.H.

References Pair< label >::first(), and Pair< label >::second().

Referenced by removePoints::countPointUsage(), searchableExtrudedCircle::findParametricNearest(), and GTSsurfaceFormat< Face >::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ connects()

bool connects ( const edge & other ) const

inline

Do the edges share a common vertex index?

Negative vertex labels never connect.

Definition at line 240 of file edge.H.

References connected(), connects(), edge(), and Pair< label >::other().

Referenced by connects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collapse()

Foam::label collapse ( )

inline

'Collapse' edge by marking duplicate vertex labels as '-1', the lower vertex is retained.

Return the effective size after collapsing.

Definition at line 190 of file edgeI.H.

References Pair< label >::first(), n, and Pair< label >::second().

Here is the call graph for this function:

◆ count()

Foam::label count ( ) const

inline

Return the number of unique, valid (non -1) vertex labels.

Similar to a HashTable::size().

Definition at line 224 of file edgeI.H.

References Pair< label >::first(), n, and Pair< label >::second().

Here is the call graph for this function:

◆ empty()

bool empty ( ) const

inlinenoexcept

Return true if edge has no valid vertex labels.

Definition at line 240 of file edgeI.H.

References Pair< label >::first(), Foam::noexcept, and Pair< label >::second().

Here is the call graph for this function:

◆ clear()

void clear ( )

inline

'Clears' edge by setting both ends to invalid vertex labels.

Definition at line 217 of file edgeI.H.

References Pair< label >::first(), and Pair< label >::second().

Here is the call graph for this function:

◆ insert() [1/7]

bool insert ( const label vertex )

inline

Fill any open slot with the vertex label (if not previously contained in the edge).

Returns true on success. A negative vertex label never inserts. Similar to a HashTable::insert().

Definition at line 246 of file edgeI.H.

References Pair< label >::first(), and Pair< label >::second().

Referenced by insert(), and insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insert() [2/7]

template<class InputIterator>

label insert	(	InputIterator	begIter,
		InputIterator	endIter )

inline

Insert values, using begin/end iterators.

References insert(), and N().

Here is the call graph for this function:

◆ insert() [3/7]

Foam::label insert ( std::initializer_list< label > list )

inline

Fill open slots with the indices if they did not previously exist.

Returns true on success. Negative labels never insert. Return the number of slots filled. Similar to a HashTable::insert().

Definition at line 301 of file edgeI.H.

References insert().

Here is the call graph for this function:

◆ insert() [4/7]

template<unsigned N>

label insert ( const FixedList< label, N > & list )

inline

Fill open slots with the indices if they did not previously exist.

Returns true on success. Negative labels never insert. Return the number of slots filled. Similar to a HashTable::insert().

References erase(), insert(), and N().

Here is the call graph for this function:

◆ insert() [5/7]

Foam::label insert ( const labelUList & list )

inline

Fill open slots with the indices if they did not previously exist.

Returns true on success. Negative labels never insert. Return the number of slots filled. Similar to a HashTable::insert().

Definition at line 314 of file edgeI.H.

References UList< T >::begin(), UList< T >::end(), and insert().

Here is the call graph for this function:

◆ erase() [1/7]

Foam::label erase ( const label vertex )

inline

Remove an existing vertex from the edge and set its location to '-1'. A negative vertex label never removes.

Returns the number of changes. Similar to a HashTable::erase().

Definition at line 320 of file edgeI.H.

References Pair< label >::first(), n, and Pair< label >::second().

Referenced by erase(), erase(), and insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ erase() [2/7]

template<class InputIterator>

label erase	(	InputIterator	begIter,
		InputIterator	endIter )

inline

Remove values, using begin/end iterators.

References erase(), and N().

Here is the call graph for this function:

◆ erase() [3/7]

Foam::label erase ( std::initializer_list< label > list )

inline

Remove existing indices from the edge and set locations to '-1'.

Returns the number of changes.

Definition at line 367 of file edgeI.H.

References erase().

Here is the call graph for this function:

◆ erase() [4/7]

template<unsigned N>

label erase ( const FixedList< label, N > & list )

inline

Remove existing indices from the edge and set locations to '-1'.

Returns the number of changes.

References a(), b(), box(), centre(), compare(), edge(), erase(), line(), mag(), magSqr(), N(), Pair< label >::Pair(), pts, unitVec(), and vec().

Here is the call graph for this function:

◆ erase() [5/7]

Foam::label erase ( const labelUList & list )

inline

Remove existing indices from the edge and set locations to '-1'.

Returns the number of changes.

Definition at line 380 of file edgeI.H.

References UList< T >::begin(), UList< T >::end(), and erase().

Here is the call graph for this function:

◆ centre()

Foam::point centre ( const UList< point > & pts ) const

inline

Return centre point (centroid) of the edge.

No special handling of negative vertex labels.

Definition at line 388 of file edgeI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Pair< label >::first(), pts, and Pair< label >::second().

Referenced by erase(), and surfaceFeatures::nearestEdges().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vec()

Foam::vector vec ( const UList< point > & pts ) const

inline

Return the vector (from first to second).

No special handling of negative vertex labels.

Definition at line 403 of file edgeI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Pair< label >::first(), pts, and Pair< label >::second().

Referenced by erase(), searchableExtrudedCircle::findParametricNearest(), slidingInterface::modifyMotionPoints(), extendedEdgeMesh::sortPointsAndEdges(), and cuttingSurfaceBase::walkCellCuts().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unitVec()

Foam::vector unitVec ( const UList< point > & pts ) const

inline

Return the unit vector (from first to second).

No special handling of negative vertex labels.

Definition at line 418 of file edgeI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Pair< label >::first(), Vector< Cmpt >::normalise(), pts, and Pair< label >::second().

Referenced by erase(), and cellFeatures::isFeaturePoint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mag()

Foam::scalar mag ( const UList< point > & pts ) const

inline

The length (L2-norm) of the edge vector.

No special handling of negative vertex labels.

Definition at line 435 of file edgeI.H.

References Pair< label >::first(), pts, and Pair< label >::second().

Referenced by erase(), and surfaceFeatures::trimFeatures().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ magSqr()

Foam::scalar magSqr ( const UList< point > & pts ) const

inline

The length (L2-norm) squared of the edge vector.

No special handling of negative vertex labels.

Definition at line 441 of file edgeI.H.

References Pair< label >::first(), pts, and Pair< label >::second().

Referenced by erase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ box()

Foam::Pair< Foam::point > box ( const UList< point > & pts ) const

inline

The enclosing (bounding) box for the edge.

Definition at line 448 of file edgeI.H.

References Foam::abort(), line< point, const point & >::box(), Foam::FatalError, FatalErrorInFunction, Pair< label >::first(), pts, and Pair< label >::second().

Referenced by erase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ line()

Foam::linePointRef line ( const UList< point > & pts ) const

inline

Return edge line.

No special handling of negative vertex labels.

Definition at line 463 of file edgeI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Pair< label >::first(), pts, and Pair< label >::second().

Referenced by erase(), slidingInterface::modifyMotionPoints(), syncTools::syncEdgeList(), and syncTools::syncEdgeList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ compare()

int compare	(	const edge &	a,
		const edge &	b )

inlinestatic

Compare edges.

Returns

0: different
+1: identical values and order used
-1: identical values, but in different order

Definition at line 26 of file edgeI.H.

References a(), b(), Pair< label >::compare(), and edge().

Referenced by triSurfaceMesh::addFaceToEdge(), erase(), Foam::operator!=(), Foam::operator==(), syncTools::syncEdgeList(), and syncTools::syncEdgeList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator[]() [1/2]

Foam::label & operator[] ( const label i )

inline

Return edge element. Index should be limited to 0/1.

Definition at line 480 of file edgeI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Pair< label >::first(), and Pair< label >::second().

Here is the call graph for this function:

◆ operator[]() [2/2]

const Foam::label & operator[] ( const label i ) const

inline

Return constant edge element. Index should be limited to 0/1.

Definition at line 493 of file edgeI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Pair< label >::first(), and Pair< label >::second().

Here is the call graph for this function:

◆ hash_code()

unsigned hash_code ( unsigned seed = 0 ) const

inline

The (commutative) hash value for edge, hashes lower value first.

Definition at line 437 of file edge.H.

References Pair< label >::first(), hash_code(), and Pair< label >::second().

Referenced by hash_code(), and edge::hasher::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ found()

bool found ( label vertex ) const

inline

Same as contains().

Definition at line 487 of file edge.H.

References contains().

Referenced by patchEdgeFaceRegions::updateEdge(), patchEdgeFaceRegions::updateEdge(), and patchEdgeFaceRegions::updateFace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valid()

bool valid ( ) const

inlinenoexcept

Same as good().

Definition at line 492 of file edge.H.

References good(), and Foam::noexcept.

Here is the call graph for this function:

◆ minVert()

label minVert ( ) const

inlinenoexcept

Same as min().

Definition at line 497 of file edge.H.

References min(), and Foam::noexcept.

Here is the call graph for this function:

◆ maxVert()

label maxVert ( ) const

inlinenoexcept

Same as max().

Definition at line 502 of file edge.H.

References max(), and Foam::noexcept.

Here is the call graph for this function:

◆ insert() [6/7]

template<class InputIterator>

Foam::label insert	(	InputIterator	begIter,
		InputIterator	endIter )

inline

Definition at line 278 of file edgeI.H.

References Pair< label >::first(), insert(), and Pair< label >::second().

Here is the call graph for this function:

◆ insert() [7/7]

template<unsigned N>

Foam::label insert ( const FixedList< label, N > & list )

inline

Definition at line 308 of file edgeI.H.

References FixedList< T, N >::begin(), FixedList< T, N >::end(), and insert().

Here is the call graph for this function:

◆ erase() [6/7]

template<class InputIterator>

Foam::label erase	(	InputIterator	begIter,
		InputIterator	endIter )

inline

Definition at line 347 of file edgeI.H.

References erase(), Pair< label >::first(), and Pair< label >::second().

Here is the call graph for this function:

◆ erase() [7/7]

template<unsigned N>

Foam::label erase ( const FixedList< label, N > & list )

inline

Definition at line 374 of file edgeI.H.

References FixedList< T, N >::begin(), FixedList< T, N >::end(), and erase().

Here is the call graph for this function:

Member Data Documentation

◆ typeName

const char *const typeName = "edge"

static

The typeName ("edge").

Definition at line 70 of file edge.H.

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

src/OpenFOAM/meshes/meshShapes/edge/edge.H
src/OpenFOAM/meshes/meshShapes/edge/edge.C
src/OpenFOAM/meshes/meshShapes/edge/edgeI.H

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ edge() [1/8]

◆ edge() [2/8]

◆ edge() [3/8]

◆ edge() [4/8]

◆ edge() [5/8]

◆ edge() [6/8]

◆ edge() [7/8]

◆ edge() [8/8]

Member Function Documentation

◆ sorted() [1/3]

◆ sorted() [2/3]

◆ sorted() [3/3]

◆ a() [1/2]

◆ a() [2/2]

◆ b() [1/2]

◆ b() [2/2]

◆ start() [1/2]

◆ start() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ reverseEdge()

◆ min()

◆ max()

◆ good()

◆ contains()

◆ which()

◆ connected()

◆ commonVertex()

◆ otherVertex()

◆ connects()

◆ collapse()

◆ count()

◆ empty()

◆ clear()

◆ insert() [1/7]

◆ insert() [2/7]

◆ insert() [3/7]

◆ insert() [4/7]

◆ insert() [5/7]

◆ erase() [1/7]

◆ erase() [2/7]

◆ erase() [3/7]

◆ erase() [4/7]

◆ erase() [5/7]

◆ centre()

◆ vec()

◆ unitVec()

◆ mag()

◆ magSqr()

◆ box()

◆ line()

◆ compare()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ hash_code()

◆ found()

◆ valid()

◆ minVert()

◆ maxVert()

◆ insert() [6/7]

◆ insert() [7/7]

◆ erase() [6/7]

◆ erase() [7/7]

Member Data Documentation

◆ typeName