surfaceLocation Class Reference

Contains information about location on a triSurface. More...

Inheritance diagram for surfaceLocation:

Collaboration diagram for surfaceLocation:

Public Member Functions
	surfaceLocation ()
	Construct null. More...
	surfaceLocation (const pointIndexHit &pih, const triPointRef::proxType elementType, const label triangle)
	Construct from components. More...
	surfaceLocation (Istream &is)
	Construct from Istream. More...
triPointRef::proxType &	elementType ()
triPointRef::proxType	elementType () const
label &	triangle ()
label	triangle () const
vector	normal (const triSurface &s) const
	Normal. Approximate for points. More...
InfoProxy< surfaceLocation >	info () const
	Return info proxy. More...
void	write (Ostream &os, const triSurface &s) const
	Write info to os. More...
Public Member Functions inherited from PointIndexHit< Point >
	PointIndexHit (const bool success, const Point &p, const label index)
	Construct from components. More...
	PointIndexHit (const Point &p)
	Construct from point. Hit and distance set later. More...
	PointIndexHit ()
	Construct null. More...
	PointIndexHit (Istream &is)
	Construct from Istream. More...
bool	hit () const
	Is there a hit. More...
label	index () const
	Return index. More...
const Point &	hitPoint () const
	Return hit point. More...
const Point &	missPoint () const
	Return miss point. More...
const Point &	rawPoint () const
	Return point with no checking. More...
Point &	rawPoint ()
void	setHit ()
void	setMiss ()
void	setPoint (const Point &p)
void	setIndex (const label index)
bool	operator== (const PointIndexHit &rhs) const
bool	operator!= (const PointIndexHit &rhs) const
void	write (Ostream &os)

Friends
Istream &	operator>> (Istream &is, surfaceLocation &sl)
Ostream &	operator<< (Ostream &os, const surfaceLocation &sl)
Ostream &	operator<< (Ostream &, const InfoProxy< surfaceLocation > &)

Detailed Description

Contains information about location on a triSurface.

Access to data:

• pointIndexHit provides
  • location
  • bool: hit/miss
  • index (of triangle/point/edge)
• elementType() provides
  • what index above relates to. In triangle::proxType
• triangle() provides
  • last known triangle

Source files

• surfaceLocation.H
• surfaceLocation.C

Definition at line 75 of file surfaceLocation.H.

Constructor & Destructor Documentation

surfaceLocation() [1/3]

surfaceLocation ( )

inline

Construct null.

Definition at line 91 of file surfaceLocation.H.

surfaceLocation() [2/3]

surfaceLocation ( const pointIndexHit &  pih, const triPointRef::proxType  elementType, const label  triangle  )

inline

Construct from components.

Definition at line 100 of file surfaceLocation.H.

surfaceLocation() [3/3]

surfaceLocation ( Istream &  is )

inline

Construct from Istream.

Definition at line 112 of file surfaceLocation.H.

Member Function Documentation

elementType() [1/2]

triPointRef::proxType& elementType ( )

inline

Definition at line 122 of file surfaceLocation.H.

Referenced by triSurfaceTools::classify(), Foam::operator<<(), and triSurfaceTools::trackToEdge().

Here is the caller graph for this function:

elementType() [2/2]

triPointRef::proxType elementType ( ) const

inline

Definition at line 127 of file surfaceLocation.H.

triangle() [1/2]

label& triangle ( )

inline

Definition at line 132 of file surfaceLocation.H.

Referenced by Foam::operator<<(), triSurfaceTools::track(), and triSurfaceTools::trackToEdge().

Here is the caller graph for this function:

triangle() [2/2]

label triangle ( ) const

inline

Definition at line 137 of file surfaceLocation.H.

normal()

Foam::vector normal

(

const triSurface &

s

)

const

Normal. Approximate for points.

Definition at line 33 of file surfaceLocation.C.

References triangle< Point, PointRef >::EDGE, forAll, PointIndexHit< Point >::index(), Foam::mag(), n, triangle< Point, PointRef >::NONE, s, and Foam::Zero.

Here is the call graph for this function:

info()

InfoProxy<surfaceLocation> info ( ) const

inline

Return info proxy.

Used to print token information to a stream

Definition at line 147 of file surfaceLocation.H.

write()

void write	(	Ostream &	os,
		const triSurface &	s
	)		const

Write info to os.

Definition at line 69 of file surfaceLocation.C.

References Foam::constant::electromagnetic::e, triangle< Point, PointRef >::EDGE, triangle< Point, PointRef >::NONE, and s.

Friends And Related Function Documentation

operator>>

Istream& operator>> ( Istream &  is, surfaceLocation &  sl  )

friend

operator<< [1/2]

Ostream& operator<< ( Ostream &  os, const surfaceLocation &  sl  )

friend

operator<< [2/2]

Ostream& operator<< ( Ostream &  , const InfoProxy< surfaceLocation > &    )

friend

---

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

• src/meshTools/triSurface/surfaceLocation/surfaceLocation.H
• src/meshTools/triSurface/surfaceLocation/surfaceLocation.C