FreeFOAM The Cross-Platform CFD Toolkit
splineEdge Class Reference

A curvedEdge interface for Catmull-Rom splines. More...


Detailed Description

A curvedEdge interface for Catmull-Rom splines.

Note:
For compatibility, also accepts the type names 'polySpline' and 'simpleSpline'.
Source files

Definition at line 54 of file splineEdge.H.

+ Inheritance diagram for splineEdge:
+ Collaboration diagram for splineEdge:

List of all members.

Public Member Functions

 TypeName ("spline")
 Runtime type information.
 splineEdge (const pointField &, const label start, const label end, const pointField &internalPoints)
 Construct from components.
 splineEdge (const pointField &, Istream &)
 Construct from Istream, setting pointsList.
virtual ~splineEdge ()
 Destructor.
virtual point position (const scalar) const
 Return the point position corresponding to the curve parameter.
virtual scalar length () const
 Return the length of the spline curve (not implemented)
- 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 CatmullRomSpline
 CatmullRomSpline (const pointField &knots, const bool notImplementedClosed=false)
 Construct from components.
point position (const label segment, const scalar lambda) const
 Return the point position corresponding to the local parameter.
- 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.

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.
- 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_

Constructor & Destructor Documentation

splineEdge ( const pointField ,
const label  start,
const label  end,
const pointField internalPoints 
)

Construct from components.

splineEdge ( const pointField ,
Istream  
)

Construct from Istream, setting pointsList.

virtual ~splineEdge ( )
virtual

Destructor.


Member Function Documentation

TypeName ( "spline"  )

Runtime type information.

virtual point position ( const scalar  ) const
virtual

Return the point position corresponding to the curve parameter.

0 <= lambda <= 1

Reimplemented from CatmullRomSpline.

virtual scalar length ( ) const
virtual

Return the length of the spline curve (not implemented)

Reimplemented from CatmullRomSpline.


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