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

Inheritance diagram for polyLineEdge:

Collaboration diagram for polyLineEdge:

Public Member Functions
	TypeName ("polyLine")

	polyLineEdge (const pointField &points, const edge &fromTo, const pointField &intermediate)
	Construct from components. More...

	polyLineEdge (const pointField &points, const label from, const label to, const pointField &intermediate)
	Construct from components. More...

	polyLineEdge (const dictionary &dict, const label index, const searchableSurfaces &, const pointField &points, Istream &is)
	Construct from Istream and point field. More...

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

point	position (const scalar lambda) 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< blockEdge >	clone () 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 point &	firstPoint () const
	The location of the first point. More...

const point &	lastPoint () 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< pointField >	position (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...

Public Member Functions inherited from polyLine
	polyLine (const pointField &points, const bool notImplementedClosed=false)
	Construct from components. More...

	polyLine (const point &start, const pointField &intermediate, const point &end, const bool notImplementedClosed=false)
	Construct from begin, intermediate, end points. More...

const pointField &	points () const noexcept
	Return const-access to the control-points. More...

label	nSegments () const noexcept
	The number of line segments. More...

point	position (const scalar) const
	The point position corresponding to the curve parameter. More...

point	position (const label segment, const scalar) const
	The point position corresponding to the local parameter. More...

scalar	length () const noexcept
	The length of the curve. 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 Public Member Functions inherited from polyLine
static tmp< pointField >	concat (const point &start, const pointField &intermediate, const point &end)
	Concatenate begin, intermediate and end points. More...

Protected Member Functions inherited from blockEdge
	blockEdge (const pointField &points, const label from, const label to)
	Construct from components. More...

Protected Member Functions inherited from polyLine
void	calcParam ()

label	localParameter (scalar &lambda) const

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 pointField &	points_
	The referenced point field. More...

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

const label	end_
	Index of the last point. More...

Protected Attributes inherited from polyLine
pointField	points_
	The control points or ends of each segments. More...

scalar	lineLength_
	The real (total) 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/3]

polyLineEdge	(	const pointField &	points,
		const edge &	fromTo,
		const pointField &	intermediate
	)

Construct from components.

Parameters

points	Referenced point field
fromTo	Start/end in point field
intermediate	The intermediate points

Definition at line 46 of file polyLineEdge.C.

◆ polyLineEdge() [2/3]

polyLineEdge	(	const pointField &	points,
		const label	from,
		const label	to,
		const pointField &	intermediate
	)

Construct from components.

Parameters

points	Referenced point field
from	Start point in point field
to	End point in point field
intermediate	The intermediate points

Definition at line 58 of file polyLineEdge.C.

◆ polyLineEdge() [3/3]

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

Construct from Istream and point field.

Parameters

points Referenced point field

Definition at line 70 of file polyLineEdge.C.

◆ ~polyLineEdge()

virtual ~polyLineEdge ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "polyLine" )

◆ 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 86 of file polyLineEdge.C.

References lambda(), and particle< Type >::positionsCompat1706::position.

Here is the call graph for this function:

◆ length()

Foam::scalar length ( ) const

virtual

The length of the curve.

Implements blockEdge.

Definition at line 92 of file polyLineEdge.C.

References polyLine::lineLength_.

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

src/mesh/blockMesh/blockEdges/polyLineEdge/polyLineEdge.H
src/mesh/blockMesh/blockEdges/polyLineEdge/polyLineEdge.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ polyLineEdge() [1/3]

◆ polyLineEdge() [2/3]

◆ polyLineEdge() [3/3]

◆ ~polyLineEdge()

Member Function Documentation

◆ TypeName()

◆ position()

◆ length()