edge Class Reference

An edge is a list of two point labels. The functionality it provides supports the discretisation on a 2-D flat mesh. More...

Inheritance diagram for edge:
Collaboration diagram for edge:

Public Member Functions

 edge ()
 Null constructor for lists. More...
 
 edge (const label a, const label b)
 Construct from components. More...
 
 edge (const FixedList< label, 2 > &)
 Construct from FixedList. More...
 
 edge (Istream &)
 Construct from Istream. More...
 
label start () const
 Return start vertex label. More...
 
labelstart ()
 Return start vertex label. More...
 
label end () const
 Return end vertex label. More...
 
labelend ()
 Return end vertex label. More...
 
bool connected (const edge &a) const
 Return true if connected to given edge. More...
 
label commonVertex (const edge &a) const
 Return common vertex. More...
 
label otherVertex (const label a) const
 Given one vertex, return the other. More...
 
void flip ()
 Flip the edge in-place. More...
 
edge reverseEdge () const
 Return reverse edge. More...
 
point centre (const pointField &) const
 Return centre (centroid) More...
 
vector vec (const pointField &) const
 Return the vector (end - start) More...
 
scalar mag (const pointField &) const
 Return scalar magnitude. More...
 
linePointRef line (const pointField &) const
 Return edge line. More...
 
- Public Member Functions inherited from FixedList< label, 2 >
 FixedList ()
 Null constructor. More...
 
 FixedList (const label &)
 Construct from value. More...
 
 FixedList (const label v[Size])
 Construct from C-array. More...
 
 FixedList (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
 FixedList (std::initializer_list< label >)
 Construct from an initialiser list. More...
 
 FixedList (const UList< label > &)
 Construct from UList. More...
 
 FixedList (const SLList< label > &)
 Construct from SLList. More...
 
 FixedList (Istream &)
 Construct from Istream. More...
 
autoPtr< FixedList< label, Size > > clone () const
 Clone. More...
 
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index. More...
 
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index. More...
 
const labelcdata () const
 Return a const pointer to the first data element,. More...
 
labeldata ()
 Return a pointer to the first data element,. More...
 
labelfirst ()
 Return the first element of the list. More...
 
const labelfirst () const
 Return first element of the list. More...
 
labellast ()
 Return the last element of the list. More...
 
const labellast () const
 Return the last element of the list. More...
 
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1) More...
 
void checkSize (const label size) const
 Check size is within valid range (0 ... size) More...
 
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1) More...
 
void resize (const label)
 Dummy resize function. More...
 
void setSize (const label)
 Dummy setSize function. More...
 
void transfer (const FixedList< label, Size > &)
 Copy (not transfer) the argument contents. More...
 
labeloperator[] (const label)
 Return element of FixedList. More...
 
const labeloperator[] (const label) const
 Return element of constant FixedList. More...
 
void operator= (const label v[Size])
 Assignment to array operator. Takes linear time. More...
 
void operator= (const UList< label > &)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const SLList< label > &)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (std::initializer_list< label >)
 Assignment to an initialiser list. Takes linear time. More...
 
void operator= (const label &)
 Assignment of all entries to the given value. More...
 
iterator begin ()
 Return an iterator to begin traversing the FixedList. More...
 
const_iterator begin () const
 Return const_iterator to begin traversing the constant FixedList. More...
 
iterator end ()
 Return an iterator to end traversing the FixedList. More...
 
const_iterator end () const
 Return const_iterator to end traversing the constant FixedList. More...
 
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant FixedList. More...
 
const_iterator cend () const
 Return const_iterator to end traversing the constant FixedList. More...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the FixedList. More...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing FixedList. More...
 
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the FixedList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing FixedList. More...
 
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing FixedList. More...
 
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing FixedList. More...
 
label size () const
 Return the number of elements in the FixedList. More...
 
label max_size () const
 Return size of the largest possible FixedList. More...
 
bool empty () const
 Return true if the FixedList is empty (ie, size() is zero) More...
 
void swap (FixedList< label, Size > &)
 Swap two FixedLists of the same type in constant time. More...
 
bool operator== (const FixedList< label, Size > &) const
 Equality operation on FixedLists of the same type. More...
 
bool operator!= (const FixedList< label, Size > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const FixedList< label, Size > &) const
 Compare two FixedLists lexicographically. Takes linear time. More...
 
bool operator> (const FixedList< label, Size > &) const
 Compare two FixedLists lexicographically. Takes linear time. More...
 
bool operator<= (const FixedList< label, Size > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const FixedList< label, Size > &) const
 Return true if !(a < b). Takes linear time. More...
 

Static Public Member Functions

static int compare (const edge &, const edge &)
 Compare edges. More...
 
- Static Public Member Functions inherited from FixedList< label, 2 >
static const FixedList< label, Size > & null ()
 Return a null FixedList. More...
 

Static Public Attributes

static const char *const typeName = "edge"
 

Friends

bool operator== (const edge &a, const edge &b)
 
bool operator!= (const edge &a, const edge &b)
 

Additional Inherited Members

- Public Types inherited from FixedList< label, 2 >
typedef label value_type
 Type of values the FixedList contains. More...
 
typedef labelreference
 Type that can be used for storing into. More...
 
typedef const labelconst_reference
 Type that can be used for storing into. More...
 
typedef label difference_type
 The type that can represent the difference between any two. More...
 
typedef label size_type
 The type that can represent the size of a FixedList. More...
 
typedef labeliterator
 Random access iterator for traversing FixedList. More...
 
typedef const labelconst_iterator
 Random access iterator for traversing FixedList. More...
 
typedef std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator for reverse traversal of FixedList. More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator for reverse traversal of constant FixedList. More...
 

Detailed Description

An edge is a list of two point labels. The functionality it provides supports the discretisation on a 2-D flat mesh.

Source files

Definition at line 58 of file edge.H.

Constructor & Destructor Documentation

◆ edge() [1/4]

edge ( )
inline

Null constructor for lists.

Definition at line 55 of file edgeI.H.

◆ edge() [2/4]

edge ( const label  a,
const label  b 
)
inline

Construct from components.

Definition at line 59 of file edgeI.H.

References b.

◆ edge() [3/4]

edge ( const FixedList< label, 2 > &  a)
inline

Construct from FixedList.

Definition at line 66 of file edgeI.H.

◆ edge() [4/4]

edge ( Istream is)
inline

Construct from Istream.

Definition at line 73 of file edgeI.H.

Member Function Documentation

◆ start() [1/2]

◆ start() [2/2]

Foam::label & start ( )
inline

Return start vertex label.

Definition at line 86 of file edgeI.H.

◆ end() [1/2]

◆ end() [2/2]

Foam::label & end ( )
inline

Return end vertex label.

Definition at line 97 of file edgeI.H.

◆ connected()

bool connected ( const edge a) const
inline

Return true if connected to given edge.

Definition at line 103 of file edgeI.H.

References edge::end(), and edge::start().

Referenced by extendedEdgeMesh::minDisconnectedDist().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ commonVertex()

Foam::label commonVertex ( const edge a) const
inline

Return common vertex.

Definition at line 122 of file edgeI.H.

References edge::end(), and edge::start().

Referenced by removePoints::countPointUsage(), polygonTriangulate::nIntersections(), 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  a) const
inline

Given one vertex, return the other.

Definition at line 140 of file edgeI.H.

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

Here is the caller graph for this function:

◆ flip()

void flip ( )
inline

Flip the edge in-place.

Definition at line 157 of file edgeI.H.

References Foam::Swap().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ reverseEdge()

Foam::edge reverseEdge ( ) const
inline

Return reverse edge.

Definition at line 163 of file edgeI.H.

◆ centre()

Foam::point centre ( const pointField p) const
inline

Return centre (centroid)

Definition at line 169 of file edgeI.H.

References p.

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

Here is the caller graph for this function:

◆ vec()

Foam::vector vec ( const pointField p) const
inline

Return the vector (end - start)

Definition at line 175 of file edgeI.H.

References p.

Referenced by searchableExtrudedCircle::findParametricNearest(), cellFeatures::isFeaturePoint(), surfaceFeatures::nearestFeatEdge(), and extendedEdgeMesh::sortPointsAndEdges().

Here is the caller graph for this function:

◆ mag()

Foam::scalar mag ( const pointField p) const
inline

Return scalar magnitude.

Definition at line 181 of file edgeI.H.

References Foam::mag(), and p.

Referenced by surfaceFeatures::trimFeatures().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ line()

Foam::linePointRef line ( const pointField p) const
inline

Return edge line.

Definition at line 187 of file edgeI.H.

References p.

◆ compare()

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

Compare edges.

Returns:

  • 0: different
  • +1: identical
  • -1: same edge, but different orientation

Definition at line 36 of file edgeI.H.

References b.

Referenced by cellEdgeAddressingData::cellEdgeAddressingData(), Foam::operator!=(), Foam::operator==(), and Foam::primitivePatchGetZones().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator==

bool operator== ( const edge a,
const edge b 
)
friend

◆ operator!=

bool operator!= ( const edge a,
const edge b 
)
friend

Member Data Documentation

◆ typeName

const char *const typeName = "edge"
static

Definition at line 67 of file edge.H.


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