FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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>


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

Inheritance diagram for edge:
Collaboration diagram for edge:

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)

Constructor & Destructor Documentation

edge (  ) [inline]

Null constructor for lists.

Definition at line 54 of file edgeI.H.

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

Construct from components.

Definition at line 58 of file edgeI.H.

References b.

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

Construct from FixedList.

Definition at line 65 of file edgeI.H.

edge ( Istream &   is  ) [inline]

Construct from Istream.

Definition at line 72 of file edgeI.H.


Member Function Documentation

Foam::label start (  ) const [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(), octreeDataFace::getSampleType(), octreeDataFaceList::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(), meshCutter::setRefinement(), meshCutAndRemove::setRefinement(), boundaryCutter::setRefinement(), PatchTools::sortedEdgeFaces(), surfaceIntersection::surfaceIntersection(), interactionLists::testEdgeEdgeDistance(), directionInfo::updateCell(), meshCutter::updateMesh(), meshCutAndRemove::updateMesh(), boundaryCutter::updateMesh(), and PrimitivePatch< Face, FaceList, PointField, PointType >::whichEdge().

Foam::label & start (  ) [inline]

Return start vertex label.

Definition at line 85 of file edgeI.H.

Foam::label end (  ) const [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(), octreeDataFace::getSampleType(), octreeDataFaceList::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(), meshCutter::setRefinement(), meshCutAndRemove::setRefinement(), surfaceIntersection::surfaceIntersection(), interactionLists::testEdgeEdgeDistance(), meshCutter::updateMesh(), meshCutAndRemove::updateMesh(), and boundaryCutter::updateMesh().

Foam::label & end (  ) [inline]

Return end vertex label.

Reimplemented from FixedList< label, 2 >.

Definition at line 96 of file edgeI.H.

Foam::label otherVertex ( const label   a  ) const [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().

Foam::label commonVertex ( const edge &   a  ) const [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().

Foam::edge reverseEdge (  ) const [inline]

Return reverse edge.

Definition at line 138 of file edgeI.H.

Foam::point centre ( const pointField &   p  ) const [inline]

Return centre (centroid)

Definition at line 144 of file edgeI.H.

Referenced by surfaceFeatures::nearestEdges(), treeDataEdge::points(), and hexRef8::setRefinement().

Foam::scalar mag ( const pointField &   p  ) const [inline]

Return scalar magnitude.

Definition at line 156 of file edgeI.H.

References Foam::mag().

Referenced by autoSnapDriver::calcSnapDistance(), and surfaceIntersection::surfaceIntersection().

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 35 of file edgeI.H.

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


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 68 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