surfaceLocation Class Reference

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

Inheritance diagram for surfaceLocation:

Collaboration diagram for surfaceLocation:

Public Member Functions
	surfaceLocation ()
	surfaceLocation (const pointIndexHit &pHit, const triPointRef::proxType elementType, const label triangle)
	surfaceLocation (Istream &is)
triPointRef::proxType &	elementType () noexcept
triPointRef::proxType	elementType () const noexcept
label &	triangle () noexcept
label	triangle () const noexcept
vector	normal (const triSurface &s) const
InfoProxy< surfaceLocation >	info () const
void	write (Ostream &os, const triSurface &s) const
Public Member Functions inherited from PointIndexHit
	PointIndexHit ()
	PointIndexHit (const point_type &p)
	PointIndexHit (const bool success, const point_type &p, const label index)
	PointIndexHit (Istream &is)
bool	hit () const noexcept
label	index () const noexcept
const point_type &	point () const noexcept
point_type &	point () noexcept
const point_type &	hitPoint () const
const point_type &	missPoint () const
const point_type &	rawPoint () const noexcept
point_type &	rawPoint () noexcept
void	setHit () noexcept
void	setMiss () noexcept
void	setPoint (const point_type &p)
void	setIndex (const label index) noexcept
void	hitPoint (const point_type &p, const label index)
void	write (Ostream &os)
bool	operator== (const PointIndexHit &rhs) const
bool	operator!= (const PointIndexHit &rhs) const

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

Additional Inherited Members
Public Types inherited from PointIndexHit
typedef PointType	point_type

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 67 of file surfaceLocation.H.

Constructor & Destructor Documentation

surfaceLocation() [1/3]

surfaceLocation ( )

inline

Definition at line 83 of file surfaceLocation.H.

surfaceLocation() [2/3]

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

inline

Definition at line 92 of file surfaceLocation.H.

surfaceLocation() [3/3]

surfaceLocation ( Istream &  is )

inlineexplicit

Definition at line 104 of file surfaceLocation.H.

Member Function Documentation

elementType() [1/2]

triPointRef::proxType& elementType ( )

inlinenoexcept

Definition at line 114 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

inlinenoexcept

Definition at line 119 of file surfaceLocation.H.

triangle() [1/2]

label& triangle ( )

inlinenoexcept

Definition at line 124 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

inlinenoexcept

Definition at line 129 of file surfaceLocation.H.

normal()

Foam::vector normal

(

const triSurface &

s

)

const

Definition at line 27 of file surfaceLocation.C.

References triangle::EDGE, PointIndexHit::index(), Foam::mag(), n, triangle::NONE, s, and Foam::Zero.

Here is the call graph for this function:

info()

InfoProxy<surfaceLocation> info ( ) const

inline

Definition at line 138 of file surfaceLocation.H.

write()

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

Definition at line 65 of file surfaceLocation.C.

References Foam::constant::electromagnetic::e, triangle::EDGE, triangle::NONE, os(), and s.

Here is the call graph for this function:

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 &  os, const InfoProxy< surfaceLocation > &  ip  )

friend

---

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

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