lineEdge Class Reference

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

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

Public Member Functions

 TypeName ("line")
 Runtime type information. More...
 
 lineEdge (const pointField &points, const edge &fromTo)
 Construct from components. More...
 
 lineEdge (const pointField &points, const label from, const label to)
 Construct from components. More...
 
 lineEdge (const dictionary &dict, const label index, const searchableSurfaces &, const pointField &points, Istream &is)
 Construct from Istream and point field. More...
 
virtual ~lineEdge ()=default
 Destructor. More...
 
point position (const scalar) const
 The point position corresponding to the curve parameter. More...
 
scalar length () const
 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 edge &fromTo)
 Construct from components. More...
 
 blockEdge (const dictionary &dict, const label index, const pointField &points, Istream &is)
 Construct from Istream and point field. More...
 
virtual autoPtr< blockEdgeclone () const
 Clone function. More...
 
virtual ~blockEdge ()=default
 Destructor. More...
 
bool valid () const noexcept
 True if first/last indices are unique and non-negative. More...
 
label start () const noexcept
 Index of start (first) point. More...
 
label end () const noexcept
 Index of end (last) point. More...
 
const pointfirstPoint () const
 The location of the first point. More...
 
const pointlastPoint () const
 The location of the last point. More...
 
int compare (const blockEdge &e) const
 Compare the given start/end points with this block edge. More...
 
int compare (const edge &e) const
 Compare the given start/end points with this block edge. More...
 
int compare (const label start, const label end) const
 Compare the given start/end points with this block edge. More...
 
point linearPosition (const scalar lambda) const
 The point position in the straight line. More...
 
virtual point position (const scalar lambda) const =0
 The point position corresponding to the curve parameter. More...
 
virtual tmp< pointFieldposition (const scalarList &lambdas) const
 The point positions corresponding to the curve parameters. More...
 
virtual scalar length () const =0
 The length of the curve. More...
 
void write (Ostream &os, const dictionary &dict) const
 Write edge with variable back-substitution. 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 &points, Istream &is)
 New function which constructs and returns pointer to a blockEdge. More...
 
- Protected Member Functions inherited from blockEdge
 blockEdge (const pointField &points, const label from, const label to)
 Construct from components. More...
 
- Static Protected Member Functions inherited from blockEdge
static pointField appendEndPoints (const pointField &p, const label from, const label to, const pointField &intermediate)
 
- Protected Attributes inherited from blockEdge
const pointFieldpoints_
 The referenced point field. More...
 
const label start_
 Index of the first point. More...
 
const label end_
 Index of the last point. More...
 

Detailed Description

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

Source files

Definition at line 53 of file lineEdge.H.

Constructor & Destructor Documentation

◆ lineEdge() [1/3]

lineEdge ( const pointField points,
const edge fromTo 
)

Construct from components.

Parameters
pointsReferenced point field
fromToStart/end in point field

Definition at line 46 of file lineEdge.C.

◆ lineEdge() [2/3]

lineEdge ( const pointField points,
const label  from,
const label  to 
)

Construct from components.

Parameters
pointsReferenced point field
fromStart point in point field
toEnd point in point field

Definition at line 56 of file lineEdge.C.

◆ lineEdge() [3/3]

lineEdge ( const dictionary dict,
const label  index,
const searchableSurfaces ,
const pointField points,
Istream is 
)

Construct from Istream and point field.

Parameters
pointsReferenced point field

Definition at line 67 of file lineEdge.C.

◆ ~lineEdge()

virtual ~lineEdge ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "line"  )

Runtime type information.

◆ position()

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

The point position corresponding to the curve parameter.

0 <= lambda <= 1

Implements blockEdge.

Definition at line 82 of file lineEdge.C.

References lambda(), and blockEdge::linearPosition().

Here is the call graph for this function:

◆ length()

Foam::scalar length ( ) const
virtual

The length of the curve.

Implements blockEdge.

Definition at line 88 of file lineEdge.C.

References Foam::mag().

Here is the call graph for this function:

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