Geometric class that creates a 3D plane and can return the intersection point between a line and the plane. More...

#include <plane.H>

Inheritance diagram for plane:

[legend]

Classes
class	ray
	A reference point and direction. More...

Public Types
enum	side { FRONT = 1 , BACK = -1 , NORMAL = FRONT , FLIP = BACK }
	Side of the plane. More...

Public Member Functions
	plane ()
	Construct zero-initialised.
	plane (const vector &normalVector)
	Construct from normal vector through the origin.
	plane (const point &originPoint, const vector &normalVector, const bool doNormalise=true)
	Construct from normal vector and point in plane.
	plane (const point &point1, const point &point2, const point &point3)
	Construct from three points in plane.
	plane (const UList< scalar > &coeffs)
	Construct from coefficients for the plane equation: ax + by + cz + d = 0.
	plane (const FixedList< scalar, 4 > &coeffs)
	Construct from coefficients for the plane equation: ax + by + cz + d = 0.
	plane (const dictionary &dict)
	Construct from dictionary.
	plane (Istream &is)
	Construct from Istream. Assumes (normal) (origin) input.
const vector &	normal () const noexcept
	The plane unit normal.
const point &	origin () const noexcept
	The plane base point.
point &	origin () noexcept
	The plane base point, for modification.
void	flip ()
	Flip the plane by reversing the normal.
FixedList< scalar, 4 >	planeCoeffs () const
	Return coefficients for the plane equation: ax + by + cz + d = 0.
point	nearestPoint (const point &p) const
	Return nearest point in the plane for the given point.
scalar	distance (const point &p) const
	Return distance (magnitude) from the given point to the plane.
scalar	signedDistance (const point &p) const
	Return distance from the given point to the plane.
scalar	normalIntersect (const point &pnt0, const vector &dir) const
	Return cut coefficient for plane and line defined by origin and direction.
scalar	normalIntersect (const ray &r) const
	Return cut coefficient for plane and ray.
template<class PointType, class PointRef>
scalar	lineIntersect (const line< PointType, PointRef > &l) const
	Return the cutting point between the plane and a line passing through the supplied points.
ray	planeIntersect (const plane &plane2) const
	Return the cutting line between this plane and another.
point	planePlaneIntersect (const plane &plane2, const plane &plane3) const
	Return the cutting point between this plane and two other planes.
point	somePointInPlane (const scalar dist=1e-3) const
	Return a point somewhere on the plane, a distance from the base.
side	whichSide (const point &p) const
	Return the side of the plane that the point is on.
int	sign (const point &p, const scalar tol=SMALL) const
	The sign for the side of the plane that the point is on.
point	mirror (const point &p) const
	Mirror the supplied point in the plane. Return the mirrored point.
void	writeDict (Ostream &os) const
	Write to dictionary.
const point &	refPoint () const noexcept
	The plane base point (same as origin).
side	sideOfPlane (const point &p) const
	Same as whichSide().

Detailed Description

Geometric class that creates a 3D plane and can return the intersection point between a line and the plane.

Construction from a dictionary is driven by the planeType. If planeType is missing, pointAndNormal is used and the pointAndNormalDict becomes optional.

For planeType as pointAndNormal :

pointAndNormalDict
{
    point   <point>;   // basePoint (1612 and earlier)
    normal  <vector>;  // normalVector (1612 and earlier)
}

For planeType as embeddedPoints :

embeddedPointsDict
{
    point1  <point>;
    point2  <point>;
    point3  <point>;
}

For planeType with planeEquation coefficients $ ax + by + cz + d = 0 $ :

planeEquationDict
{
   a   <scalar>;
   b   <scalar>;
   c   <scalar>;
   d   <scalar>;
}

Source files

Definition at line 90 of file plane.H.

Member Enumeration Documentation

◆ side

enum side

Side of the plane.

Enumerator
FRONT	The front (positive normal) side of the plane.
BACK	The back (negative normal) side of the plane.
NORMAL	Alias for FRONT.
FLIP	Alias for BACK.

Definition at line 99 of file plane.H.

Constructor & Destructor Documentation

◆ plane() [1/8]

plane ( )

inline

Construct zero-initialised.

Definition at line 23 of file planeI.H.

References Foam::Zero.

Referenced by cuttingPlane::checkOverlap(), cuttingPlane::cuttingPlane(), cuttingPlane::cuttingPlane(), cuttingPlane::cuttingPlane(), cuttingPlane::cuttingPlane(), cuttingPlane::operator=(), cuttingPlane::performCut(), cuttingPlane::planeDesc(), cuttingPlane::planeDesc(), planeIntersect(), planePlaneIntersect(), searchableDisk::searchableDisk(), searchablePlane::searchablePlane(), and searchablePlane::searchablePlane().

Here is the caller graph for this function:

◆ plane() [2/8]

plane ( const vector & normalVector )

explicit

Construct from normal vector through the origin.

The vector is normalised to a unit vector on input.

Definition at line 115 of file plane.C.

References FUNCTION_NAME, and Foam::Zero.

◆ plane() [3/8]

plane	(	const point &	originPoint,
		const vector &	normalVector,
		const bool	doNormalise = true )

Construct from normal vector and point in plane.

By default, the vector is normalised to a unit vector on input.

Definition at line 124 of file plane.C.

References FUNCTION_NAME.

◆ plane() [4/8]

plane	(	const point &	point1,
		const point &	point2,
		const point &	point3 )

Construct from three points in plane.

Definition at line 164 of file plane.C.

References b, and FUNCTION_NAME.

◆ plane() [5/8]

plane ( const UList< scalar > & coeffs )

explicit

Construct from coefficients for the plane equation: ax + by + cz + d = 0.

Definition at line 138 of file plane.C.

References FUNCTION_NAME.

◆ plane() [6/8]

plane ( const FixedList< scalar, 4 > & coeffs )

explicit

Construct from coefficients for the plane equation: ax + by + cz + d = 0.

Definition at line 151 of file plane.C.

References FUNCTION_NAME.

◆ plane() [7/8]

plane ( const dictionary & dict )

explicit

Construct from dictionary.

Definition at line 170 of file plane.C.

References Foam::abort(), dict, Foam::FatalIOError, FatalIOErrorInFunction, dictionary::get(), dictionary::getCompat(), if(), Foam::nl, and Foam::Zero.

Here is the call graph for this function:

◆ plane() [8/8]

plane ( Istream & is )

explicit

Construct from Istream. Assumes (normal) (origin) input.

Definition at line 231 of file plane.C.

References FUNCTION_NAME.

Member Function Documentation

◆ normal()

const Foam::vector & normal ( ) const

inlinenoexcept

The plane unit normal.

Definition at line 32 of file planeI.H.

References Foam::noexcept.

Referenced by geomCellLooper::cut(), searchableDisk::getNormal(), searchablePlane::getNormal(), mirror(), Foam::operator<<(), Foam::operator==(), planeIntersect(), sampledPlane::print(), sampledPlane::sampledPlane(), searchableDisk::searchableDisk(), searchablePlane::searchablePlane(), and searchablePlane::TypeName().

Here is the caller graph for this function:

◆ origin() [1/2]

const Foam::point & origin ( ) const

inlinenoexcept

The plane base point.

Definition at line 38 of file planeI.H.

References Foam::noexcept.

Referenced by searchableDisk::boundingSpheres(), searchablePlane::boundingSpheres(), searchableDisk::coordinates(), searchablePlane::coordinates(), Foam::operator<(), Foam::operator<<(), Foam::operator==(), planeIntersect(), sampledPlane::print(), sampledPlane::sampledPlane(), and searchableDisk::searchableDisk().

Here is the caller graph for this function:

◆ origin() [2/2]

Foam::point & origin ( )

inlinenoexcept

The plane base point, for modification.

Definition at line 44 of file planeI.H.

References Foam::noexcept.

◆ flip()

void flip ( )

inline

Flip the plane by reversing the normal.

Definition at line 50 of file planeI.H.

◆ planeCoeffs()

Foam::FixedList< Foam::scalar, 4 > planeCoeffs ( ) const

Return coefficients for the plane equation: ax + by + cz + d = 0.

Definition at line 242 of file plane.C.

References Foam::mag().

Referenced by planePlaneIntersect(), and somePointInPlane().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nearestPoint()

Foam::point nearestPoint ( const point & p ) const

inline

Return nearest point in the plane for the given point.

Definition at line 56 of file planeI.H.

References p.

Referenced by searchablePlane::findNearest(), and mirror().

Here is the caller graph for this function:

◆ distance()

Foam::scalar distance ( const point & p ) const

inline

Return distance (magnitude) from the given point to the plane.

Definition at line 62 of file planeI.H.

References Foam::mag(), p, and signedDistance().

Referenced by geomCellLooper::cut().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ signedDistance()

Foam::scalar signedDistance ( const point & p ) const

inline

Return distance from the given point to the plane.

Definition at line 68 of file planeI.H.

References p.

Referenced by distance(), sign(), and whichSide().

Here is the caller graph for this function:

◆ normalIntersect() [1/2]

Foam::scalar normalIntersect	(	const point &	pnt0,
		const vector &	dir ) const

Return cut coefficient for plane and line defined by origin and direction.

Definition at line 292 of file plane.C.

References Foam::stabilise().

Referenced by lineIntersect(), and normalIntersect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ normalIntersect() [2/2]

scalar normalIntersect ( const ray & r ) const

inline

Return cut coefficient for plane and ray.

Definition at line 307 of file plane.H.

References normalIntersect().

Here is the call graph for this function:

◆ lineIntersect()

template<class PointType, class PointRef>

scalar lineIntersect ( const line< PointType, PointRef > & l ) const

inline

Return the cutting point between the plane and a line passing through the supplied points.

Definition at line 317 of file plane.H.

References normalIntersect(), line< Point, PointRef >::start(), and line< Point, PointRef >::vec().

Referenced by slidingInterface::modifyMotionPoints(), cuttingPlane::performCut(), and surfaceFeatures::subsetPlane().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ planeIntersect()

Foam::plane::ray planeIntersect ( const plane & plane2 ) const

Return the cutting line between this plane and another.

Returned as direction vector and point line goes through.

Definition at line 304 of file plane.C.

References Foam::mag(), normal(), origin(), plane(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Referenced by searchableSurfacesQueries::findNearest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ planePlaneIntersect()

Foam::point planePlaneIntersect	(	const plane &	plane2,
		const plane &	plane3 ) const

Return the cutting point between this plane and two other planes.

Definition at line 372 of file plane.C.

References b, Foam::inv(), plane(), and planeCoeffs().

Here is the call graph for this function:

◆ somePointInPlane()

Foam::point somePointInPlane ( const scalar dist = 1e-3 ) const

Return a point somewhere on the plane, a distance from the base.

Definition at line 395 of file plane.C.

References Foam::mag(), p, planeCoeffs(), and VectorSpace< Form, Cmpt, Ncmpts >::uniform().

Here is the call graph for this function:

◆ whichSide()

Foam::plane::side whichSide ( const point & p ) const

inline

Return the side of the plane that the point is on.

If the point is on the plane, then returns FRONT.

Returns

+1 (FRONT): above or on plane (front-side)
-1 (BACK): below plane (back-side)

Definition at line 74 of file planeI.H.

References BACK, FRONT, p, and signedDistance().

Referenced by sideOfPlane().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sign()

int sign	(	const point &	p,
		const scalar	tol = SMALL ) const

inline

The sign for the side of the plane that the point is on.

Uses the supplied tolerance for rounding around zero.

Returns

0: on plane
+1 (FRONT): above plane (front-side)
-1 (BACK): below plane (back-side)

Definition at line 82 of file planeI.H.

References p, and signedDistance().

Here is the call graph for this function:

◆ mirror()

Foam::point mirror ( const point & p ) const

Mirror the supplied point in the plane. Return the mirrored point.

Definition at line 423 of file plane.C.

References Foam::distance(), nearestPoint(), normal(), and p.

Here is the call graph for this function:

◆ writeDict()

void writeDict ( Ostream & os ) const

Write to dictionary.

Definition at line 438 of file plane.C.

References os().

Here is the call graph for this function:

◆ refPoint()

const point & refPoint ( ) const

inlinenoexcept

The plane base point (same as origin).

Definition at line 381 of file plane.H.

References Foam::noexcept.

◆ sideOfPlane()

side sideOfPlane ( const point & p ) const

inline

Same as whichSide().

Definition at line 386 of file plane.H.

References p, and whichSide().

Here is the call graph for this function:

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

src/OpenFOAM/meshes/primitiveShapes/plane/plane.H
src/OpenFOAM/meshes/primitiveShapes/plane/plane.C
src/OpenFOAM/meshes/primitiveShapes/plane/planeI.H

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ side

Constructor & Destructor Documentation

◆ plane() [1/8]

◆ plane() [2/8]

◆ plane() [3/8]

◆ plane() [4/8]

◆ plane() [5/8]

◆ plane() [6/8]

◆ plane() [7/8]

◆ plane() [8/8]

Member Function Documentation

◆ normal()

◆ origin() [1/2]

◆ origin() [2/2]

◆ flip()

◆ planeCoeffs()

◆ nearestPoint()

◆ distance()

◆ signedDistance()

◆ normalIntersect() [1/2]

◆ normalIntersect() [2/2]

◆ lineIntersect()

◆ planeIntersect()

◆ planePlaneIntersect()

◆ somePointInPlane()

◆ whichSide()

◆ sign()

◆ mirror()

◆ writeDict()

◆ refPoint()

◆ sideOfPlane()