OpenFOAM logo
Open Source CFD Toolkit

edge Class Reference

Inheritance diagram for edge:

Inheritance graph
[legend]
Collaboration diagram for edge:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 edge ()
 Null constructor for lists.
 edge (const label a, const label b)
 Construct from components.
 edge (Istream &)
 Construct from Istream.
label start () const
 Return start vertex label.
labelstart ()
 Return start vertex label.
label end () const
 Return end vertex label.
labelend ()
 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.

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

edge const label  a,
const label  b
[inline]
 

Construct from components.

Definition at line 50 of file edgeI.H.

References Foam::label.

edge Istream  )  [inline]
 

Construct from Istream.

Definition at line 57 of file edgeI.H.

References Foam::label, and FixedList< label, 2 >::operator[]().

Here is the call graph for this function:


Member Function Documentation

point centre const pointField  )  const [inline]
 

Return centre (centroid).

Definition at line 129 of file edgeI.H.

References p.

label commonVertex const edge a  )  const [inline]
 

Return common vertex.

Definition at line 105 of file edgeI.H.

label & end  )  [inline]
 

Return end vertex label.

Reimplemented from FixedList< label, 2 >.

Definition at line 81 of file edgeI.H.

References edge::end().

Here is the call graph for this function:

label end  )  const [inline]
 

Return end vertex label.

Reimplemented from FixedList< label, 2 >.

Definition at line 76 of file edgeI.H.

Referenced by edge::end().

linePointRef line const pointField  )  const [inline]
 

Return edge line.

Definition at line 147 of file edgeI.H.

scalar mag const pointField  )  const [inline]
 

Return scalar magnitude.

Definition at line 141 of file edgeI.H.

label otherVertex const label  a  )  const [inline]
 

Given one vertex, return the other.

Definition at line 87 of file edgeI.H.

edge reverseEdge  )  const [inline]
 

Return reverse edge.

Definition at line 123 of file edgeI.H.

References p.

label & start  )  [inline]
 

Return start vertex label.

Definition at line 70 of file edgeI.H.

label start  )  const [inline]
 

Return start vertex label.

Definition at line 65 of file edgeI.H.

vector vec const pointField  )  const [inline]
 

Return the vector (end - start).

Definition at line 135 of file edgeI.H.


Friends And Related Function Documentation

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

Definition at line 165 of file edgeI.H.

bool operator== const edge a,
const edge b
[friend]
 

Definition at line 155 of file edgeI.H.


The documentation for this class was generated from the following files:
For further information go to www.openfoam.org