Public Member Functions | List of all members
lineEdge Class Reference

A straight edge between the start point and the end point. More...

Inheritance diagram for lineEdge:
Inheritance graph
[legend]
Collaboration diagram for lineEdge:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("line")
 Runtime type information. More...
 
 lineEdge (const pointField &, const label start, const label end)
 Construct from components. More...
 
 lineEdge (const pointField &, Istream &)
 Construct from Istream with a pointField. More...
 
virtual ~lineEdge ()
 Destructor. More...
 
point position (const scalar) const
 Return the point position corresponding to the curve parameter. More...
 
scalar length () const
 Return the length of the curve. More...
 
- Public Member Functions inherited from curvedEdge
 TypeName ("curvedEdge")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, curvedEdge, Istream,(const pointField &points, Istream &is),(points, is))
 
 curvedEdge (const pointField &points, const label start, const label end)
 Construct from components. More...
 
 curvedEdge (const pointField &, Istream &)
 Construct from Istream setting pointsList. More...
 
 curvedEdge (const curvedEdge &)
 Copy construct. More...
 
virtual autoPtr< curvedEdgeclone () const
 Clone function. More...
 
virtual ~curvedEdge ()
 Destructor. More...
 
label start () const
 Return label of start point. More...
 
label end () const
 Return label of end point. More...
 
int compare (const curvedEdge &) const
 Compare the given start and end points with this curve. More...
 
int compare (const edge &) const
 Compare the given start and end points with this curve. More...
 
int compare (const label start, const label end) const
 Compare the given start and end points with this curve. More...
 
void operator= (const curvedEdge &)
 

Additional Inherited Members

- Static Public Member Functions inherited from curvedEdge
static autoPtr< curvedEdgeNew (const pointField &, Istream &)
 New function which constructs and returns pointer to a curvedEdge. More...
 
- Static Protected Member Functions inherited from curvedEdge
static pointField appendEndPoints (const pointField &, const label start, const label end, const pointField &otherKnots)
 Return a complete point field by appending the start/end points. More...
 
- Protected Attributes inherited from curvedEdge
const pointFieldpoints_
 
const label start_
 
const label end_
 

Detailed Description

A straight edge between the start point and the end point.

Source files

Definition at line 49 of file lineEdge.H.

Constructor & Destructor Documentation

lineEdge ( const pointField points,
const label  start,
const label  end 
)

Construct from components.

Definition at line 42 of file lineEdge.C.

lineEdge ( const pointField points,
Istream is 
)

Construct from Istream with a pointField.

Definition at line 52 of file lineEdge.C.

~lineEdge ( )
virtual

Destructor.

Definition at line 60 of file lineEdge.C.

Member Function Documentation

TypeName ( "line"  )

Runtime type information.

Foam::point position ( const scalar  lambda) const
virtual

Return the point position corresponding to the curve parameter.

0 <= lambda <= 1

Implements curvedEdge.

Definition at line 66 of file lineEdge.C.

References Foam::abort(), curvedEdge::end_, Foam::FatalError, FatalErrorInFunction, curvedEdge::points_, and curvedEdge::start_.

Here is the call graph for this function:

Foam::scalar length ( ) const
virtual

Return the length of the curve.

Implements curvedEdge.

Definition at line 79 of file lineEdge.C.

References curvedEdge::end_, Foam::mag(), curvedEdge::points_, and curvedEdge::start_.

Here is the call graph for this function:


The documentation for this class was generated from the following files: