Holds information (coordinate and normal) regarding the nearest wall point. More...

#include <directionalWallPointData.H>

Inheritance diagram for directionalWallPointData< Type >:

Collaboration diagram for directionalWallPointData< Type >:

Public Types
typedef Type	dataType
Public Types inherited from wallPointData< Type >
typedef Type	dataType
	Type of additional data carried.

Public Member Functions
	directionalWallPointData ()
	Construct null.
	directionalWallPointData (const point &origin, const Type &data, const scalar distSqr)
	Construct from origin, normal, distance.
template<class TrackingData>
bool	updateCell (const polyMesh &mesh, const label thisCelli, const label neighbourFacei, const directionalWallPointData< Type > &neighbourWallInfo, const scalar tol, TrackingData &td)
	Influence of neighbouring face.
template<class TrackingData>
bool	updateFace (const polyMesh &mesh, const label thisFacei, const label neighbourCelli, const directionalWallPointData< Type > &neighbourWallInfo, const scalar tol, TrackingData &td)
	Influence of neighbouring cell.
template<class TrackingData>
bool	updateFace (const polyMesh &mesh, const label thisFacei, const directionalWallPointData< Type > &neighbourWallInfo, const scalar tol, TrackingData &td)
	Influence of different value on same face.
Public Member Functions inherited from wallPointData< Type >
	wallPointData ()
	Default construct.
	wallPointData (const point &origin, const Type &data, const scalar distSqr)
	Construct from origin, normal, distance.
const Type &	data () const
Type &	data ()
template<class TrackingData>
bool	updateCell (const polyMesh &mesh, const label thisCelli, const label neighbourFacei, const wallPointData< Type > &neighbourWallInfo, const scalar tol, TrackingData &td)
	Influence of neighbouring face.
template<class TrackingData>
bool	updateFace (const polyMesh &mesh, const label thisFacei, const label neighbourCelli, const wallPointData< Type > &neighbourWallInfo, const scalar tol, TrackingData &td)
	Influence of neighbouring cell.
template<class TrackingData>
bool	updateFace (const polyMesh &mesh, const label thisFacei, const wallPointData< Type > &neighbourWallInfo, const scalar tol, TrackingData &td)
	Influence of different value on same face.
Public Member Functions inherited from wallPoint
	wallPoint ()
	Default construct.
	wallPoint (const point &origin, const scalar distSqr)
	Construct from origin, distance-squared.
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.
template<class TrackingData>
bool	sameGeometry (const polyMesh &, const wallPoint &, 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 centre.
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 wallPoint &neighbourInfo, const scalar tol, TrackingData &td)
	Influence of neighbouring face.
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.
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.
template<class TrackingData>
	wallPoint (const polyMesh &, const scalar weight, const label face0, const wallPoint &info0, const label face1, const wallPoint &info1, const scalar tol, TrackingData &td)
	Interpolate different values.
template<class TrackingData>
bool	equal (const wallPoint &, TrackingData &td) const
	Test for equality, with TrackingData.
template<class TrackingData>
bool	interpolate (const polyMesh &, const point &pt, const label i0, const wallPoint &f0, const label i1, const wallPoint &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 wallPoint &) const
	Test for equality.
bool	operator!= (const wallPoint &) const
	Test for inequality.

Friends
Ostream &	operator<< (Ostream &os, const directionalWallPointData< Type > &wDist)
Istream &	operator>> (Istream &is, directionalWallPointData< Type > &wDist)

Detailed Description

template<class Type>
class Foam::directionalWallPointData< Type >

Holds information (coordinate and normal) regarding the nearest wall point.

Variant of wallPointData that ignores the specified normal component before comparing. This is used e.g. to find the distance to the wall in the z-direction only.

Source files

Definition at line 62 of file directionalWallPointData.H.

Member Typedef Documentation

◆ dataType

template<class Type>

typedef Type dataType

Definition at line 86 of file directionalWallPointData.H.

Constructor & Destructor Documentation

◆ directionalWallPointData() [1/2]

template<class Type>

directionalWallPointData ( )

inline

Construct null.

Definition at line 86 of file directionalWallPointDataI.H.

References wallPointData< Type >::wallPointData().

Referenced by operator<<, operator>>, updateCell(), updateFace(), and updateFace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ directionalWallPointData() [2/2]

template<class Type>

directionalWallPointData	(	const point &	origin,
		const Type &	data,
		const scalar	distSqr )

inline

Construct from origin, normal, distance.

Definition at line 94 of file directionalWallPointDataI.H.

References wallPointData< Type >::data(), wallPoint::distSqr(), wallPoint::origin(), and wallPointData< Type >::wallPointData().

Here is the call graph for this function:

Member Function Documentation

◆ updateCell()

template<class Type>

template<class TrackingData>

bool updateCell	(	const polyMesh &	mesh,
		const label	thisCelli,
		const label	neighbourFacei,
		const directionalWallPointData< Type > &	neighbourWallInfo,
		const scalar	tol,
		TrackingData &	td )

inline

Influence of neighbouring face.

Calls update(...) with cellCentre of celli

Definition at line 110 of file directionalWallPointDataI.H.

References directionalWallPointData(), mesh, td(), and update().

Here is the call graph for this function:

◆ updateFace() [1/2]

template<class Type>

template<class TrackingData>

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

inline

Influence of neighbouring cell.

Calls update(...) with faceCentre of facei

Definition at line 135 of file directionalWallPointDataI.H.

References directionalWallPointData(), mesh, td(), and update().

Here is the call graph for this function:

◆ updateFace() [2/2]

template<class Type>

template<class TrackingData>

bool updateFace	(	const polyMesh &	mesh,
		const label	thisFacei,
		const directionalWallPointData< Type > &	neighbourWallInfo,
		const scalar	tol,
		TrackingData &	td )

inline

Influence of different value on same face.

Merge new and old info. Calls update(...) with faceCentre of facei

Definition at line 160 of file directionalWallPointDataI.H.

References directionalWallPointData(), mesh, td(), and update().

Here is the call graph for this function:

◆ operator<<

template<class Type>

Ostream & operator<<	(	Ostream &	os,
		const directionalWallPointData< Type > &	wDist )

friend

Definition at line 32 of file directionalWallPointData.C.

References directionalWallPointData(), and os().

◆ operator>>

template<class Type>

Istream & operator>>	(	Istream &	is,
		directionalWallPointData< Type > &	wDist )

friend

Definition at line 43 of file directionalWallPointData.C.

References directionalWallPointData(), and wallPointData< Type >::wallPointData().

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

src/meshTools/cellDist/directionalWallPoint/directionalWallPointData.H
src/meshTools/cellDist/directionalWallPoint/directionalWallPointDataI.H

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ dataType

Constructor & Destructor Documentation

◆ directionalWallPointData() [1/2]

◆ directionalWallPointData() [2/2]

Member Function Documentation

◆ updateCell()

◆ updateFace() [1/2]

◆ updateFace() [2/2]

Friends And Related Symbol Documentation

◆ operator<<

◆ operator>>