An edge is a list of two point labels. The functionality it provides supports the discretisation on a 2-D flat mesh. More...
#include <OpenFOAM/edge.H>
An edge is a list of two point labels. The functionality it provides supports the discretisation on a 2-D flat mesh.
Public Member Functions | |
edge () | |
Null constructor for lists. | |
edge (const label a, const label b) | |
Construct from components. | |
edge (const FixedList< label, 2 > &) | |
Construct from FixedList. | |
edge (Istream &) | |
Construct from Istream. | |
label | start () const |
Return start vertex label. | |
label & | start () |
Return start vertex label. | |
label | end () const |
Return end vertex label. | |
label & | end () |
Return end vertex label. | |
label | otherVertex (const label a) const |
Given one vertex, return the other. | |
label | commonVertex (const edge &a) const |
Return common vertex. | |
edge | reverseEdge () const |
Return reverse edge. | |
point | centre (const pointField &) const |
Return centre (centroid) | |
vector | vec (const pointField &) const |
Return the vector (end - start) | |
scalar | mag (const pointField &) const |
Return scalar magnitude. | |
linePointRef | line (const pointField &) const |
Return edge line. | |
![]() | |
FixedList () | |
Null constructor. | |
FixedList (const labelv[Size]) | |
Construct from components. | |
FixedList (const label &) | |
Construct from value. | |
FixedList (const UList< label > &) | |
Construct from UList. | |
FixedList (const SLList< label > &) | |
Construct from SLList. | |
FixedList (const FixedList< label, Size > &) | |
Copy constructor. | |
FixedList (Istream &) | |
Construct from Istream. | |
autoPtr< FixedList< label, Size > > | clone () const |
Clone. | |
label | fcIndex (const label i) const |
Return the forward circular index, i.e. the next index. | |
label | rcIndex (const label i) const |
Return the reverse circular index, i.e. the previous index. | |
const label * | cdata () const |
Return a const pointer to the first data element,. | |
label * | data () |
Return a pointer to the first data element,. | |
void | checkStart (const label start) const |
Check start is within valid range (0 ... size-1). | |
void | checkSize (const label size) const |
Check size is within valid range (0 ... size). | |
void | checkIndex (const label i) const |
Check index i is within valid range (0 ... size-1). | |
void | resize (const label) |
Dummy resize function. | |
void | setSize (const label) |
Dummy setSize function. | |
void | transfer (const FixedList< label, Size > &) |
Copy (not transfer) the argument contents. | |
void | writeEntry (Ostream &) const |
Write the FixedList as a dictionary entry. | |
void | writeEntry (const word &keyword, Ostream &) const |
Write the FixedList as a dictionary entry with keyword. | |
label & | operator[] (const label) |
Return element of FixedList. | |
const label & | operator[] (const label) const |
Return element of constant FixedList. | |
void | operator= (const labelv[Size]) |
Assignment from array operator. Takes linear time. | |
void | operator= (const UList< label > &) |
Assignment from UList operator. Takes linear time. | |
void | operator= (const SLList< label > &) |
Assignment from SLList operator. Takes linear time. | |
void | operator= (const label &) |
Assignment of all entries to the given value. | |
iterator | begin () |
Return an iterator to begin traversing the FixedList. | |
const_iterator | begin () const |
Return const_iterator to begin traversing the constant FixedList. | |
const_iterator | cbegin () const |
Return const_iterator to begin traversing the constant FixedList. | |
const_iterator | cend () const |
Return const_iterator to end traversing the constant FixedList. | |
reverse_iterator | rbegin () |
Return reverse_iterator to begin reverse traversing the FixedList. | |
const_reverse_iterator | rbegin () const |
Return const_reverse_iterator to begin reverse traversing FixedList. | |
reverse_iterator | rend () |
Return reverse_iterator to end reverse traversing the FixedList. | |
const_reverse_iterator | rend () const |
Return const_reverse_iterator to end reverse traversing 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. | |
label | size () const |
Return the number of elements in the FixedList. | |
label | max_size () const |
Return size of the largest possible FixedList. | |
bool | empty () const |
Return true if the FixedList is empty (ie, size() is zero). | |
void | swap (FixedList< label, Size > &) |
Swap two FixedLists of the same type in constant time. | |
bool | operator== (const FixedList< label, Size > &) const |
Equality operation on FixedLists of the same type. | |
bool | operator!= (const FixedList< label, Size > &) const |
The opposite of the equality operation. Takes linear time. | |
bool | operator< (const FixedList< label, Size > &) const |
Compare two FixedLists lexicographically. Takes linear time. | |
bool | operator> (const FixedList< label, Size > &) const |
Compare two FixedLists lexicographically. Takes linear time. | |
bool | operator<= (const FixedList< label, Size > &) const |
Return true if !(a > b). Takes linear time. | |
bool | operator>= (const FixedList< label, Size > &) const |
Return true if !(a < b). Takes linear time. |
Static Public Member Functions | |
static int | compare (const edge &, const edge &) |
compare edges | |
![]() | |
static const FixedList< label, Size > & | null () |
Return a null FixedList. |
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 | |
![]() | |
typedef label | value_type |
Type of values the FixedList contains. | |
typedef label & | reference |
Type that can be used for storing into. | |
typedef const label & | const_reference |
Type that can be used for storing into. | |
typedef label | difference_type |
The type that can represent the difference between any two. | |
typedef label | size_type |
The type that can represent the size of a FixedList. | |
typedef label * | iterator |
Random access iterator for traversing FixedList. | |
typedef const label * | const_iterator |
Random access iterator for traversing FixedList. | |
typedef label * | reverse_iterator |
Reverse iterator for reverse traversal of FixedList. | |
typedef const label * | const_reverse_iterator |
Reverse iterator for reverse traversal of constant FixedList. |
|
inline |
|
inline |
Return start vertex label.
Definition at line 80 of file edgeI.H.
Referenced by edgeSurface::addIntersectionEdges(), PatchTools::checkOrientation(), PrimitivePatch< Face, FaceList, PointField, PointType >::checkTopology(), triSurfaceTools::collapseEdges(), edge::commonVertex(), curvedEdge::compare(), edgeVertex::coord(), geomCellLooper::cut(), triFace::edgeDirection(), face::edgeDirection(), edgeSurface::edgeSurface(), directionInfo::edgeToFaceIndex(), Foam::meshTools::findEdge(), triSurfaceTools::getEdge(), cellLooper::getFirstVertEdge(), octreeDataFaceList::getSampleType(), octreeDataFace::getSampleType(), triSurfaceTools::getVertexTriangles(), triSurfaceTools::getVertexVertices(), treeDataFace::getVolumeType(), triSurfaceTools::greenRefine(), intersectedSurface::intersectedSurface(), cellFeatures::isFeaturePoint(), triSurfaceTools::maxEdge(), triSurfaceTools::minEdge(), slidingInterface::modifyMotionPoints(), motionSmoother::movePoints(), surfaceFeatures::nearestEdges(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSurfEdge(), octreeDataEdges::octreeDataEdges(), triSurfaceTools::oppositeEdge(), triSurfaceTools::oppositeVertex(), Foam::meshTools::otherEdge(), Foam::polyMeshZipUpCells(), interactionLists::referredCellsInRangeOfSegment(), boundaryMesh::setFeatureEdges(), faceCollapser::setRefinement(), boundaryCutter::setRefinement(), meshCutAndRemove::setRefinement(), meshCutter::setRefinement(), PatchTools::sortedEdgeFaces(), surfaceIntersection::surfaceIntersection(), interactionLists::testEdgeEdgeDistance(), directionInfo::updateCell(), boundaryCutter::updateMesh(), meshCutAndRemove::updateMesh(), meshCutter::updateMesh(), and PrimitivePatch< Face, FaceList, PointField, PointType >::whichEdge().
|
inline |
Return end vertex label.
Reimplemented from FixedList< label, 2 >.
Definition at line 91 of file edgeI.H.
Referenced by edgeSurface::addIntersectionEdges(), PatchTools::checkOrientation(), PrimitivePatch< Face, FaceList, PointField, PointType >::checkTopology(), triSurfaceTools::collapseEdges(), edge::commonVertex(), curvedEdge::compare(), edgeVertex::coord(), geomCellLooper::cut(), triFace::edgeDirection(), face::edgeDirection(), edgeSurface::edgeSurface(), directionInfo::edgeToFaceIndex(), Foam::meshTools::findEdge(), triSurfaceTools::getEdge(), cellLooper::getFirstVertEdge(), octreeDataFaceList::getSampleType(), octreeDataFace::getSampleType(), triSurfaceTools::getVertexTriangles(), triSurfaceTools::getVertexVertices(), treeDataFace::getVolumeType(), triSurfaceTools::greenRefine(), intersectedSurface::intersectedSurface(), cellFeatures::isFeaturePoint(), triSurfaceTools::maxEdge(), triSurfaceTools::minEdge(), slidingInterface::modifyMotionPoints(), motionSmoother::movePoints(), surfaceFeatures::nearestSurfEdge(), octreeDataEdges::octreeDataEdges(), triSurfaceTools::oppositeEdge(), triSurfaceTools::oppositeVertex(), Foam::meshTools::otherEdge(), Foam::polyMeshZipUpCells(), interactionLists::referredCellsInRangeOfSegment(), boundaryMesh::setFeatureEdges(), meshCutAndRemove::setRefinement(), meshCutter::setRefinement(), surfaceIntersection::surfaceIntersection(), interactionLists::testEdgeEdgeDistance(), boundaryCutter::updateMesh(), meshCutAndRemove::updateMesh(), and meshCutter::updateMesh().
|
inline |
Return end vertex label.
Reimplemented from FixedList< label, 2 >.
|
inline |
Given one vertex, return the other.
Definition at line 102 of file edgeI.H.
Referenced by removePoints::countPointUsage(), triSurfaceTools::getVertexVertices(), GTSsurfaceFormat< Face >::read(), and triSurfaceTools::surfaceSide().
|
inline |
Return common vertex.
Definition at line 120 of file edgeI.H.
References edge::end(), and edge::start().
Referenced by removePoints::countPointUsage(), and GTSsurfaceFormat< Face >::read().
|
inline |
|
inline |
Return centre (centroid)
Definition at line 144 of file edgeI.H.
Referenced by surfaceFeatures::nearestEdges(), treeDataEdge::points(), and hexRef8::setRefinement().
|
inline |
Return the vector (end - start)
Definition at line 150 of file edgeI.H.
Referenced by cellFeatures::isFeaturePoint(), slidingInterface::modifyMotionPoints(), surfaceFeatures::nearestEdges(), surfaceFeatures::nearestSamples(), PatchTools::sortedEdgeFaces(), and interactionLists::testEdgeEdgeDistance().
|
inline |
Return scalar magnitude.
Definition at line 156 of file edgeI.H.
References Foam::mag().
Referenced by autoSnapDriver::calcSnapDistance(), and surfaceIntersection::surfaceIntersection().
|
inline |
Return edge line.
Definition at line 162 of file edgeI.H.
Referenced by octreeDataEdges::calcNearest(), treeDataEdge::findNearest(), slidingInterface::modifyMotionPoints(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSurfEdge(), and surfaceLocation::write().
compare edges
+1: identical
Definition at line 35 of file edgeI.H.
Referenced by Foam::operator!=(), and Foam::operator==().