For use with PointEdgeWave. Determines topological distance to starting points. Templated on passive transported data. More...

#include <pointTopoDistanceData.H>

Public Types
typedef Type	dataType

Public Member Functions
	pointTopoDistanceData ()
	Construct null with invalid (-1) for distance, null constructor.
	pointTopoDistanceData (const label distance, const Type &data)
	Construct from components.
label	distance () const
const Type &	data () const
template<class TrackingData>
bool	valid (TrackingData &td) const
	Changed or contains original (invalid) value.
template<class TrackingData>
bool	sameGeometry (const pointTopoDistanceData< Type > &, const scalar tol, TrackingData &td) const
	Check for identical geometrical data (eg, cyclics checking).
template<class TrackingData>
void	leaveDomain (const polyPatch &patch, const label patchPointi, const point &pos, TrackingData &td)
	Convert origin to relative vector to leaving point.
template<class TrackingData>
void	enterDomain (const polyPatch &patch, const label patchPointi, const point &pos, TrackingData &td)
	Convert relative origin to absolute by adding entering point.
template<class TrackingData>
void	transform (const tensor &rotTensor, TrackingData &td)
	Apply rotation matrix to origin.
template<class TrackingData>
bool	updatePoint (const polyMesh &mesh, const label pointi, const label edgeI, const pointTopoDistanceData< Type > &edgeInfo, const scalar tol, TrackingData &td)
	Influence of edge on point.
template<class TrackingData>
bool	updatePoint (const polyMesh &mesh, const label pointi, const pointTopoDistanceData< Type > &newPointInfo, const scalar tol, TrackingData &td)
	Influence of different value on same point.
template<class TrackingData>
bool	updatePoint (const pointTopoDistanceData< Type > &newPointInfo, const scalar tol, TrackingData &td)
	Influence of different value on same point.
template<class TrackingData>
bool	updateEdge (const polyMesh &mesh, const label edgeI, const label pointi, const pointTopoDistanceData< Type > &pointInfo, const scalar tol, TrackingData &td)
	Influence of point on edge.
template<class TrackingData>
bool	equal (const pointTopoDistanceData< Type > &, TrackingData &) const
	Test for equality, with TrackingData.
bool	operator== (const pointTopoDistanceData< Type > &) const
bool	operator!= (const pointTopoDistanceData< Type > &) const

Friends
Ostream &	operator<< (Ostream &, const pointTopoDistanceData< Type > &)
Istream &	operator>> (Istream &, pointTopoDistanceData< Type > &)

Detailed Description

template<class Type>
class Foam::pointTopoDistanceData< Type >

For use with PointEdgeWave. Determines topological distance to starting points. Templated on passive transported data.

Source files

Definition at line 60 of file pointTopoDistanceData.H.

Member Typedef Documentation

◆ dataType

template<class Type>

typedef Type dataType

Definition at line 78 of file pointTopoDistanceData.H.

Constructor & Destructor Documentation

◆ pointTopoDistanceData() [1/2]

template<class Type>

pointTopoDistanceData ( )

inline

Construct null with invalid (-1) for distance, null constructor.

for data

Definition at line 27 of file pointTopoDistanceDataI.H.

Referenced by equal(), operator<<, operator>>, sameGeometry(), updateEdge(), updatePoint(), updatePoint(), and updatePoint().

Here is the caller graph for this function:

◆ pointTopoDistanceData() [2/2]

template<class Type>

pointTopoDistanceData	(	const label	distance,
		const Type &	data )

inline

Construct from components.

Definition at line 35 of file pointTopoDistanceDataI.H.

References data(), and distance().

Here is the call graph for this function:

Member Function Documentation

◆ distance()

template<class Type>

label distance ( ) const

inline

Definition at line 104 of file pointTopoDistanceData.H.

Referenced by pointTopoDistanceData().

Here is the caller graph for this function:

◆ data()

template<class Type>

const Type & data ( ) const

inline

Definition at line 109 of file pointTopoDistanceData.H.

Referenced by operator==(), and pointTopoDistanceData().

Here is the caller graph for this function:

◆ valid()

template<class Type>

template<class TrackingData>

bool valid ( TrackingData & td ) const

inline

Changed or contains original (invalid) value.

Definition at line 50 of file pointTopoDistanceDataI.H.

References td().

Here is the call graph for this function:

◆ sameGeometry()

template<class Type>

template<class TrackingData>

bool sameGeometry	(	const pointTopoDistanceData< Type > &	,
		const scalar	tol,
		TrackingData &	td ) const

inline

Check for identical geometrical data (eg, cyclics checking).

Definition at line 59 of file pointTopoDistanceDataI.H.

References pointTopoDistanceData(), and td().

Here is the call graph for this function:

◆ leaveDomain()

template<class Type>

template<class TrackingData>

void leaveDomain	(	const polyPatch &	patch,
		const label	patchPointi,
		const point &	pos,
		TrackingData &	td )

inline

Convert origin to relative vector to leaving point.

(= point coordinate)

Definition at line 73 of file pointTopoDistanceDataI.H.

References td().

Here is the call graph for this function:

◆ enterDomain()

template<class Type>

template<class TrackingData>

void enterDomain	(	const polyPatch &	patch,
		const label	patchPointi,
		const point &	pos,
		TrackingData &	td )

inline

Convert relative origin to absolute by adding entering point.

Definition at line 97 of file pointTopoDistanceDataI.H.

References td().

Here is the call graph for this function:

◆ transform()

template<class Type>

template<class TrackingData>

void transform	(	const tensor &	rotTensor,
		TrackingData &	td )

inline

Apply rotation matrix to origin.

Definition at line 86 of file pointTopoDistanceDataI.H.

References td().

Here is the call graph for this function:

◆ updatePoint() [1/3]

template<class Type>

template<class TrackingData>

bool updatePoint	(	const polyMesh &	mesh,
		const label	pointi,
		const label	edgeI,
		const pointTopoDistanceData< Type > &	edgeInfo,
		const scalar	tol,
		TrackingData &	td )

inline

Influence of edge on point.

Definition at line 110 of file pointTopoDistanceDataI.H.

References mesh, pointTopoDistanceData(), and td().

Here is the call graph for this function:

◆ updatePoint() [2/3]

template<class Type>

template<class TrackingData>

bool updatePoint	(	const polyMesh &	mesh,
		const label	pointi,
		const pointTopoDistanceData< Type > &	newPointInfo,
		const scalar	tol,
		TrackingData &	td )

inline

Influence of different value on same point.

Merge new and old info.

Definition at line 134 of file pointTopoDistanceDataI.H.

References mesh, pointTopoDistanceData(), and td().

Here is the call graph for this function:

◆ updatePoint() [3/3]

template<class Type>

template<class TrackingData>

bool updatePoint	(	const pointTopoDistanceData< Type > &	newPointInfo,
		const scalar	tol,
		TrackingData &	td )

inline

Influence of different value on same point.

No information about current position whatsoever.

Definition at line 157 of file pointTopoDistanceDataI.H.

References pointTopoDistanceData(), and td().

Here is the call graph for this function:

◆ updateEdge()

template<class Type>

template<class TrackingData>

bool updateEdge	(	const polyMesh &	mesh,
		const label	edgeI,
		const label	pointi,
		const pointTopoDistanceData< Type > &	pointInfo,
		const scalar	tol,
		TrackingData &	td )

inline

Influence of point on edge.

Definition at line 178 of file pointTopoDistanceDataI.H.

References mesh, pointTopoDistanceData(), and td().

Here is the call graph for this function:

◆ equal()

template<class Type>

template<class TrackingData>

bool equal	(	const pointTopoDistanceData< Type > &	rhs,
		TrackingData &	td ) const

inline

Test for equality, with TrackingData.

Definition at line 201 of file pointTopoDistanceDataI.H.

References Foam::operator==(), pointTopoDistanceData(), Foam::rhs(), and td().

Here is the call graph for this function:

◆ operator==()

template<class Type>

bool operator== ( const pointTopoDistanceData< Type > & rhs ) const

inline

Definition at line 214 of file pointTopoDistanceDataI.H.

References data(), Foam::distance(), and Foam::rhs().

Here is the call graph for this function:

◆ operator!=()

template<class Type>

bool operator!= ( const pointTopoDistanceData< Type > & rhs ) const

inline

Definition at line 224 of file pointTopoDistanceDataI.H.

References Foam::rhs().

Here is the call graph for this function:

◆ operator<<

template<class Type>

Ostream & operator<<	(	Ostream &	,
		const pointTopoDistanceData< Type > &	)

friend

References pointTopoDistanceData().

◆ operator>>

template<class Type>

Istream & operator>>	(	Istream &	,
		pointTopoDistanceData< Type > &	)

friend

References pointTopoDistanceData().

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

src/meshTools/meshStructure/pointTopoDistanceData.H
src/meshTools/meshStructure/pointTopoDistanceDataI.H

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ dataType

Constructor & Destructor Documentation

◆ pointTopoDistanceData() [1/2]

◆ pointTopoDistanceData() [2/2]

Member Function Documentation

◆ distance()

◆ data()

◆ valid()

◆ sameGeometry()

◆ leaveDomain()

◆ enterDomain()

◆ transform()

◆ updatePoint() [1/3]

◆ updatePoint() [2/3]

◆ updatePoint() [3/3]

◆ updateEdge()

◆ equal()

◆ operator==()

◆ operator!=()

Friends And Related Symbol Documentation

◆ operator<<

◆ operator>>