Holds information regarding nearest wall point. Used in wall distance calculation. More...

Inheritance diagram for wallPoint:

Public Member Functions
	wallPoint ()
	Default construct. More...

	wallPoint (const point &origin, const scalar distSqr)
	Construct from origin, distance-squared. More...

const point &	origin () const

point &	origin ()

scalar	distSqr () const

scalar &	distSqr ()

template<class TrackingData >
bool	valid (TrackingData &td) const
	Changed or contains original (invalid) value. More...

template<class TrackingData >
bool	sameGeometry (const polyMesh &, const wallPoint &, const scalar, TrackingData &td) const
	Check for identical geometrical data (eg, cyclics checking) More...

template<class TrackingData >
void	leaveDomain (const polyMesh &, const polyPatch &, const label patchFacei, const point &faceCentre, TrackingData &td)

template<class TrackingData >
void	enterDomain (const polyMesh &, const polyPatch &, const label patchFacei, const point &faceCentre, TrackingData &td)
	Reverse of leaveDomain. More...

template<class TrackingData >
void	transform (const polyMesh &, const tensor &, TrackingData &td)
	Apply rotation matrix to any coordinates. More...

template<class TrackingData >
bool	updateCell (const polyMesh &, const label thisCelli, const label neighbourFacei, const wallPoint &neighbourInfo, const scalar tol, TrackingData &td)
	Influence of neighbouring face. More...

template<class TrackingData >
bool	updateFace (const polyMesh &, const label thisFacei, const label neighbourCelli, const wallPoint &neighbourInfo, const scalar tol, TrackingData &td)
	Influence of neighbouring cell. More...

template<class TrackingData >
bool	updateFace (const polyMesh &, const label thisFacei, const wallPoint &neighbourInfo, const scalar tol, TrackingData &td)
	Influence of different value on same face. More...

template<class TrackingData >
bool	equal (const wallPoint &, TrackingData &td) const
	Test for equality, with TrackingData. More...

bool	operator== (const wallPoint &) const
	Test for equality. More...

bool	operator!= (const wallPoint &) const
	Test for inequality. More...

Friends
Ostream &	operator<< (Ostream &, const wallPoint &)

Istream &	operator>> (Istream &, wallPoint &)

Detailed Description

Holds information regarding nearest wall point. Used in wall distance calculation.

Source files

Definition at line 65 of file wallPoint.H.

Constructor & Destructor Documentation

◆ wallPoint() [1/2]

wallPoint ( )

inline

Default construct.

Definition at line 88 of file wallPointI.H.

◆ wallPoint() [2/2]

wallPoint	(	const point &	origin,
		const scalar	distSqr
	)

inline

Construct from origin, distance-squared.

Definition at line 95 of file wallPointI.H.

Member Function Documentation

◆ origin() [1/2]

const point & origin ( ) const

inline

Definition at line 106 of file wallPoint.H.

◆ origin() [2/2]

point & origin ( )

inline

Definition at line 110 of file wallPoint.H.

◆ distSqr() [1/2]

scalar distSqr ( ) const

inline

Definition at line 115 of file wallPoint.H.

◆ distSqr() [2/2]

scalar & distSqr ( )

inline

Definition at line 119 of file wallPoint.H.

◆ valid()

bool valid ( TrackingData & td ) const

inline

Changed or contains original (invalid) value.

Definition at line 105 of file wallPointI.H.

◆ sameGeometry()

bool sameGeometry	(	const polyMesh &	,
		const wallPoint &	w2,
		const scalar	tol,
		TrackingData &	td
	)		const

inline

Check for identical geometrical data (eg, cyclics checking)

Definition at line 113 of file wallPointI.H.

References Foam::diff(), Foam::mag(), and w2.

Here is the call graph for this function:

◆ leaveDomain()

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

inline

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

Definition at line 142 of file wallPointI.H.

◆ enterDomain()

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

inline

Reverse of leaveDomain.

Definition at line 170 of file wallPointI.H.

◆ transform()

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

inline

Apply rotation matrix to any coordinates.

Definition at line 156 of file wallPointI.H.

References Foam::transform().

Here is the call graph for this function:

◆ updateCell()

bool updateCell	(	const polyMesh &	mesh,
		const label	thisCelli,
		const label	neighbourFacei,
		const wallPoint &	neighbourInfo,
		const scalar	tol,
		TrackingData &	td
	)

inline

Influence of neighbouring face.

Definition at line 186 of file wallPointI.H.

References primitiveMesh::cellCentres(), mesh, and update().

Here is the call graph for this function:

◆ updateFace() [1/2]

bool updateFace	(	const polyMesh &	mesh,
		const label	thisFacei,
		const label	neighbourCelli,
		const wallPoint &	neighbourInfo,
		const scalar	tol,
		TrackingData &	td
	)

inline

Influence of neighbouring cell.

Definition at line 209 of file wallPointI.H.

References primitiveMesh::faceCentres(), mesh, and update().

Here is the call graph for this function:

◆ updateFace() [2/2]

bool updateFace	(	const polyMesh &	mesh,
		const label	thisFacei,
		const wallPoint &	neighbourInfo,
		const scalar	tol,
		TrackingData &	td
	)

inline

Influence of different value on same face.

Definition at line 232 of file wallPointI.H.

References primitiveMesh::faceCentres(), mesh, and update().

Here is the call graph for this function:

◆ equal()

bool equal	(	const wallPoint &	rhs,
		TrackingData &	td
	)		const

inline

Test for equality, with TrackingData.

Definition at line 253 of file wallPointI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const wallPoint & rhs ) const

inline

Test for equality.

Definition at line 265 of file wallPointI.H.

◆ operator!=()

bool operator!= ( const wallPoint & rhs ) const

inline

Test for inequality.

Definition at line 274 of file wallPointI.H.

Friends And Related Function Documentation

◆ operator<<

Ostream & operator<<	(	Ostream &	,
		const wallPoint &
	)

friend

◆ operator>>

Istream & operator>>	(	Istream &	,
		wallPoint &
	)

friend

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

src/meshTools/cellDist/wallPoint/wallPoint.H
src/meshTools/cellDist/wallPoint/wallPointI.H

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ wallPoint() [1/2]

◆ wallPoint() [2/2]

Member Function Documentation

◆ origin() [1/2]

◆ origin() [2/2]

◆ distSqr() [1/2]

◆ distSqr() [2/2]

◆ valid()

◆ sameGeometry()

◆ leaveDomain()

◆ enterDomain()

◆ transform()

◆ updateCell()

◆ updateFace() [1/2]

◆ updateFace() [2/2]

◆ equal()

◆ operator==()

◆ operator!=()

Friends And Related Function Documentation

◆ operator<<

◆ operator>>