polyLineEdge Class Reference

A curvedEdge 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 &, const label start, const label end, const pointField &otherPoints)
	Construct from components. More...
	polyLineEdge (const pointField &, Istream &)
	Construct from Istream. More...
virtual	~polyLineEdge ()
	Destructor. More...
point	position (const scalar lambda) 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 curvedEdge
	TypeName ("curvedEdge")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, curvedEdge, Istream,(const pointField &points, Istream &is),(points, is))
	curvedEdge (const pointField &points, const label start, const label end)
	Construct from components. More...
	curvedEdge (const pointField &, Istream &)
	Construct from Istream setting pointsList. More...
	curvedEdge (const curvedEdge &)
	Copy construct. More...
virtual autoPtr< curvedEdge >	clone () const
	Clone function. More...
virtual	~curvedEdge ()
	Destructor. More...
label	start () const
	Return label of start point. More...
label	end () const
	Return label of end point. More...
int	compare (const curvedEdge &) 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...
void	operator= (const curvedEdge &)
Public Member Functions inherited from polyLine
	polyLine (const pointField &, const bool notImplementedClosed=false)
	Construct from components. More...
const pointField &	points () const
	Return const-access to the control-points. More...
label	nSegments () const
	Return the number of line segments. More...
point	position (const scalar) const
	Return the point position corresponding to the curve parameter. More...
point	position (const label segment, const scalar) const
	Return the point position corresponding to the local parameter. More...
scalar	length () const
	Return the length of the curve. More...

Additional Inherited Members
Static Public Member Functions inherited from curvedEdge
static autoPtr< curvedEdge >	New (const pointField &, Istream &)
	New function which constructs and returns pointer to a curvedEdge. More...
Protected Member Functions inherited from polyLine
void	calcParam ()
	Precalculate the rational cumulative parameter value. More...
label	localParameter (scalar &lambda) const
	Return the line segment and the local parameter [0..1]. More...
Static Protected Member Functions inherited from curvedEdge
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 curvedEdge
const pointField &	points_
const label	start_
const label	end_
Protected Attributes inherited from polyLine
pointField	points_
	The control points or ends of each segments. More...
scalar	lineLength_
	The real line length. More...
scalarList	param_
	The rational (0-1) cumulative parameter value for each point. More...

Detailed Description

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

Source files

• polyLineEdge.H
• polyLineEdge.C

Definition at line 49 of file polyLineEdge.H.

Constructor & Destructor Documentation

polyLineEdge	(	const pointField &	ps,
		const label	start,
		const label	end,
		const pointField &	otherPoints
	)

Construct from components.

Definition at line 42 of file polyLineEdge.C.

polyLineEdge	(	const pointField &	ps,
		Istream &	is
	)

Construct from Istream.

Definition at line 54 of file polyLineEdge.C.

~polyLineEdge ( )

virtual

Destructor.

Definition at line 63 of file polyLineEdge.C.

Member Function Documentation

TypeName

(

"polyLine"

)

Foam::point position ( const scalar  lambda ) const

virtual

Return the point position corresponding to the curve parameter.

0 <= lambda <= 1

Implements curvedEdge.

Definition at line 69 of file polyLineEdge.C.

References polyLine::position().

Here is the call graph for this function:

Foam::scalar length ( ) const

virtual

Return the length of the curve.

Implements curvedEdge.

Definition at line 75 of file polyLineEdge.C.

References polyLine::lineLength_.

---

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

• src/mesh/blockMesh/curvedEdges/polyLineEdge.H
• src/mesh/blockMesh/curvedEdges/polyLineEdge.C