For use with FaceCellWave. Determines topological distance to starting faces. Templated on passive transported data. More...

#include <topoDistanceData.H>

Inheritance diagram for topoDistanceData< Type >:

[legend]

Public Member Functions
	topoDistanceData ()
	Construct null with invalid (-1) for distance, null constructor.
	topoDistanceData (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 polyMesh &, const topoDistanceData< Type > &, const scalar, TrackingData &td) const
	Check for identical geometrical data (eg, cyclics checking).
template<class TrackingData>
void	leaveDomain (const polyMesh &, const polyPatch &, const label patchFacei, const point &faceCentre, TrackingData &td)
	Convert any absolute coordinates into relative to (patch)face.
template<class TrackingData>
void	enterDomain (const polyMesh &, const polyPatch &, const label patchFacei, const point &faceCentre, TrackingData &td)
	Reverse of leaveDomain.
template<class TrackingData>
void	transform (const polyMesh &, const tensor &, TrackingData &td)
	Apply rotation matrix to any coordinates.
template<class TrackingData>
bool	updateCell (const polyMesh &, const label thisCelli, const label neighbourFacei, const topoDistanceData< Type > &neighbourInfo, const scalar tol, TrackingData &td)
	Influence of neighbouring face.
template<class TrackingData>
bool	updateFace (const polyMesh &, const label thisFacei, const label neighbourCelli, const topoDistanceData< Type > &neighbourInfo, const scalar tol, TrackingData &td)
	Influence of neighbouring cell.
template<class TrackingData>
bool	updateFace (const polyMesh &, const label thisFacei, const topoDistanceData< Type > &neighbourInfo, const scalar tol, TrackingData &td)
	Influence of different value on same face.
template<class TrackingData>
bool	equal (const topoDistanceData< Type > &, TrackingData &td) const
	Test for equality, with TrackingData.
template<class TrackingData>
bool	interpolate (const polyMesh &, const point &pt, const label i0, const topoDistanceData< Type > &f0, const label i1, const topoDistanceData< Type > &f1, const scalar weight, const scalar tol, TrackingData &td)
	Interpolate between two values (lerp). Returns true if causes changes. Not sure if needs to be specialised between face and cell and what index is needed...
bool	operator== (const topoDistanceData< Type > &) const
bool	operator!= (const topoDistanceData< Type > &) const

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

Detailed Description

template<class Type>
class Foam::topoDistanceData< Type >

For use with FaceCellWave. Determines topological distance to starting faces. Templated on passive transported data.

Source files

Definition at line 61 of file topoDistanceData.H.

Constructor & Destructor Documentation

◆ topoDistanceData() [1/2]

template<class Type>

topoDistanceData ( )

inline

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

for data

Definition at line 27 of file topoDistanceDataI.H.

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

Here is the caller graph for this function:

◆ topoDistanceData() [2/2]

template<class Type>

topoDistanceData	(	const label	distance,
		const Type &	data )

inline

Construct from components.

Definition at line 35 of file topoDistanceDataI.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 101 of file topoDistanceData.H.

Referenced by topoDistanceData().

Here is the caller graph for this function:

◆ data()

template<class Type>

const Type & data ( ) const

inline

Definition at line 106 of file topoDistanceData.H.

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

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

References td().

Referenced by interpolate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sameGeometry()

template<class Type>

template<class TrackingData>

bool sameGeometry	(	const polyMesh &	,
		const topoDistanceData< Type > &	,
		const scalar	,
		TrackingData &	td ) const

inline

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

Definition at line 59 of file topoDistanceDataI.H.

References topoDistanceData().

Here is the call graph for this function:

◆ leaveDomain()

template<class Type>

template<class TrackingData>

void leaveDomain	(	const polyMesh &	,
		const polyPatch &	patch,
		const label	patchFacei,
		const point &	faceCentre,
		TrackingData &	td )

inline

Convert any absolute coordinates into relative to (patch)face.

centre

Definition at line 74 of file topoDistanceDataI.H.

◆ enterDomain()

template<class Type>

template<class TrackingData>

void enterDomain	(	const polyMesh &	,
		const polyPatch &	patch,
		const label	patchFacei,
		const point &	faceCentre,
		TrackingData &	td )

inline

Reverse of leaveDomain.

Definition at line 100 of file topoDistanceDataI.H.

◆ transform()

template<class Type>

template<class TrackingData>

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

inline

Apply rotation matrix to any coordinates.

Definition at line 88 of file topoDistanceDataI.H.

◆ updateCell()

template<class Type>

template<class TrackingData>

bool updateCell	(	const polyMesh &	,
		const label	thisCelli,
		const label	neighbourFacei,
		const topoDistanceData< Type > &	neighbourInfo,
		const scalar	tol,
		TrackingData &	td )

inline

Influence of neighbouring face.

Definition at line 114 of file topoDistanceDataI.H.

◆ updateFace() [1/2]

template<class Type>

template<class TrackingData>

bool updateFace	(	const polyMesh &	mesh,
		const label	thisFacei,
		const label	neighbourCelli,
		const topoDistanceData< Type > &	neighbourInfo,
		const scalar	tol,
		TrackingData &	td )

inline

Influence of neighbouring cell.

Definition at line 137 of file topoDistanceDataI.H.

◆ updateFace() [2/2]

template<class Type>

template<class TrackingData>

bool updateFace	(	const polyMesh &	,
		const label	thisFacei,
		const topoDistanceData< Type > &	neighbourInfo,
		const scalar	tol,
		TrackingData &	td )

inline

Influence of different value on same face.

Definition at line 163 of file topoDistanceDataI.H.

◆ equal()

template<class Type>

template<class TrackingData>

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

inline

Test for equality, with TrackingData.

Definition at line 185 of file topoDistanceDataI.H.

References Foam::rhs(), td(), and topoDistanceData().

Here is the call graph for this function:

◆ interpolate()

template<class Type>

template<class TrackingData>

bool interpolate	(	const polyMesh &	,
		const point &	pt,
		const label	i0,
		const topoDistanceData< Type > &	f0,
		const label	i1,
		const topoDistanceData< Type > &	f1,
		const scalar	weight,
		const scalar	tol,
		TrackingData &	td )

inline

Interpolate between two values (lerp). Returns true if causes changes. Not sure if needs to be specialised between face and cell and what index is needed...

Definition at line 197 of file topoDistanceDataI.H.

References td(), topoDistanceData(), and valid().

Here is the call graph for this function:

◆ operator==()

template<class Type>

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

inline

Definition at line 230 of file topoDistanceDataI.H.

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

Here is the call graph for this function:

◆ operator!=()

template<class Type>

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

inline

Definition at line 240 of file topoDistanceDataI.H.

References Foam::rhs().

Here is the call graph for this function:

◆ operator<<

template<class Type>

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

friend

References topoDistanceData().

◆ operator>>

template<class Type>

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

friend

References topoDistanceData().

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

src/meshTools/meshStructure/topoDistanceData.H
src/meshTools/meshStructure/topoDistanceDataI.H

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ topoDistanceData() [1/2]

◆ topoDistanceData() [2/2]

Member Function Documentation

◆ distance()

◆ data()

◆ valid()

◆ sameGeometry()

◆ leaveDomain()

◆ enterDomain()

◆ transform()

◆ updateCell()

◆ updateFace() [1/2]

◆ updateFace() [2/2]

◆ equal()

◆ interpolate()

◆ operator==()

◆ operator!=()

Friends And Related Symbol Documentation

◆ operator<<

◆ operator>>