Holds information regarding nearest wall point. Used in PointEdgeWave. (so not standard FaceCellWave) To be used in wall distance calculation. More...

#include <externalPointEdgePoint.H>

Classes
class	trackingData
	Class used to pass data into container. More...

Public Member Functions
	externalPointEdgePoint ()
	Default construct.
	externalPointEdgePoint (const point &, const scalar)
	Construct from origin, distance.
const point &	origin () const
scalar	distSqr () const
template<class TrackingData>
bool	valid (TrackingData &td) const
	Changed or contains original (invalid) value.
template<class TrackingData>
bool	sameGeometry (const externalPointEdgePoint &, 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 (= point coordinate).
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 externalPointEdgePoint &edgeInfo, const scalar tol, TrackingData &td)
	Influence of edge on point.
template<class TrackingData>
bool	updatePoint (const polyMesh &mesh, const label pointi, const externalPointEdgePoint &newPointInfo, const scalar tol, TrackingData &td)
	Influence of different value on same point.
template<class TrackingData>
bool	updatePoint (const externalPointEdgePoint &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 externalPointEdgePoint &pointInfo, const scalar tol, TrackingData &td)
	Influence of point on edge.
template<class TrackingData>
bool	equal (const externalPointEdgePoint &, TrackingData &td) const
	Test for equality, with TrackingData.
bool	operator== (const externalPointEdgePoint &) const
	Test for equality.
bool	operator!= (const externalPointEdgePoint &) const
	Test for inequality.

Friends
Ostream &	operator<< (Ostream &, const externalPointEdgePoint &)
Istream &	operator>> (Istream &, externalPointEdgePoint &)

Detailed Description

Holds information regarding nearest wall point. Used in PointEdgeWave. (so not standard FaceCellWave) To be used in wall distance calculation.

Source files

Definition at line 58 of file externalPointEdgePoint.H.

Constructor & Destructor Documentation

◆ externalPointEdgePoint() [1/2]

externalPointEdgePoint ( )

inline

Default construct.

Definition at line 114 of file externalPointEdgePointI.H.

References Foam::max().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ externalPointEdgePoint() [2/2]

externalPointEdgePoint	(	const point &	origin,
		const scalar	distSqr )

inline

Construct from origin, distance.

Definition at line 121 of file externalPointEdgePointI.H.

References distSqr(), and origin().

Here is the call graph for this function:

Member Function Documentation

◆ origin()

const point & origin ( ) const

inline

Definition at line 139 of file externalPointEdgePoint.H.

Referenced by externalPointEdgePoint().

Here is the caller graph for this function:

◆ distSqr()

scalar distSqr ( ) const

inline

Definition at line 144 of file externalPointEdgePoint.H.

Referenced by externalPointEdgePoint(), and sameGeometry().

Here is the caller graph for this function:

◆ valid()

template<class TrackingData>

bool valid ( TrackingData & td ) const

inline

Changed or contains original (invalid) value.

Definition at line 135 of file externalPointEdgePointI.H.

References VectorSpace< Form, Cmpt, Ncmpts >::max, and td().

Here is the call graph for this function:

◆ sameGeometry()

template<class TrackingData>

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

inline

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

Definition at line 143 of file externalPointEdgePointI.H.

References Foam::diff(), distSqr(), externalPointEdgePoint(), Foam::mag(), td(), and w2.

Here is the call graph for this function:

◆ leaveDomain()

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

References td().

Here is the call graph for this function:

◆ enterDomain()

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 195 of file externalPointEdgePointI.H.

References td().

Here is the call graph for this function:

◆ transform()

template<class TrackingData>

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

inline

Apply rotation matrix to origin.

Definition at line 184 of file externalPointEdgePointI.H.

References td(), and Foam::transform().

Here is the call graph for this function:

◆ updatePoint() [1/3]

template<class TrackingData>

bool updatePoint	(	const polyMesh &	mesh,
		const label	pointi,
		const label	edgeI,
		const externalPointEdgePoint &	edgeInfo,
		const scalar	tol,
		TrackingData &	td )

inline

Influence of edge on point.

Definition at line 209 of file externalPointEdgePointI.H.

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

Here is the call graph for this function:

◆ updatePoint() [2/3]

template<class TrackingData>

bool updatePoint	(	const polyMesh &	mesh,
		const label	pointi,
		const externalPointEdgePoint &	newPointInfo,
		const scalar	tol,
		TrackingData &	td )

inline

Influence of different value on same point.

Merge new and old info.

Definition at line 224 of file externalPointEdgePointI.H.

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

Here is the call graph for this function:

◆ updatePoint() [3/3]

template<class TrackingData>

bool updatePoint	(	const externalPointEdgePoint &	newPointInfo,
		const scalar	tol,
		TrackingData &	td )

inline

Influence of different value on same point.

No information about current position whatsoever.

Definition at line 238 of file externalPointEdgePointI.H.

References externalPointEdgePoint(), td(), and update().

Here is the call graph for this function:

◆ updateEdge()

template<class TrackingData>

bool updateEdge	(	const polyMesh &	mesh,
		const label	edgeI,
		const label	pointi,
		const externalPointEdgePoint &	pointInfo,
		const scalar	tol,
		TrackingData &	td )

inline

Influence of point on edge.

Definition at line 250 of file externalPointEdgePointI.H.

References e, externalPointEdgePoint(), mesh, td(), and update().

Here is the call graph for this function:

◆ equal()

template<class TrackingData>

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

inline

Test for equality, with TrackingData.

Definition at line 266 of file externalPointEdgePointI.H.

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

Here is the call graph for this function:

◆ operator==()

bool operator== ( const externalPointEdgePoint & rhs ) const

inline

Test for equality.

Definition at line 278 of file externalPointEdgePointI.H.

References externalPointEdgePoint(), and Foam::rhs().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const externalPointEdgePoint & rhs ) const

inline

Test for inequality.

Definition at line 287 of file externalPointEdgePointI.H.

References externalPointEdgePoint(), and Foam::rhs().

Here is the call graph for this function:

◆ operator<<

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

friend

References externalPointEdgePoint().

◆ operator>>

Istream & operator>>	(	Istream &	,
		externalPointEdgePoint &	)

friend

References externalPointEdgePoint().

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

src/dynamicMesh/pointPatchDist/externalPointEdgePoint.H
src/dynamicMesh/pointPatchDist/externalPointEdgePointI.H

Classes

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ externalPointEdgePoint() [1/2]

◆ externalPointEdgePoint() [2/2]

Member Function Documentation

◆ origin()

◆ distSqr()

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