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

Collaboration diagram for wallPoint:

Public Member Functions
	wallPoint ()
	Construct null. More...

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

	wallPoint (const wallPoint &)
	Construct as copy. More...

const point &	origin () const

point &	origin ()

scalar	distSqr () const

scalar &	distSqr ()

template<class TrackingData >
bool	valid (TrackingData &td) const
	Check whether origin has been changed at all or. More...

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

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. More...

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
	Same (like operator==) More...

bool	operator== (const wallPoint &) const

bool	operator!= (const wallPoint &) const

Private Member Functions
template<class TrackingData >
bool	update (const point &, const wallPoint &w2, const scalar tol, TrackingData &td)
	Evaluate distance to point. Update distSqr, origin from whomever. More...

Private Attributes
point	origin_
	Position of nearest wall center. More...

scalar	distSqr_
	Normal distance (squared) from cellcenter to origin. 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 63 of file wallPoint.H.

Constructor & Destructor Documentation

◆ wallPoint() [1/3]

wallPoint ( )

inline

Construct null.

Definition at line 85 of file wallPointI.H.

◆ wallPoint() [2/3]

wallPoint	(	const point &	origin,
		const scalar	distSqr
	)

inline

Construct from origin, distance.

Definition at line 92 of file wallPointI.H.

◆ wallPoint() [3/3]

wallPoint ( const wallPoint & wpt )

inline

Construct as copy.

Definition at line 99 of file wallPointI.H.

Member Function Documentation

◆ update()

bool update	(	const point &	pt,
		const wallPoint &	w2,
		const scalar	tol,
		TrackingData &	td
	)

inlineprivate

Evaluate distance to point. Update distSqr, origin from whomever.

is nearer pt. Return true if w2 is closer to point, false otherwise.

Definition at line 34 of file wallPointI.H.

References Foam::diff(), Foam::magSqr(), and wallPoint::origin().

Here is the call graph for this function:

◆ origin() [1/2]

Foam::point & origin ( ) const

inline

Definition at line 108 of file wallPointI.H.

Referenced by Foam::operator<<(), wallPoint::operator==(), Foam::operator>>(), and wallPoint::update().

Here is the caller graph for this function:

◆ origin() [2/2]

point& origin ( )

inline

◆ distSqr() [1/2]

Foam::scalar & distSqr ( ) const

inline

Definition at line 120 of file wallPointI.H.

Referenced by Foam::operator<<(), Foam::operator>>(), and wallPoint::sameGeometry().

Here is the caller graph for this function:

◆ distSqr() [2/2]

scalar& distSqr ( )

inline

◆ valid()

bool valid ( TrackingData & td ) const

inline

Check whether origin has been changed at all or.

still contains original (invalid) value.

Definition at line 133 of file wallPointI.H.

◆ sameGeometry()

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

inline

Check for identical geometrical data. Used for cyclics checking.

Definition at line 142 of file wallPointI.H.

References Foam::diff(), wallPoint::distSqr(), and Foam::mag().

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 171 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 199 of file wallPointI.H.

◆ transform()

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

inline

Apply rotation matrix to any coordinates.

Definition at line 185 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 215 of file wallPointI.H.

References primitiveMesh::cellCentres(), and mesh.

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 238 of file wallPointI.H.

References primitiveMesh::faceCentres(), and mesh.

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 260 of file wallPointI.H.

References primitiveMesh::faceCentres(), and mesh.

Here is the call graph for this function:

◆ equal()

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

inline

Same (like operator==)

Definition at line 281 of file wallPointI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const wallPoint & rhs ) const

inline

Definition at line 292 of file wallPointI.H.

References wallPoint::origin().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const wallPoint & rhs ) const

inline

Definition at line 298 of file wallPointI.H.

Friends And Related Function Documentation

◆ operator<<

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

friend

◆ operator>>

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

friend

Field Documentation

◆ origin_

point origin_

private

Position of nearest wall center.

Definition at line 68 of file wallPoint.H.

◆ distSqr_

scalar distSqr_

private

Normal distance (squared) from cellcenter to origin.

Definition at line 71 of file wallPoint.H.

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

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ wallPoint() [1/3]

◆ wallPoint() [2/3]

◆ wallPoint() [3/3]

Member Function Documentation

◆ update()

◆ 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>>

Field Documentation

◆ origin_

◆ distSqr_