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:

[legend]

Collaboration diagram for edge:

[legend]

List of all members.

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.
Static Public Member Functions
static int	compare (const edge &, const edge &)
	compare edges
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)

---

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 54 of file edge.H.

---

Constructor & Destructor Documentation

edge

(

)

[inline]

Null constructor for lists.

Definition at line 46 of file edgeI.H.

edge	(	const label	a,
		const label	b
	)			[inline]

Construct from components.

Definition at line 50 of file edgeI.H.

edge

(

const FixedList< label, 2 > &

a

)

[inline]

Construct from FixedList.

Definition at line 57 of file edgeI.H.

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

Here is the call graph for this function:

edge

(

Istream &

is

)

[inline]

Construct from Istream.

Definition at line 64 of file edgeI.H.

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

Here is the call graph for this function:

---

Member Function Documentation

Foam::label start

(

)

const [inline]

Return start vertex label.

Definition at line 72 of file edgeI.H.

Referenced by PatchTools::checkOrientation(), PrimitivePatch< Face, FaceList, PointField, PointType >::checkTopology(), edge::edge(), triSurfaceTools::getVertexTriangles(), triSurfaceTools::minEdge(), surfaceFeatures::nearestEdges(), octreeDataEdges::octreeDataEdges(), Foam::polyMeshZipUpCells(), PatchTools::sortedEdgeFaces(), interactionLists::testPointFaceDistance(), and PrimitivePatch< Face, FaceList, PointField, PointType >::whichEdge().

Here is the caller graph for this function:

Foam::label & start

(

)

[inline]

Return start vertex label.

Definition at line 77 of file edgeI.H.

Foam::label end

(

)

const [inline]

Return end vertex label.

Reimplemented from FixedList< label, 2 >.

Definition at line 83 of file edgeI.H.

Referenced by PatchTools::checkOrientation(), PrimitivePatch< Face, FaceList, PointField, PointType >::checkTopology(), edge::edge(), triSurfaceTools::getVertexTriangles(), triSurfaceTools::minEdge(), Foam::polyMeshZipUpCells(), and interactionLists::testPointFaceDistance().

Here is the caller graph for this function:

Foam::label & end

(

)

[inline]

Return end vertex label.

Reimplemented from FixedList< label, 2 >.

Definition at line 88 of file edgeI.H.

Foam::label otherVertex

(

const label

a

)

const [inline]

Given one vertex, return the other.

Definition at line 94 of file edgeI.H.

Foam::label commonVertex

(

const edge &

a

)

const [inline]

Return common vertex.

Definition at line 112 of file edgeI.H.

Foam::edge reverseEdge

(

)

const [inline]

Return reverse edge.

Definition at line 130 of file edgeI.H.

Foam::point centre

(

const pointField &

p

)

const [inline]

Return centre (centroid).

Definition at line 136 of file edgeI.H.

Referenced by surfaceFeatures::nearestEdges().

Here is the caller graph for this function:

Foam::vector vec

(

const pointField &

p

)

const [inline]

Return the vector (end - start).

Definition at line 142 of file edgeI.H.

Referenced by surfaceFeatures::nearestEdges(), and PatchTools::sortedEdgeFaces().

Here is the caller graph for this function:

Foam::scalar mag

(

const pointField &

p

)

const [inline]

Return scalar magnitude.

Definition at line 148 of file edgeI.H.

Foam::linePointRef line

(

const pointField &

p

)

const [inline]

Return edge line.

Definition at line 154 of file edgeI.H.

Referenced by treeDataEdge::findNearest(), and surfaceLocation::write().

Here is the caller graph for this function:

int compare	(	const edge &	a,
		const edge &	b
	)			[inline, static]

compare edges

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

Definition at line 27 of file edgeI.H.

Referenced by Foam::operator!=().

Here is the caller graph for this function:

---

Friends And Related Function Documentation

bool operator==	(	const edge &	a,
		const edge &	b
	)			[friend]

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

---

Member Data Documentation

const char *const typeName = "edge" [static]

Definition at line 63 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