diff --git a/src/OpenFOAM/meshes/meshShapes/edge/edge.H b/src/OpenFOAM/meshes/meshShapes/edge/edge.H index 5557ce4045..c479af2217 100644 --- a/src/OpenFOAM/meshes/meshShapes/edge/edge.H +++ b/src/OpenFOAM/meshes/meshShapes/edge/edge.H @@ -28,13 +28,13 @@ Class Foam::edge Description - An edge is a list of two point labels. The functionality it provides - supports the discretisation on a 2-D flat mesh. + An edge is a list of two vertex labels. + This can correspond to a directed graph edge or an edge on a mesh. The edge is implemented as a Pair/FixedList of labels. As well as geometrically relevant methods, it also provides methods similar to HashSet for additional convenience. - Valid point labels are always non-negative (since they correspond to + Valid vertex labels are always non-negative (eg, since they correspond to addressing within the mesh). The value '-1' is used to tag invalid point labels that correspond conceptually to open 'slots', which can be filled with a HashSet-like functionality. @@ -69,30 +69,31 @@ public: // Static Data Members + //- The typeName ("edge") static const char* const typeName; // Constructors - //- Default construct, with invalid point labels (-1) + //- Default construct, with invalid vertex labels (-1) inline edge(); - //- Construct from two point labels + //- Construct from two vertex labels inline edge(const label from, const label to); - //- Construct from pair of point labels + //- Construct from pair of vertex labels inline edge(const labelPair& pair); - //- Construct from list of point labels + //- Construct from list of vertex labels inline edge(const FixedList& list); - //- Construct from two point labels, sorted with first less-than second + //- Construct from two vertex labels, sorted with first less-than second inline edge(const label from, const label to, const bool doSort); //- Construct from list, sorted with first less-than second inline edge(const FixedList& list, const bool doSort); - //- Copy construct from a subset of point labels + //- Copy construct from a subset of vertex labels inline edge ( const UList