polyLineEdge Class Reference

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

Inheritance diagram for polyLineEdge:
[legend]
Collaboration diagram for polyLineEdge:
[legend]

Public Member Functions

 TypeName ("polyLine")
 
 polyLineEdge (const pointField &, const label start, const label end, const pointField &otherPoints)
 Construct from components. More...
 
 polyLineEdge (const dictionary &dict, const label index, const searchableSurfaces &geometry, const pointField &, Istream &is)
 Construct from Istream. More...
 
virtual ~polyLineEdge ()=default
 Destructor. More...
 
point position (const scalar lambda) 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 blockEdge
 TypeName ("blockEdge")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, blockEdge, Istream,(const dictionary &dict, const label index, const searchableSurfaces &geometry, const pointField &points, Istream &is),(dict, index, geometry, points, is))
 
 blockEdge (const pointField &points, const label start, const label end)
 Construct from components. More...
 
 blockEdge (const dictionary &dict, const label index, const pointField &, Istream &)
 Construct from Istream setting pointsList. More...
 
virtual autoPtr< blockEdgeclone () const
 Clone function. More...
 
virtual ~blockEdge ()=default
 Destructor. More...
 
label start () const
 Return label of start point. More...
 
label end () const
 Return label of end point. More...
 
int compare (const blockEdge &) 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...
 
virtual tmp< pointFieldposition (const scalarList &) const
 Return the point positions corresponding to the curve parameters. More...
 
void write (Ostream &, const dictionary &) const
 Write edge with variable backsubstitution. More...
 
- Public Member Functions inherited from polyLine
 polyLine (const pointField &, const bool notImplementedClosed=false)
 Construct from components. More...
 
const pointFieldpoints () const
 Return const-access to the control-points. More...
 
label nSegments () const
 Return the number of line segments. More...
 
point position (const scalar) const
 Return the point position corresponding to the curve parameter. More...
 
point position (const label segment, const scalar) const
 Return the point position corresponding to the local parameter. More...
 
scalar length () const
 Return the length of the curve. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from blockEdge
static autoPtr< blockEdgeNew (const dictionary &dict, const label index, const searchableSurfaces &geometry, const pointField &, Istream &)
 New function which constructs and returns pointer to a blockEdge. More...
 
- Protected Member Functions inherited from polyLine
void calcParam ()
 Precalculate the rational cumulative parameter value. More...
 
label localParameter (scalar &lambda) const
 Return the line segment and the local parameter [0..1]. More...
 
- Static Protected Member Functions inherited from blockEdge
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 blockEdge
const pointFieldpoints_
 
const label start_
 
const label end_
 
- Protected Attributes inherited from polyLine
pointField points_
 The control points or ends of each segments. More...
 
scalar lineLength_
 The real line length. More...
 
scalarList param_
 The rational (0-1) cumulative parameter value for each point. More...
 

Detailed Description

A blockEdge defined in terms of a series of straight line segments.

Source files

Definition at line 54 of file polyLineEdge.H.

Constructor & Destructor Documentation

◆ polyLineEdge() [1/2]

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

Construct from components.

Definition at line 47 of file polyLineEdge.C.

◆ polyLineEdge() [2/2]

polyLineEdge ( const dictionary dict,
const label  index,
const searchableSurfaces geometry,
const pointField ps,
Istream is 
)

Construct from Istream.

Definition at line 60 of file polyLineEdge.C.

◆ ~polyLineEdge()

virtual ~polyLineEdge ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "polyLine"  )

◆ position()

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

Return the point position corresponding to the curve parameter.

0 <= lambda <= 1

Implements blockEdge.

Definition at line 75 of file polyLineEdge.C.

References lambda(), and polyLine::position().

Here is the call graph for this function:

◆ length()

Foam::scalar length ( ) const
virtual

Return the length of the curve.

Implements blockEdge.

Definition at line 81 of file polyLineEdge.C.

References polyLine::lineLength_.


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