polyLineEdge Class Reference

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)
	polyLineEdge (const pointField &points, const label from, const label to, const pointField &intermediate)
	polyLineEdge (const dictionary &dict, const label index, const searchableSurfaces &, const pointField &points, Istream &is)
virtual	~polyLineEdge ()=default
point	position (const scalar lambda) const
scalar	length () const
Public Member Functions inherited from blockEdge
	TypeName ("blockEdge")
	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)
	blockEdge (const dictionary &dict, const label index, const pointField &points, Istream &is)
virtual autoPtr< blockEdge >	clone () const
virtual	~blockEdge ()=default
bool	valid () const noexcept
label	start () const noexcept
label	end () const noexcept
const point &	firstPoint () const
const point &	lastPoint () const
int	compare (const blockEdge &e) const
int	compare (const edge &e) const
int	compare (const label start, const label end) const
point	linearPosition (const scalar lambda) const
virtual tmp< pointField >	position (const scalarList &lambdas) const
void	write (Ostream &os, const dictionary &dict) const
Public Member Functions inherited from polyLine
	polyLine (const pointField &points, const bool notImplementedClosed=false)
	polyLine (const point &start, const pointField &intermediate, const point &end, const bool notImplementedClosed=false)
const pointField &	points () const noexcept
label	nSegments () const noexcept
point	position (const scalar) const
point	position (const label segment, const scalar) const
scalar	length () const noexcept

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)
Static Public Member Functions inherited from polyLine
static tmp< pointField >	concat (const point &start, const pointField &intermediate, const point &end)
Protected Member Functions inherited from blockEdge
	blockEdge (const pointField &points, const label from, const label to)
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_
const label	start_
const label	end_
Protected Attributes inherited from polyLine
pointField	points_
scalar	lineLength_
scalarList	param_

Detailed Description

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

Source files

• polyLineEdge.H
• polyLineEdge.C

Definition at line 50 of file polyLineEdge.H.

Constructor & Destructor Documentation

polyLineEdge() [1/3]

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

Parameters

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

Definition at line 40 of file polyLineEdge.C.

polyLineEdge() [2/3]

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

Parameters

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

Definition at line 52 of file polyLineEdge.C.

polyLineEdge() [3/3]

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

Parameters

points

Referenced point field

Definition at line 64 of file polyLineEdge.C.

~polyLineEdge()

virtual ~polyLineEdge ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"polyLine"

)

position()

Foam::point position ( const scalar  lambda ) const

virtual

Implements blockEdge.

Definition at line 79 of file polyLineEdge.C.

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

Here is the call graph for this function:

length()

Foam::scalar length ( ) const

virtual

Implements blockEdge.

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