Determines length of string of edges walked to point. More...

#include <pointEdgeStructuredWalk.H>

Public Member Functions
	pointEdgeStructuredWalk ()
	Default construct.
	pointEdgeStructuredWalk (const point &point0, const point &previousPoint, const scalar dist, const vector &data, const label index=-1)
	Construct from components.
scalar	dist () const
	The distance information.
const vector &	data () const
	Tracking data.
label	index () const
	Index (if any) associated with data.
bool	inZone () const
	True if starting point is valid (ie, not point::max).
template<class TrackingData>
bool	valid (TrackingData &td) const
	Changed or contains original (invalid) value.
template<class TrackingData>
bool	sameGeometry (const pointEdgeStructuredWalk &, 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 pointEdgeStructuredWalk &edgeInfo, const scalar tol, TrackingData &td)
	Influence of edge on point.
template<class TrackingData>
bool	updatePoint (const polyMesh &mesh, const label pointi, const pointEdgeStructuredWalk &newPointInfo, const scalar tol, TrackingData &td)
	Influence of different value on same point.
template<class TrackingData>
bool	updatePoint (const pointEdgeStructuredWalk &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 pointEdgeStructuredWalk &pointInfo, const scalar tol, TrackingData &td)
	Influence of point on edge.
template<class TrackingData>
bool	equal (const pointEdgeStructuredWalk &, TrackingData &) const
	Test for equality, with TrackingData.
bool	operator== (const pointEdgeStructuredWalk &) const
	Test for equality.
bool	operator!= (const pointEdgeStructuredWalk &) const
	Test for inequality.

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

Detailed Description

Determines length of string of edges walked to point.

Source files

Definition at line 57 of file pointEdgeStructuredWalk.H.

Constructor & Destructor Documentation

◆ pointEdgeStructuredWalk() [1/2]

pointEdgeStructuredWalk ( )

inline

Default construct.

Definition at line 52 of file pointEdgeStructuredWalkI.H.

References Foam::max(), and Foam::Zero.

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:

◆ pointEdgeStructuredWalk() [2/2]

pointEdgeStructuredWalk	(	const point &	point0,
		const point &	previousPoint,
		const scalar	dist,
		const vector &	data,
		const label	index = -1 )

inline

Construct from components.

Definition at line 62 of file pointEdgeStructuredWalkI.H.

References data(), dist(), and index().

Here is the call graph for this function:

Member Function Documentation

◆ dist()

scalar dist ( ) const

inline

The distance information.

Definition at line 129 of file pointEdgeStructuredWalk.H.

Referenced by pointEdgeStructuredWalk(), and sameGeometry().

Here is the caller graph for this function:

◆ data()

const vector & data ( ) const

inline

Tracking data.

Definition at line 137 of file pointEdgeStructuredWalk.H.

Referenced by pointEdgeStructuredWalk().

Here is the caller graph for this function:

◆ index()

label index ( ) const

inline

Index (if any) associated with data.

Definition at line 145 of file pointEdgeStructuredWalk.H.

Referenced by pointEdgeStructuredWalk().

Here is the caller graph for this function:

◆ inZone()

bool inZone ( ) const

inline

True if starting point is valid (ie, not point::max).

Definition at line 81 of file pointEdgeStructuredWalkI.H.

References VectorSpace< Form, Cmpt, Ncmpts >::max.

Referenced by updateEdge(), updatePoint(), and updatePoint().

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 88 of file pointEdgeStructuredWalkI.H.

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

Here is the call graph for this function:

◆ sameGeometry()

template<class TrackingData>

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

inline

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

Definition at line 96 of file pointEdgeStructuredWalkI.H.

References Foam::diff(), dist(), Foam::mag(), pointEdgeStructuredWalk(), 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 124 of file pointEdgeStructuredWalkI.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 150 of file pointEdgeStructuredWalkI.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 137 of file pointEdgeStructuredWalkI.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 pointEdgeStructuredWalk &	edgeInfo,
		const scalar	tol,
		TrackingData &	td )

inline

Influence of edge on point.

Definition at line 165 of file pointEdgeStructuredWalkI.H.

References inZone(), mesh, pointEdgeStructuredWalk(), 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 pointEdgeStructuredWalk &	newPointInfo,
		const scalar	tol,
		TrackingData &	td )

inline

Influence of different value on same point.

Merge new and old info.

Definition at line 186 of file pointEdgeStructuredWalkI.H.

References inZone(), mesh, pointEdgeStructuredWalk(), td(), and update().

Here is the call graph for this function:

◆ updatePoint() [3/3]

template<class TrackingData>

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

inline

Influence of different value on same point.

No information about current position whatsoever.

Definition at line 206 of file pointEdgeStructuredWalkI.H.

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

inline

Influence of point on edge.

Definition at line 219 of file pointEdgeStructuredWalkI.H.

References inZone(), mesh, pointEdgeStructuredWalk(), td(), and update().

Here is the call graph for this function:

◆ equal()

template<class TrackingData>

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

inline

Test for equality, with TrackingData.

Definition at line 239 of file pointEdgeStructuredWalkI.H.

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

Here is the call graph for this function:

◆ operator==()

bool operator== ( const pointEdgeStructuredWalk & rhs ) const

inline

Test for equality.

Definition at line 251 of file pointEdgeStructuredWalkI.H.

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

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const pointEdgeStructuredWalk & rhs ) const

inline

Test for inequality.

Definition at line 260 of file pointEdgeStructuredWalkI.H.

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

Here is the call graph for this function:

◆ operator<<

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

friend

References pointEdgeStructuredWalk().

◆ operator>>

Istream & operator>>	(	Istream &	,
		pointEdgeStructuredWalk &	)

friend

References pointEdgeStructuredWalk().

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

src/dynamicMesh/motionSolvers/displacement/layeredSolver/pointEdgeStructuredWalk.H
src/dynamicMesh/motionSolvers/displacement/layeredSolver/pointEdgeStructuredWalkI.H

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ pointEdgeStructuredWalk() [1/2]

◆ pointEdgeStructuredWalk() [2/2]

Member Function Documentation

◆ dist()

◆ data()

◆ index()

◆ inZone()

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