A triangle primitive used to calculate face normals and swept volumes. Uses referred points. More...

Classes
class	dummyOp
	Dummy. More...

class	storeOp
	Store resulting tris. More...

class	sumAreaOp
	Sum resulting areas. More...

Public Types
enum	proxType { NONE = 0, POINT, EDGE }
	Proximity classifications. More...

typedef Point	point_type
	The point type. More...

typedef FixedList< triPoints, 27 >	triIntersectionList
	Storage type for triangles originating from intersecting triangle with another triangle. More...

Public Member Functions
	triangle (const Point &p0, const Point &p1, const Point &p2)
	Construct from three points. More...

	triangle (const FixedList< Point, 3 > &pts)
	Construct from three points. More...

	triangle (const UList< Point > &points, const FixedList< label, 3 > &indices)
	Construct from three points in the list of points. More...

	triangle (Istream &is)
	Construct from Istream. More...

const Point &	a () const noexcept
	The first vertex. More...

const Point &	b () const noexcept
	The second vertex. More...

const Point &	c () const noexcept
	The third vertex. More...

Point	centre () const
	Return centre (centroid) More...

vector	areaNormal () const
	The area normal - with magnitude equal to area of triangle. More...

vector	unitNormal () const
	Return unit normal. More...

	FOAM_DEPRECATED_FOR (2018-12, "areaNormal() or unitNormal()") vector normal() const
	Legacy name for areaNormal(). More...

scalar	mag () const
	The magnitude of the triangle area. More...

Pair< Point >	box () const
	The enclosing (bounding) box for the triangle. More...

Point	vecA () const
	Edge vector opposite point a(): from b() to c() More...

Point	vecB () const
	Edge vector opposite point b(): from c() to a() More...

Point	vecC () const
	Edge vector opposite point c(): from a() to b() More...

Point	circumCentre () const
	Return circum-centre. More...

scalar	circumRadius () const
	Return circum-radius. More...

scalar	quality () const
	Return quality: Ratio of triangle and circum-circle. More...

scalar	sweptVol (const triangle &t) const
	Return swept-volume. More...

tensor	inertia (PointRef refPt=Zero, scalar density=1.0) const
	Return the inertia tensor, with optional reference. More...

Point	randomPoint (Random &rndGen) const
	Return a random point on the triangle from a uniform distribution. More...

Point	barycentricToPoint (const barycentric2D &bary) const
	Calculate the point from the given barycentric coordinates. More...

barycentric2D	pointToBarycentric (const point &pt) const
	Calculate the barycentric coordinates from the given point. More...

scalar	pointToBarycentric (const point &pt, barycentric2D &bary) const
	Calculate the barycentric coordinates from the given point. More...

bool	intersects (const point &origin, const vector &normal) const
	Fast intersection detection with a plane. More...

bool	intersects (const point &origin, const vector::components axis) const
	Fast intersection detection with an axis plane. More...

pointHit	ray (const point &p, const vector &q, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction dir=intersection::VECTOR) const
	Return point intersection with a ray. More...

pointHit	intersection (const point &p, const vector &q, const intersection::algorithm alg, const scalar tol=0.0) const
	Fast intersection with a ray. More...

pointHit	nearestPointClassify (const point &p, label &nearType, label &nearLabel) const
	Find the nearest point to p on the triangle and classify it: More...

pointHit	nearestPoint (const point &p) const
	Return nearest point to p on triangle. More...

bool	classify (const point &p, label &nearType, label &nearLabel) const
	Classify nearest point to p in triangle plane. More...

pointHit	nearestPoint (const linePointRef &edge, pointHit &edgePoint) const
	Return nearest point to line on triangle. Returns hit if. More...

int	sign (const point &p, const scalar tol=SMALL) const
	The sign for which side of the face plane the point is on. More...

template<class AboveOp , class BelowOp >
void	sliceWithPlane (const plane &pln, AboveOp &aboveOp, BelowOp &belowOp) const
	Decompose triangle into triangles above and below plane. More...

template<class InsideOp , class OutsideOp >
void	triangleOverlap (const vector &n, const triangle< Point, PointRef > &tri, InsideOp &insideOp, OutsideOp &outsideOp) const
	Decompose triangle into triangles inside and outside. More...

Static Public Member Functions
static Point	centre (const Point &p0, const Point &p1, const Point &p2)
	The centre (centroid) of three points. More...

static vector	areaNormal (const Point &p0, const Point &p1, const Point &p2)
	The area normal for a triangle defined by three points (right-hand rule). Magnitude equal to area of the triangle. More...

static vector	unitNormal (const Point &p0, const Point &p1, const Point &p2)
	The unit normal for a triangle defined by three points (right-hand rule). More...

static Pair< Point >	box (const Point &p0, const Point &p1, const Point &p2)
	The enclosing (bounding) box for three points. More...

Friends
Istream &	operator>> (Istream &, triangle &)

Ostream &	operator (Ostream &, const triangle &)

Detailed Description

template<class Point, class PointRef>
class Foam::triangle< Point, PointRef >

A triangle primitive used to calculate face normals and swept volumes. Uses referred points.

Source files

Definition at line 217 of file triangle.H.

Member Typedef Documentation

◆ point_type

typedef Point point_type

The point type.

Definition at line 226 of file triangle.H.

◆ triIntersectionList

typedef FixedList<triPoints, 27> triIntersectionList

Storage type for triangles originating from intersecting triangle with another triangle.

Definition at line 232 of file triangle.H.

Member Enumeration Documentation

◆ proxType

enum proxType

Proximity classifications.

Enumerator
NONE	Unknown proximity.
POINT	Close to point.
EDGE	Close to edge.

Definition at line 237 of file triangle.H.

Constructor & Destructor Documentation

◆ triangle() [1/4]

triangle	(	const Point &	p0,
		const Point &	p1,
		const Point &	p2
	)

inline

Construct from three points.

Definition at line 67 of file triangleI.H.

◆ triangle() [2/4]

triangle ( const FixedList< Point, 3 > & pts )

inline

Construct from three points.

Definition at line 81 of file triangleI.H.

◆ triangle() [3/4]

triangle	(	const UList< Point > &	points,
		const FixedList< label, 3 > &	indices
	)

inline

Construct from three points in the list of points.

The indices could be from triFace etc.

Definition at line 93 of file triangleI.H.

◆ triangle() [4/4]

triangle ( Istream & is )

inlineexplicit

Construct from Istream.

Definition at line 105 of file triangleI.H.

Member Function Documentation

◆ a()

const Point& a ( ) const

inlinenoexcept

The first vertex.

Definition at line 371 of file triangle.H.

Referenced by triSurfaceTools::calcInterpolationWeights(), triangleFuncs::intersectBb(), boundBox::intersects(), offsetSurface::operator()(), and triangle< Point, PointRef >::triangleOverlap().

Here is the caller graph for this function:

◆ b()

const Point& b ( ) const

inlinenoexcept

The second vertex.

Definition at line 376 of file triangle.H.

Referenced by triSurfaceTools::calcInterpolationWeights(), triangleFuncs::intersectBb(), boundBox::intersects(), offsetSurface::operator()(), and triangle< Point, PointRef >::triangleOverlap().

Here is the caller graph for this function:

◆ c()

const Point& c ( ) const

inlinenoexcept

The third vertex.

Definition at line 381 of file triangle.H.

Referenced by triSurfaceTools::calcInterpolationWeights(), triangleFuncs::intersectBb(), boundBox::intersects(), offsetSurface::operator()(), and triangle< Point, PointRef >::triangleOverlap().

Here is the caller graph for this function:

◆ centre() [1/2]

Point centre	(	const Point &	p0,
		const Point &	p1,
		const Point &	p2
	)

inlinestatic

The centre (centroid) of three points.

Definition at line 115 of file triangleI.H.

References p0.

Referenced by momentOfInertia::massPropertiesShell(), polyMesh::pointInCell(), and wallBoundedStreamLine::pushIn().

Here is the caller graph for this function:

◆ areaNormal() [1/2]

Foam::vector areaNormal	(	const Point &	p0,
		const Point &	p1,
		const Point &	p2
	)

inlinestatic

The area normal for a triangle defined by three points (right-hand rule). Magnitude equal to area of the triangle.

Definition at line 140 of file triangleI.H.

References p0.

Referenced by boundBox::intersects(), tetrahedron< Point, PointRef >::nearestPoint(), polyMesh::pointInCell(), and wallBoundedParticle::trackToEdge().

Here is the caller graph for this function:

◆ unitNormal() [1/2]

Foam::vector unitNormal	(	const Point &	p0,
		const Point &	p1,
		const Point &	p2
	)

inlinestatic

The unit normal for a triangle defined by three points (right-hand rule).

Definition at line 165 of file triangleI.H.

References n, and p0.

Referenced by tetrahedron< Point, PointRef >::inside().

Here is the caller graph for this function:

◆ box() [1/2]

Foam::Pair< Point > box	(	const Point &	p0,
		const Point &	p1,
		const Point &	p2
	)

inlinestatic

The enclosing (bounding) box for three points.

Definition at line 192 of file triangleI.H.

References Foam::max(), Foam::min(), and p0.

Here is the call graph for this function:

◆ centre() [2/2]

Point centre ( ) const

inline

Return centre (centroid)

Definition at line 126 of file triangleI.H.

Referenced by triPoints::centre(), triFace::centre(), and face::centre().

Here is the caller graph for this function:

◆ areaNormal() [2/2]

Foam::vector areaNormal ( ) const

inline

The area normal - with magnitude equal to area of triangle.

Definition at line 151 of file triangleI.H.

Referenced by triPoints::areaNormal(), triFace::areaNormal(), face::areaNormal(), Foam::areaNormalFaceTriangle(), primitiveMeshGeometry::checkFaceTwist(), polyMeshGeometry::checkFaceTwist(), polyMeshGeometry::checkTriangleTwist(), triangle< Point, PointRef >::FOAM_DEPRECATED_FOR(), areaOp::operator()(), tetrahedron< Point, PointRef >::Sa(), tetrahedron< Point, PointRef >::Sb(), tetrahedron< Point, PointRef >::Sc(), and tetrahedron< Point, PointRef >::Sd().

Here is the caller graph for this function:

◆ unitNormal() [2/2]

Foam::vector unitNormal ( ) const

inline

Return unit normal.

Definition at line 178 of file triangleI.H.

Referenced by particle< Type >::patchData(), triPoints::unitNormal(), triFace::unitNormal(), and STLtriangle::write().

Here is the caller graph for this function:

◆ FOAM_DEPRECATED_FOR()

FOAM_DEPRECATED_FOR	(	2018-	12,
		"areaNormal() or unitNormal()"
	)		const

inline

Legacy name for areaNormal().

Deprecated:: (2018-06) Deprecated for new use

Definition at line 451 of file triangle.H.

References triangle< Point, PointRef >::areaNormal().

Here is the call graph for this function:

◆ mag()

Foam::scalar mag ( ) const

inline

The magnitude of the triangle area.

Definition at line 280 of file triangleI.H.

References Foam::mag().

Referenced by FreeStream< CloudType >::inflow(), momentOfInertia::massPropertiesShell(), and triangle< Point, PointRef >::sumAreaOp::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ box() [2/2]

Foam::Pair< Point > box ( ) const

inline

The enclosing (bounding) box for the triangle.

Definition at line 207 of file triangleI.H.

Referenced by triPoints::box(), and triFace::box().

Here is the caller graph for this function:

◆ vecA()

Point vecA ( ) const

inline

Edge vector opposite point a(): from b() to c()

Definition at line 220 of file triangleI.H.

Referenced by boundBox::intersects().

Here is the caller graph for this function:

◆ vecB()

Point vecB ( ) const

inline

Edge vector opposite point b(): from c() to a()

Definition at line 226 of file triangleI.H.

Referenced by boundBox::intersects().

Here is the caller graph for this function:

◆ vecC()

Point vecC ( ) const

inline

Edge vector opposite point c(): from a() to b()

Definition at line 232 of file triangleI.H.

Referenced by boundBox::intersects().

Here is the caller graph for this function:

◆ circumCentre()

Point circumCentre ( ) const

inline

Return circum-centre.

Definition at line 287 of file triangleI.H.

References Foam::constant::universal::c, Foam::constant::physicoChemical::c1, Foam::constant::physicoChemical::c2, and Foam::mag().

Referenced by Foam::edgeMeshTools::featureProximity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ circumRadius()

Foam::scalar circumRadius ( ) const

inline

Return circum-radius.

Definition at line 314 of file triangleI.H.

References Foam::clamp(), Foam::mag(), and Foam::sqrt().

Referenced by Foam::edgeMeshTools::featureProximity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ quality()

Foam::scalar quality ( ) const

inline

Return quality: Ratio of triangle and circum-circle.

area, scaled so that an equilateral triangle has a quality of 1

Definition at line 335 of file triangleI.H.

References Foam::constant::universal::c, Foam::mag(), Foam::sqr(), and Foam::sqrt().

Here is the call graph for this function:

◆ sweptVol()

Foam::scalar sweptVol ( const triangle< Point, PointRef > & t ) const

inline

Return swept-volume.

Definition at line 351 of file triangleI.H.

◆ inertia()

Foam::tensor inertia	(	PointRef	refPt = `Zero`,
		scalar	density = `1.0`
	)		const

inline

Return the inertia tensor, with optional reference.

point and density specification

Definition at line 370 of file triangleI.H.

References Foam::I, and Foam::mag().

Here is the call graph for this function:

◆ randomPoint()

Point randomPoint ( Random & rndGen ) const

inline

Return a random point on the triangle from a uniform distribution.

Definition at line 406 of file triangleI.H.

References Foam::barycentric2D01(), and rndGen.

Referenced by FreeStream< CloudType >::inflow(), and patchInjectionBase::setPositionAndCell().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ barycentricToPoint()

Point barycentricToPoint ( const barycentric2D & bary ) const

inline

Calculate the point from the given barycentric coordinates.

Definition at line 414 of file triangleI.H.

◆ pointToBarycentric() [1/2]

Foam::barycentric2D pointToBarycentric ( const point & pt ) const

inline

Calculate the barycentric coordinates from the given point.

Definition at line 424 of file triangleI.H.

Referenced by cellPointWeight::findTriangle(), offsetSurface::operator()(), and lumpedPointMovement::setInterpolator().

Here is the caller graph for this function:

◆ pointToBarycentric() [2/2]

Foam::scalar pointToBarycentric	(	const point &	pt,
		barycentric2D &	bary
	)		const

inline

Calculate the barycentric coordinates from the given point.

Returns the determinant.

Definition at line 436 of file triangleI.H.

References Foam::mag().

Here is the call graph for this function:

◆ intersects() [1/2]

bool intersects	(	const point &	origin,
		const vector &	normal
	)		const

inline

Fast intersection detection with a plane.

Definition at line 475 of file triangleI.H.

◆ intersects() [2/2]

bool intersects	(	const point &	origin,
		const vector::components	axis
	)		const

inline

Fast intersection detection with an axis plane.

Parameters

origin	Origin of the plane
axis	Normal of the plane (vector::X, vector::Y, vector::Z)

Definition at line 495 of file triangleI.H.

◆ ray()

Foam::pointHit ray	(	const point &	p,
		const vector &	q,
		const intersection::algorithm	alg = `intersection::FULL_RAY`,
		const intersection::direction	dir = `intersection::VECTOR`
	)		const

inline

Return point intersection with a ray.

For a hit, the distance is signed. Positive number represents the point in front of triangle. In case of miss pointHit is set to nearest point on triangle and its distance to the distance between the original point and the plane intersection point

Definition at line 515 of file triangleI.H.

References Foam::fieldTypes::area, intersection::CONTACT_SPHERE, intersection::FULL_RAY, intersection::HALF_RAY, PointHit< PointType >::hit(), PointHit< PointType >::hitPoint(), Foam::mag(), Foam::min(), n, p, intersection::planarTol(), PointHit< PointType >::point(), PointHit< PointType >::setDistance(), PointHit< PointType >::setMiss(), PointHit< PointType >::setPoint(), intersection::VECTOR, and intersection::VISIBLE.

Here is the call graph for this function:

◆ intersection()

Foam::pointHit intersection	(	const point &	p,
		const vector &	q,
		const intersection::algorithm	alg,
		const scalar	tol = `0.0`
	)		const

inline

Fast intersection with a ray.

For a hit, the pointHit.distance() is the line parameter t : intersection=p+t*q. Only defined for VISIBLE, FULL_RAY or HALF_RAY. tol increases the virtual size of the triangle by a relative factor.

Definition at line 630 of file triangleI.H.

References Foam::det(), intersection::FULL_RAY, intersection::HALF_RAY, intersection::VISIBLE, and Foam::Zero.

Referenced by mappedPatchBase::facePoint(), and triangleFuncs::intersectBb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nearestPointClassify()

Foam::pointHit nearestPointClassify	(	const point &	p,
		label &	nearType,
		label &	nearLabel
	)		const

Find the nearest point to p on the triangle and classify it:

+ near point (nearType=POINT, nearLabel=0, 1, 2) + near edge (nearType=EDGE, nearLabel=0, 1, 2) Note: edges are counted from starting vertex so e.g. edge 2 is from f[2] to f[0]

Definition at line 712 of file triangleI.H.

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

Referenced by triSurfaceTools::calcInterpolationWeights(), and face::nearestPointClassify().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nearestPoint() [1/2]

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

inline

Return nearest point to p on triangle.

Definition at line 861 of file triangleI.H.

References p.

Referenced by wallBoundedStreamLine::findNearestTet(), cellPointWeight::findTriangle(), and tetrahedron< Point, PointRef >::nearestPoint().

Here is the caller graph for this function:

◆ classify()

bool classify	(	const point &	p,
		label &	nearType,
		label &	nearLabel
	)		const

inline

Classify nearest point to p in triangle plane.

w.r.t. triangle edges and points. Returns inside (true)/outside (false).

Definition at line 875 of file triangleI.H.

References p.

◆ nearestPoint() [2/2]

Foam::pointHit nearestPoint	(	const linePointRef &	edge,
		pointHit &	edgePoint
	)		const

inline

Return nearest point to line on triangle. Returns hit if.

point is inside triangle. Sets edgePoint to point on edge (hit if nearest is inside line)

Definition at line 887 of file triangleI.H.

References PointHit< PointType >::distance(), intersection::FULL_RAY, PointHit< PointType >::hit(), PointHit< PointType >::hitPoint(), Foam::ln(), Foam::mag(), PointHit< PointType >::point(), PointHit< PointType >::setDistance(), PointHit< PointType >::setMiss(), and PointHit< PointType >::setPoint().

Here is the call graph for this function:

◆ sign()

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

inline

The sign for which side of the face plane the point is on.

Uses the supplied tolerance for rounding around zero.

Returns

0: on plane
+1: above plane
-1: below plane

Definition at line 1011 of file triangleI.H.

References p.

◆ sliceWithPlane()

void sliceWithPlane	(	const plane &	pln,
		AboveOp &	aboveOp,
		BelowOp &	belowOp
	)		const

inline

Decompose triangle into triangles above and below plane.

Definition at line 107 of file triangle.C.

◆ triangleOverlap()

void triangleOverlap	(	const vector &	n,
		const triangle< Point, PointRef > &	tri,
		InsideOp &	insideOp,
		OutsideOp &	outsideOp
	)		const

inline

Decompose triangle into triangles inside and outside.

(with respect to user provided normal) other triangle.

Definition at line 120 of file triangle.C.

References triangle< Point, PointRef >::a(), triangle< Point, PointRef >::b(), triangle< Point, PointRef >::c(), Foam::mag(), n, triangle< Point, PointRef >::storeOp::nTris_, s, and triangle< Point, PointRef >::storeOp::tris_.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator>>

Istream& operator>>	(	Istream &	,
		triangle< Point, PointRef > &
	)

friend

◆ operator

Ostream& operator	(	Ostream &	,
		const triangle< Point, PointRef > &
	)

friend

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

src/OpenFOAM/meshes/primitiveShapes/triangle/triangle.H
src/OpenFOAM/meshes/primitiveShapes/triangle/triangle.C
src/OpenFOAM/meshes/primitiveShapes/triangle/triangleI.H

Classes

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

template<class Point, class PointRef> class Foam::triangle< Point, PointRef >

Member Typedef Documentation

◆ point_type

◆ triIntersectionList

Member Enumeration Documentation

◆ proxType

Constructor & Destructor Documentation

◆ triangle() [1/4]

◆ triangle() [2/4]

◆ triangle() [3/4]

◆ triangle() [4/4]

Member Function Documentation

◆ a()

◆ b()

◆ c()

◆ centre() [1/2]

◆ areaNormal() [1/2]

◆ unitNormal() [1/2]

◆ box() [1/2]

◆ centre() [2/2]

◆ areaNormal() [2/2]

◆ unitNormal() [2/2]

◆ FOAM_DEPRECATED_FOR()

◆ mag()

◆ box() [2/2]

◆ vecA()

◆ vecB()

◆ vecC()

◆ circumCentre()

◆ circumRadius()

◆ quality()

◆ sweptVol()

◆ inertia()

◆ randomPoint()

◆ barycentricToPoint()

◆ pointToBarycentric() [1/2]

◆ pointToBarycentric() [2/2]

◆ intersects() [1/2]

◆ intersects() [2/2]

◆ ray()

◆ intersection()

◆ nearestPointClassify()

◆ nearestPoint() [1/2]

◆ classify()

◆ nearestPoint() [2/2]

◆ sign()

◆ sliceWithPlane()

◆ triangleOverlap()

Friends And Related Function Documentation

◆ operator>>

◆ operator

template<class Point, class PointRef>
class Foam::triangle< Point, PointRef >