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...
label &	start ()
	Return start vertex label. More...
label	end () const
	Return end vertex label. More...
label &	end ()
	Return end vertex label. More...
label	otherVertex (const label a) const
	Given one vertex, return the other. More...
label	commonVertex (const edge &a) const
	Return common vertex. 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 T v[Size])
	Construct from C-array. More...
	FixedList (const T &)
	Construct from value. More...
	FixedList (const UList< T > &)
	Construct from UList. More...
	FixedList (const SLList< T > &)
	Construct from SLList. More...
	FixedList (const FixedList< T, Size > &)
	Copy constructor. More...
	FixedList (Istream &)
	Construct from Istream. More...
autoPtr< FixedList< T, 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 T *	cdata () const
	Return a const pointer to the first data element,. More...
T *	data ()
	Return a pointer to the first data element,. More...
T &	first ()
	Return the first element of the list. More...
const T &	first () const
	Return first element of the list. More...
T &	last ()
	Return the last element of the list. More...
const T &	last () 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< T, Size > &)
	Copy (not transfer) the argument contents. More...
void	writeEntry (Ostream &) const
	Write the FixedList as a dictionary entry. More...
void	writeEntry (const word &keyword, Ostream &) const
	Write the FixedList as a dictionary entry with keyword. More...
T &	operator[] (const label)
	Return element of FixedList. More...
const T &	operator[] (const label) const
	Return element of constant FixedList. More...
void	operator= (const T v[Size])
	Assignment from array operator. Takes linear time. More...
void	operator= (const UList< T > &)
	Assignment from UList operator. Takes linear time. More...
void	operator= (const SLList< T > &)
	Assignment from SLList operator. Takes linear time. More...
void	operator= (const T &)
	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< T, Size > &)
	Swap two FixedLists of the same type in constant time. More...
bool	operator== (const FixedList< T, Size > &) const
	Equality operation on FixedLists of the same type. More...
bool	operator!= (const FixedList< T, Size > &) const
	The opposite of the equality operation. Takes linear time. More...
bool	operator< (const FixedList< T, Size > &) const
	Compare two FixedLists lexicographically. Takes linear time. More...
bool	operator> (const FixedList< T, Size > &) const
	Compare two FixedLists lexicographically. Takes linear time. More...
bool	operator<= (const FixedList< T, Size > &) const
	Return true if !(a > b). Takes linear time. More...
bool	operator>= (const FixedList< T, 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< T, 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 T	value_type
	Type of values the FixedList contains. More...
typedef T &	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 T *	iterator
	Random access iterator for traversing FixedList. More...
typedef T *	reverse_iterator
	Reverse iterator for reverse traversal of FixedList. More...
Data Fields inherited from FixedList< label, 2 >
const typedef T &	const_reference
	Type that can be used for storing into. More...
const typedef T *	const_iterator
	Random access iterator for traversing FixedList. More...
const typedef T *	const_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

• edge.H
• edgeI.H

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 Foam::constant::physicoChemical::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]

Foam::label & start ( ) const

inline

Return start vertex label.

Definition at line 81 of file edgeI.H.

Referenced by PrimitivePatch< labelledTri, List, pointField, point >::calcBdryPoints(), enrichedPatch::calcCutFaces(), polyMeshGenAddressing::calcEdgeFaces(), primitiveMesh::calcEdges(), polyMeshGenAddressing::calcEdges(), polyMeshGenAddressing::calcFaceEdges(), meshSurfaceEngine::calculateEdgeFacesAddressing(), triSurfAddressing::calculateFacetEdges(), surfaceIntersection::classifyHit(), edge::commonVertex(), slidingInterface::coupleInterface(), extrudeLayer::createNewVertices(), triSurfaceCurvatureEstimator::curvatureAtEdge(), refineBoundaryLayers::refineEdgeHexCell::determineFacesInDirections(), edgesConnected(), directionInfo::edgeToFaceIndex(), meshOctreeCube::findContainedEdges(), refineBoundaryLayers::generateNewCellsPrism(), refineBoundaryLayers::generateNewFaces(), refineBoundaryLayers::refineCornerHexCell::generateNewPoints(), refineBoundaryLayers::generateNewVertices(), intersectedSurface::intersectedSurface(), meshOctreeCubeCoordinates::intersectsTriangleExact(), cellFeatures::isFeaturePoint(), meshSurfaceMapper2D::mapCorners(), polyMeshFilter::mapOldMeshEdgeFieldToNewMesh(), slidingInterface::modifyMotionPoints(), surfaceFeatures::nearestFeatEdge(), boundaryLayerOptimisation::optimiseThicknessVariation(), Foam::polyMeshZipUpCells(), slidingInterface::projectPoints(), refineBoundaryLayers::refineFace(), PatchTools::sortedPointEdges(), extendedEdgeMesh::sortPointsAndEdges(), triSurf::topologyCheck(), cellCuts::validLoop(), and polyMeshGenModifier::zipUpCells().

Here is the caller graph for this function:

start() [2/2]

label& start ( )

inline

Return start vertex label.

end() [1/2]

Foam::label & end ( ) const

inline

Return end vertex label.

Definition at line 92 of file edgeI.H.

Referenced by PrimitivePatch< labelledTri, List, pointField, point >::calcBdryPoints(), enrichedPatch::calcCutFaces(), primitiveMesh::calcEdges(), polyMeshGenAddressing::calcEdges(), meshSurfaceEngine::calculateEdgeFacesAddressing(), surfaceIntersection::classifyHit(), edge::commonVertex(), slidingInterface::coupleInterface(), extrudeLayer::createNewVertices(), triSurfaceCurvatureEstimator::curvatureAtEdge(), refineBoundaryLayers::refineEdgeHexCell::determineFacesInDirections(), edgesConnected(), directionInfo::edgeToFaceIndex(), meshOctreeCube::findContainedEdges(), refineBoundaryLayers::generateNewCellsPrism(), refineBoundaryLayers::refineCornerHexCell::generateNewPoints(), intersectedSurface::intersectedSurface(), meshOctreeCubeCoordinates::intersectsTriangleExact(), cellFeatures::isFeaturePoint(), meshSurfaceMapper2D::mapCorners(), polyMeshFilter::mapOldMeshEdgeFieldToNewMesh(), slidingInterface::modifyMotionPoints(), Foam::polyMeshZipUpCells(), slidingInterface::projectPoints(), refineBoundaryLayers::refineFace(), PatchTools::sortedPointEdges(), extendedEdgeMesh::sortPointsAndEdges(), triSurf::topologyCheck(), cellCuts::validLoop(), and polyMeshGenModifier::zipUpCells().

Here is the caller graph for this function:

end() [2/2]

label& end ( )

inline

Return end vertex label.

otherVertex()

Foam::label otherVertex ( const label  a ) const

inline

Given one vertex, return the other.

Definition at line 103 of file edgeI.H.

Referenced by removePoints::countPointUsage(), autoSnapDriver::isFeaturePoint(), intersectedSurface::nextEdge(), GTSsurfaceFormat< Face >::read(), triSurface::readGTS(), and hexRef8::storeMidPointInfo().

Here is the caller graph for this function:

commonVertex()

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

inline

Return common vertex.

Definition at line 121 of file edgeI.H.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

flip()

void flip ( )

inline

Flip the edge in-place.

Definition at line 139 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 145 of file edgeI.H.

Referenced by enrichedPatch::calcCutFaces().

Here is the caller graph for this function:

centre()

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

inline

Return centre (centroid)

Definition at line 151 of file edgeI.H.

References p.

Referenced by main(), 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 157 of file edgeI.H.

References p.

Referenced by boundaryLayerOptimisation::calculateHairVectorsAtTheBoundary(), slidingInterface::coupleInterface(), cellFeatures::isFeaturePoint(), slidingInterface::modifyMotionPoints(), 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 163 of file edgeI.H.

References Foam::mag(), and p.

Referenced by refineBoundaryLayers::refineCornerHexCell::generateNewPoints(), and 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 169 of file edgeI.H.

References p.

Referenced by slidingInterface::coupleInterface(), slidingInterface::modifyMotionPoints(), slidingInterface::projectPoints(), and addPatchCellLayer::setFaceProps().

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
• -1: same edge, but different orientation

Definition at line 36 of file edgeI.H.

References Foam::constant::physicoChemical::b.

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

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

Field 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:

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