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

#include <pointEdgePoint.H>

Inheritance diagram for pointEdgePoint:

[legend]

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

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

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 61 of file pointEdgePoint.H.

Constructor & Destructor Documentation

◆ pointEdgePoint() [1/2]

pointEdgePoint ( )

inline

Default construct. Max point.

Definition at line 116 of file pointEdgePointI.H.

References Foam::max().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pointEdgePoint() [2/2]

pointEdgePoint	(	const point &	origin,
		const scalar	distSqr )

inline

Construct from origin, distance.

Definition at line 123 of file pointEdgePointI.H.

References distSqr(), and origin().

Here is the call graph for this function:

Member Function Documentation

◆ origin() [1/2]

const point & origin ( ) const

inlinenoexcept

Definition at line 126 of file pointEdgePoint.H.

References Foam::noexcept.

Referenced by PointData< DataType >::PointData(), PointData< DataType >::PointData(), and pointEdgePoint().

Here is the caller graph for this function:

◆ origin() [2/2]

point & origin ( )

inlinenoexcept

Definition at line 128 of file pointEdgePoint.H.

References Foam::noexcept.

◆ distSqr() [1/2]

scalar distSqr ( ) const

inlinenoexcept

Definition at line 130 of file pointEdgePoint.H.

References Foam::noexcept.

Referenced by PointData< DataType >::PointData(), PointData< DataType >::PointData(), pointEdgePoint(), and sameGeometry().

Here is the caller graph for this function:

◆ distSqr() [2/2]

scalar & distSqr ( )

inlinenoexcept

Definition at line 132 of file pointEdgePoint.H.

References Foam::noexcept.

◆ operator==()

bool operator== ( const pointEdgePoint & rhs ) const

inline

Test for equality.

Definition at line 286 of file pointEdgePointI.H.

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

Referenced by PointData< DataType >::operator==().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator!=()

bool operator!= ( const pointEdgePoint & rhs ) const

inline

Test for inequality.

Definition at line 295 of file pointEdgePointI.H.

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

Here is the call graph for this function:

◆ valid()

template<class TrackingData>

bool valid ( TrackingData & td ) const

inline

Changed or contains original (invalid) value.

Definition at line 137 of file pointEdgePointI.H.

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

Here is the call graph for this function:

◆ sameGeometry()

template<class TrackingData>

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

inline

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

Definition at line 145 of file pointEdgePointI.H.

References Foam::diff(), distSqr(), Foam::mag(), pointEdgePoint(), 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 173 of file pointEdgePointI.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 199 of file pointEdgePointI.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 186 of file pointEdgePointI.H.

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

Referenced by PointData< DataType >::transform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updatePoint() [1/3]

template<class TrackingData>

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

inline

Influence of edge on point.

Definition at line 214 of file pointEdgePointI.H.

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

Referenced by PointData< DataType >::updatePoint(), PointData< DataType >::updatePoint(), and PointData< DataType >::updatePoint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updatePoint() [2/3]

template<class TrackingData>

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

inline

Influence of different value on same point.

Merge new and old info.

Definition at line 230 of file pointEdgePointI.H.

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

Here is the call graph for this function:

◆ updatePoint() [3/3]

template<class TrackingData>

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

inline

Influence of different value on same point.

No information about current position whatsoever.

Definition at line 245 of file pointEdgePointI.H.

References pointEdgePoint(), 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 pointEdgePoint &	pointInfo,
		const scalar	tol,
		TrackingData &	td )

inline

Influence of point on edge.

Definition at line 258 of file pointEdgePointI.H.

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

Referenced by PointData< DataType >::updateEdge().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ equal()

template<class TrackingData>

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

inline

Test for equality, with TrackingData.

Definition at line 274 of file pointEdgePointI.H.

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

Here is the call graph for this function:

◆ operator<<

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

friend

References pointEdgePoint().

◆ operator>>

Istream & operator>>	(	Istream &	,
		pointEdgePoint &	)

friend

References mesh, pointEdgePoint(), Foam::pos(), and td().

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

src/meshTools/algorithms/PointEdgeWave/pointEdgePoint.H
src/meshTools/algorithms/PointEdgeWave/pointEdgePointI.H

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ pointEdgePoint() [1/2]

◆ pointEdgePoint() [2/2]

Member Function Documentation

◆ origin() [1/2]

◆ origin() [2/2]

◆ distSqr() [1/2]

◆ distSqr() [2/2]

◆ operator==()

◆ operator!=()

◆ valid()

◆ sameGeometry()

◆ leaveDomain()

◆ enterDomain()

◆ transform()

◆ updatePoint() [1/3]

◆ updatePoint() [2/3]

◆ updatePoint() [3/3]

◆ updateEdge()

◆ equal()

Friends And Related Symbol Documentation

◆ operator<<

◆ operator>>