The OpenFOAM Foundation
triangle< Point, PointRef > Class Template Reference

A triangle primitive used to calculate face areas and swept volumes. More...

## Public Types

enum  proxType { NONE, POINT, EDGE }
Return types for classify. More...

## Public Member Functions

triangle (const Point &a, const Point &b, const Point &c)
Construct from three points. More...

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

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

const Point & a () const
Return first vertex. More...

const Point & b () const
Return second vertex. More...

const Point & c () const
Return third vertex. More...

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

vector area () const
Return vector area. More...

scalar mag () const
Return scalar magnitude. More...

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

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

scalar circumRadius () const

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=vector::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. 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...

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...

## Friends

Istreamoperator>> (Istream &, triangle &)

Ostreamoperator (Ostream &, const triangle &)

## Detailed Description

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

A triangle primitive used to calculate face areas and swept volumes.

Source files

Definition at line 57 of file triangle.H.

## ◆ proxType

 enum proxType

Return types for classify.

Enumerator
NONE
POINT
EDGE

Definition at line 89 of file triangle.H.

## ◆ triangle() [1/3]

 triangle ( const Point & a, const Point & b, const Point & c )
inline

Construct from three points.

Definition at line 34 of file triangleI.H.

## ◆ triangle() [2/3]

 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 48 of file triangleI.H.

## ◆ triangle() [3/3]

 triangle ( Istream & is )
inline

Construct from Istream.

Definition at line 61 of file triangleI.H.

## ◆ a()

 const Point & a ( ) const
inline

Return first vertex.

Definition at line 70 of file triangleI.H.

Referenced by triSurfaceTools::calcInterpolationWeights(), and OBJstream::write().

Here is the caller graph for this function:

## ◆ b()

 const Point & b ( ) const
inline

Return second vertex.

Definition at line 76 of file triangleI.H.

Referenced by triSurfaceTools::calcInterpolationWeights(), and OBJstream::write().

Here is the caller graph for this function:

## ◆ c()

 const Point & c ( ) const
inline

Return third vertex.

Definition at line 82 of file triangleI.H.

Referenced by triSurfaceTools::calcInterpolationWeights(), and OBJstream::write().

Here is the caller graph for this function:

## ◆ centre()

 Point centre ( ) const
inline

Return centre (centroid)

Definition at line 89 of file triangleI.H.

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

Here is the caller graph for this function:

## ◆ area()

 Foam::vector area ( ) const
inline

Return vector area.

Definition at line 96 of file triangleI.H.

Referenced by polyMesh::pointInCell().

Here is the caller graph for this function:

## ◆ mag()

 Foam::scalar mag ( ) const
inline

Return scalar magnitude.

Definition at line 103 of file triangleI.H.

References Foam::mag().

Referenced by FreeStream< CloudType >::inflow(), and momentOfInertia::massPropertiesShell().

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ normal()

 Foam::vector normal ( ) const
inline

Return unit normal.

Definition at line 110 of file triangleI.H.

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

Referenced by particle< Type >::normal().

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ circumCentre()

 Point circumCentre ( ) const
inline

Return circum-centre.

Definition at line 119 of file triangleI.H.

Here is the call graph for this function:

 Foam::scalar circumRadius ( ) const
inline

Definition at line 146 of file triangleI.H.

References Foam::mag(), Foam::max(), Foam::min(), and Foam::sqrt().

Here is the call 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 170 of file triangleI.H.

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 186 of file triangleI.H.

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

Referenced by triangle< Point, PointRef >::quality().

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ inertia()

 Foam::tensor inertia ( PointRef refPt = vector::zero, scalar density = 1.0 ) const
inline

Return the inertia tensor, with optional reference.

point and density specification

Definition at line 205 of file triangleI.H.

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

Referenced by triFace::inertia(), and triangle< Point, PointRef >::sweptVol().

Here is the call graph for this function:
Here is the caller 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 241 of file triangleI.H.

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 249 of file triangleI.H.

Referenced by triangle< Point, PointRef >::randomPoint().

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ pointToBarycentric() [1/2]

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

Calculate the barycentric coordinates from the given point.

Definition at line 259 of file triangleI.H.

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 271 of file triangleI.H.

References Foam::mag(), and triangle< Point, PointRef >::ray().

Here is the call graph for this function:

## ◆ 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 310 of file triangleI.H.

Referenced by triangle< Point, PointRef >::pointToBarycentric(), and triFace::ray().

Here is the call graph for this function:
Here is the caller 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 426 of file triangleI.H.

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 509 of file triangleI.H.

References cp, Foam::mag(), and triangle< Point, PointRef >::nearestPoint().

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 658 of file triangleI.H.

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

Here is the call graph for this function:
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 672 of file triangleI.H.

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

Referenced by triangle< Point, PointRef >::nearestPoint().

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ 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 684 of file triangleI.H.

Here is the call graph for this function:

## ◆ 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/triangleI.H