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 &, const label start, const label end)
 Construct from components. More...
 
 lineEdge (const dictionary &dict, const label index, const searchableSurfaces &geometry, const pointField &, Istream &is)
 Construct from Istream with a pointField. More...
 
virtual ~lineEdge ()=default
 Destructor. More...
 
point position (const scalar) 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...
 

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

Detailed Description

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

Source files

Definition at line 54 of file lineEdge.H.

Constructor & Destructor Documentation

◆ lineEdge() [1/2]

lineEdge ( const pointField points,
const label  start,
const label  end 
)

Construct from components.

Definition at line 47 of file lineEdge.C.

◆ lineEdge() [2/2]

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

Construct from Istream with a pointField.

Definition at line 58 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

Return the point position corresponding to the curve parameter.

0 <= lambda <= 1

Implements blockEdge.

Definition at line 72 of file lineEdge.C.

References Foam::abort(), blockEdge::end_, Foam::FatalError, FatalErrorInFunction, lambda(), blockEdge::points_, and blockEdge::start_.

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 85 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: