FreeFOAM The Cross-Platform CFD Toolkit
polyLineEdge Class Reference

A curvedEdge defined in terms of a series of straight line segments. More...


Detailed Description

+ Inheritance diagram for polyLineEdge:
+ Collaboration diagram for polyLineEdge:

List of all members.

Public Member Functions

 TypeName ("polyLine")
 polyLineEdge (const pointField &, const label start, const label end, const pointField &otherPoints)
 Construct from components.
 polyLineEdge (const pointField &, Istream &)
 Construct from Istream.
virtual ~polyLineEdge ()
 Destructor.
point position (const scalar lambda) const
 Return the point position corresponding to the curve parameter.
scalar length () const
 Return the length of the curve.
- Public Member Functions inherited from curvedEdge
 TypeName ("curvedEdge")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, curvedEdge, Istream,(const pointField &points, Istream &is),(points, is))
 curvedEdge (const pointField &points, const label start, const label end)
 Construct from components.
 curvedEdge (const pointField &, Istream &)
 Construct from Istream setting pointsList.
 curvedEdge (const curvedEdge &)
 Copy construct.
virtual autoPtr< curvedEdgeclone () const
 Clone function.
virtual ~curvedEdge ()
label start () const
 Return label of start point.
label end () const
 Return label of end point.
int compare (const curvedEdge &) const
 Compare the given start and end points with this curve.
int compare (const edge &) const
 Compare the given start and end points with this curve.
int compare (const label start, const label end) const
 Compare the given start and end points with this curve.
void operator= (const curvedEdge &)
- Public Member Functions inherited from polyLine
 polyLine (const pointField &, const bool notImplementedClosed=false)
 Construct from components.
const pointFieldpoints () const
 Return const-access to the control-points.
label nSegments () const
 Return the number of line segments.
point position (const label segment, const scalar) const
 Return the point position corresponding to the local parameter.

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.
- Protected Member Functions inherited from polyLine
void calcParam ()
 Precalculate the rational cumulative parameter value.
label localParameter (scalar &lambda) const
 Return the line segment and the local parameter [0..1].
- 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.
- Protected Attributes inherited from curvedEdge
const pointFieldpoints_
const label start_
const label end_
- Protected Attributes inherited from polyLine
pointField points_
 The control points or ends of each segments.
scalar lineLength_
 The real line length.
scalarList param_
 The rational (0-1) cumulative parameter value for each point.

Constructor & Destructor Documentation

polyLineEdge ( const pointField ,
const label  start,
const label  end,
const pointField otherPoints 
)

Construct from components.

polyLineEdge ( const pointField ,
Istream  
)

Construct from Istream.

virtual ~polyLineEdge ( )
virtual

Destructor.


Member Function Documentation

TypeName ( "polyLine"  )
point position ( const scalar  lambda) const
virtual

Return the point position corresponding to the curve parameter.

0 <= lambda <= 1

Implements curvedEdge.

scalar length ( ) const
virtual

Return the length of the curve.

Implements curvedEdge.


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