line Class Reference

A line primitive. More...

Public Member Functions
	line (const Point &start, const Point &end)
	Construct from two points. More...
	line (const UList< Point > &, const FixedList< label, 2 > &indices)
	Construct from two points in the list of points. More...
	line (Istream &)
	Construct from Istream. More...
PointRef	start () const
	Return first vertex. More...
PointRef	end () const
	Return second vertex. More...
Point	centre () const
	Return centre (centroid) More...
scalar	mag () const
	Return scalar magnitude. More...
Point	vec () const
	Return start-end vector. More...
PointHit< Point >	nearestDist (const Point &p) const
	Return nearest distance to line from a given point. More...
scalar	nearestDist (const line< Point, const Point & > &edge, Point &thisPoint, Point &edgePoint) const
	Return nearest distance from line to line. Returns distance. More...
scalar	nearestDist (const line< point2D, const point2D & > &e, point2D &thisPt, point2D &edgePt) const
scalar	nearestDist (const line< point2D, const point2D & > &edge, point2D &thisPoint, point2D &edgePoint) const
	2D specialisation More...

Private Attributes
PointRef	a_
PointRef	b_

Friends
Istream &	operator>> (Istream &, line &)
Ostream &	operator (Ostream &, const line &)

Detailed Description

A line primitive.

Source files

• line.H
• lineI.H

Definition at line 56 of file line.H.

Constructor & Destructor Documentation

line() [1/3]

line ( const Point &  start, const Point &  end  )

inline

Construct from two points.

Definition at line 31 of file lineI.H.

line() [2/3]

line ( const UList< Point > &  , const FixedList< label, 2 > &  indices  )

inline

Construct from two points in the list of points.

The indices could be from edge etc.

line() [3/3]

line ( Istream &  )

inline

Construct from Istream.

Member Function Documentation

start()

PointRef start ( ) const

inline

Return first vertex.

Definition at line 60 of file lineI.H.

Referenced by slidingInterface::coupleInterface(), plane::lineIntersect(), slidingInterface::modifyMotionPoints(), onLine(), and slidingInterface::projectPoints().

Here is the caller graph for this function:

end()

PointRef end ( ) const

inline

Return second vertex.

Definition at line 66 of file lineI.H.

Referenced by onLine().

Here is the caller graph for this function:

centre()

Point centre ( ) const

inline

Return centre (centroid)

Definition at line 73 of file lineI.H.

Referenced by surfaceFeatures::nearestSurfEdge().

Here is the caller graph for this function:

mag()

Foam::scalar mag ( ) const

inline

Return scalar magnitude.

Definition at line 80 of file lineI.H.

References Foam::mag().

Referenced by slidingInterface::coupleInterface(), slidingInterface::modifyMotionPoints(), and slidingInterface::projectPoints().

Here is the call graph for this function:

Here is the caller graph for this function:

vec()

Point vec ( ) const

inline

Return start-end vector.

Definition at line 87 of file lineI.H.

Referenced by slidingInterface::coupleInterface(), searchablePlane::findLine(), plane::lineIntersect(), slidingInterface::modifyMotionPoints(), and slidingInterface::projectPoints().

Here is the caller graph for this function:

nearestDist() [1/4]

Foam::PointHit< Point > nearestDist

(

const Point &

p

)

const

Return nearest distance to line from a given point.

If the nearest point is on the line, return a hit

Definition at line 95 of file lineI.H.

References Foam::constant::physicoChemical::b, Foam::constant::physicoChemical::c1, Foam::constant::physicoChemical::c2, Foam::mag(), p, and w().

Referenced by slidingInterface::coupleInterface(), treeDataFace::getVolumeType(), slidingInterface::modifyMotionPoints(), slidingInterface::projectPoints(), and faceCollapser::setRefinement().

Here is the call graph for this function:

Here is the caller graph for this function:

nearestDist() [2/4]

scalar nearestDist	(	const line< Point, const Point & > &	edge,
		Point &	thisPoint,
		Point &	edgePoint
	)		const

Return nearest distance from line to line. Returns distance.

and sets both points (one on *this, one on the provided linePointRef.

nearestDist() [3/4]

scalar nearestDist	(	const line< point2D, const point2D & > &	e,
		point2D &	thisPt,
		point2D &	edgePt
	)		const

Definition at line 37 of file line.C.

References Foam::e, Foam::mag(), Foam::max(), Foam::min(), Vector2D< Cmpt >::perp(), s(), and w().

Here is the call graph for this function:

nearestDist() [4/4]

scalar nearestDist	(	const line< point2D, const point2D & > &	edge,
		point2D &	thisPoint,
		point2D &	edgePoint
	)		const

2D specialisation

Friends And Related Function Documentation

operator>>

Istream& operator>> ( Istream &  , line &    )

friend

operator

Ostream& operator ( Ostream &  , const line &    )

friend

Field Documentation

a_

PointRef a_

private

Definition at line 74 of file line.H.

b_

PointRef b_

private

Definition at line 74 of file line.H.

---

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

• src/OpenFOAM/meshes/primitiveShapes/line/line.H
• src/OpenFOAM/meshes/primitiveShapes/line/lineI.H