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

Inheritance diagram for lineEdge:

Collaboration diagram for lineEdge:

Public Member Functions
	TypeName ("line")
	Runtime type information. More...

	lineEdge (const pointField &points, const label start, const label end)
	Construct from components. More...

	lineEdge (const dictionary &dict, const label index, const searchableSurfaces &geometry, 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 label start, const label end)
	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< blockEdge >	clone () const
	Clone function. More...

virtual	~blockEdge ()=default
	Destructor. More...

label	start () const
	Index of start point. More...

label	end () const
	Index of end 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...

virtual tmp< pointField >	position (const scalarList &lambdas) const
	The point positions corresponding to the curve parameters. 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< blockEdge >	New (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...

Static Protected Member Functions inherited from blockEdge
static pointField	appendEndPoints (const pointField &points, const label start, const label end, const pointField &intermediate)

Protected Attributes inherited from blockEdge
const pointField &	points_
	The referenced point field. More...

const label	start_
	Index of the start point. More...

const label	end_
	Index of the end 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/2]

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

Construct from components.

Parameters

points	Referenced point field
start	Start point in referenced point field
end	End point in referenced point field

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 and point field.

Parameters

points Referenced point field

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

The point position corresponding to the curve parameter.

0 <= lambda <= 1

Implements blockEdge.

Definition at line 72 of file lineEdge.C.

References blockEdge::end_, InfoInFunction, lambda(), Foam::nl, blockEdge::points_, and blockEdge::start_.

Here is the call graph for this function:

◆ length()

Foam::scalar length ( ) const

virtual

The length of the curve.

Implements blockEdge.

Definition at line 95 of file lineEdge.C.

References Foam::mag().