lineEdge Class Reference

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

#include <lineEdge.H>

Inheritance diagram for lineEdge:

Collaboration diagram for lineEdge:

Public Member Functions
	TypeName ("line")
	Runtime type information.
	lineEdge (const pointField &points, const edge &fromTo)
	Construct from components.
	lineEdge (const pointField &points, const label from, const label to)
	Construct from components.
	lineEdge (const dictionary &dict, const label index, const searchableSurfaces &, const pointField &points, Istream &is)
	Construct from Istream and point field.
virtual	~lineEdge ()=default
	Destructor.
point	position (const scalar) const
	The point position corresponding to the curve parameter.
scalar	length () const
	The length of the curve.
Public Member Functions inherited from blockEdge
	TypeName ("blockEdge")
	Runtime type information.
	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.
	blockEdge (const dictionary &dict, const label index, const pointField &points, Istream &is)
	Construct from Istream and point field.
virtual autoPtr< blockEdge >	clone () const
	Clone function.
virtual	~blockEdge ()=default
	Destructor.
bool	good () const noexcept
	True if first/last indices are unique and non-negative.
bool	valid () const noexcept
	Same as good().
label	start () const noexcept
	Index of start (first) point.
label	end () const noexcept
	Index of end (last) point.
const point &	firstPoint () const
	The location of the first point.
const point &	lastPoint () const
	The location of the last point.
int	compare (const blockEdge &e) const
	Compare the given start/end points with this block edge.
int	compare (const edge &e) const
	Compare the given start/end points with this block edge.
int	compare (const label start, const label end) const
	Compare the given start/end points with this block edge.
point	linearPosition (const scalar lambda) const
	The point position in the straight line.
virtual tmp< pointField >	position (const scalarList &lambdas) const
	The point positions corresponding to the curve parameters.
void	write (Ostream &os, const dictionary &dict) const
	Write edge with variable back-substitution.

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.
Protected Member Functions inherited from blockEdge
	blockEdge (const pointField &points, const label from, const label to)
	Construct from components.
Static Protected Member Functions inherited from blockEdge
static pointField	appendEndPoints (const pointField &p, const label from, const label to, const pointField &intermediate)
	Return a complete point field by appending the start/end points to the given list.
Protected Attributes inherited from blockEdge
const pointField &	points_
	The referenced point field.
const label	start_
	Index of the first point.
const label	end_
	Index of the last point.

Detailed Description

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

Source files

• lineEdge.H
• lineEdge.C

Definition at line 49 of file lineEdge.H.

Constructor & Destructor Documentation

lineEdge() [1/3]

lineEdge	(	const pointField &	points,
		const edge &	fromTo )

Construct from components.

Parameters

points	Referenced point field
fromTo	Start/end in point field

Definition at line 39 of file lineEdge.C.

References blockEdge::blockEdge(), and points.

Here is the call graph for this function:

lineEdge() [2/3]

lineEdge	(	const pointField &	points,
		const label	from,
		const label	to )

Construct from components.

Parameters

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

Definition at line 49 of file lineEdge.C.

References blockEdge::blockEdge(), and points.

Here is the call graph for this function:

lineEdge() [3/3]

lineEdge	(	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 60 of file lineEdge.C.

References blockEdge::blockEdge(), dict, and points.

Here is the call graph for this function:

~lineEdge()

virtual ~lineEdge ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"line"

)

Runtime type information.

References dict, and points.

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 75 of file lineEdge.C.

References lambda(), and blockEdge::linearPosition().

Here is the call graph for this function:

length()

Foam::scalar length ( ) const

virtual

The length of the curve.

Implements blockEdge.

Definition at line 81 of file lineEdge.C.

References blockEdge::firstPoint(), blockEdge::lastPoint(), and Foam::mag().

Here is the call graph for this function:

---

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

• src/mesh/blockMesh/blockEdges/lineEdge/lineEdge.H
• src/mesh/blockMesh/blockEdges/lineEdge/lineEdge.C