FreeFOAM The Cross-Platform CFD Toolkit
curvedEdge Class Reference

Define a curved edge that is parameterized for 0<lambda<1 between the start and end point. More...


Detailed Description

Define a curved edge that is parameterized for 0<lambda<1 between the start and end point.

Source files

Definition at line 54 of file curvedEdge.H.

+ Inheritance diagram for curvedEdge:
+ Collaboration diagram for curvedEdge:

List of all members.

Public Member Functions

 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.
virtual point position (const scalar) const =0
 Return the point position corresponding to the curve parameter.
virtual scalar length () const =0
 Return the length of the curve.
void operator= (const curvedEdge &)

Static Public Member Functions

static autoPtr< curvedEdgeNew (const pointField &, Istream &)
 New function which constructs and returns pointer to a curvedEdge.

Static Protected Member Functions

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

const pointFieldpoints_
const label start_
const label end_

Friends

Ostreamoperator<< (Ostream &, const curvedEdge &)

Constructor & Destructor Documentation

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 ~curvedEdge ( )
inlinevirtual

Definition at line 122 of file curvedEdge.H.


Member Function Documentation

static pointField appendEndPoints ( const pointField ,
const label  start,
const label  end,
const pointField otherKnots 
)
staticprotected

Return a complete point field by appending the start/end points.

to the given list

TypeName ( "curvedEdge"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
curvedEdge  ,
Istream  ,
(const pointField &points, Istream &is)  ,
(points, is)   
)
virtual autoPtr<curvedEdge> clone ( ) const
virtual

Clone function.

static autoPtr<curvedEdge> New ( const pointField ,
Istream  
)
static

New function which constructs and returns pointer to a curvedEdge.

Foam::label start ( ) const
inline

Return label of start point.

Definition at line 28 of file curvedEdgeI.H.

References curvedEdge::start_.

Referenced by curvedEdge::compare().

Foam::label end ( ) const
inline

Return label of end point.

Definition at line 34 of file curvedEdgeI.H.

Referenced by curvedEdge::compare().

int compare ( const curvedEdge e) const
inline

Compare the given start and end points with this curve.

  • 0: different

+1: identical

  • -1: same edge, but different orientation

Definition at line 57 of file curvedEdgeI.H.

References curvedEdge::end(), and curvedEdge::start().

Referenced by curvedEdge::compare().

int compare ( const edge e) const
inline

Compare the given start and end points with this curve.

  • 0: different

+1: identical

  • -1: same edge, but different orientation

Definition at line 63 of file curvedEdgeI.H.

References curvedEdge::compare(), edge::end(), and edge::start().

int compare ( const label  start,
const label  end 
) const
inline

Compare the given start and end points with this curve.

  • 0: different

+1: identical

  • -1: same edge, but different orientation

Definition at line 40 of file curvedEdgeI.H.

virtual point position ( const scalar  ) const
pure virtual

Return the point position corresponding to the curve parameter.

0 <= lambda <= 1

Implemented in arcEdge, splineEdge, polyLineEdge, and lineEdge.

virtual scalar length ( ) const
pure virtual

Return the length of the curve.

Implemented in arcEdge, splineEdge, polyLineEdge, and lineEdge.

void operator= ( const curvedEdge )

Friends And Related Function Documentation

Ostream& operator<< ( Ostream ,
const curvedEdge  
)
friend

Member Data Documentation

const pointField& points_
protected

Definition at line 60 of file curvedEdge.H.

const label start_
protected

Definition at line 61 of file curvedEdge.H.

Referenced by curvedEdge::start().

const label end_
protected

Definition at line 62 of file curvedEdge.H.


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