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

Collaboration diagram for externalPointEdgePoint:

[legend]

Data Structures
class	trackingData
	Class used to pass data into container. More...

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

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

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

const point &	origin () const

scalar	distSqr () const

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

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

template<class TrackingData >
void	leaveDomain (const polyPatch &patch, const label patchPointI, const point &pos, TrackingData &td)
	Convert origin to relative vector to leaving point. More...

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

template<class TrackingData >
void	transform (const tensor &rotTensor, TrackingData &td)
	Apply rotation matrix to origin. More...

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

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

template<class TrackingData >
bool	updatePoint (const externalPointEdgePoint &newPointInfo, const scalar tol, TrackingData &td)
	Influence of different value on same point. More...

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

template<class TrackingData >
bool	equal (const externalPointEdgePoint &, TrackingData &td) const
	Equivalent to operator== with TrackingData. More...

bool	operator== (const externalPointEdgePoint &) const

bool	operator!= (const externalPointEdgePoint &) const

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

template<class TrackingData >
bool	update (const externalPointEdgePoint &w2, const scalar tol, TrackingData &td)
	Combine current with w2. Update distSqr, origin if w2 has smaller. More...

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

scalar	distSqr_
	Normal distance (squared) from point to origin. More...

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 55 of file externalPointEdgePoint.H.

Constructor & Destructor Documentation

◆ externalPointEdgePoint() [1/3]

externalPointEdgePoint ( )

inline

Construct null.

Definition at line 118 of file externalPointEdgePointI.H.

◆ externalPointEdgePoint() [2/3]

externalPointEdgePoint	(	const point &	origin,
		const scalar	distSqr
	)

inline

Construct from origin, distance.

Definition at line 126 of file externalPointEdgePointI.H.

◆ externalPointEdgePoint() [3/3]

externalPointEdgePoint ( const externalPointEdgePoint & wpt )

inline

Construct as copy.

Definition at line 137 of file externalPointEdgePointI.H.

Member Function Documentation

◆ update() [1/2]

bool update	(	const point &	pt,
		const externalPointEdgePoint &	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 33 of file externalPointEdgePointI.H.

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

Here is the call graph for this function:

◆ update() [2/2]

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

inlineprivate

Combine current with w2. Update distSqr, origin if w2 has smaller.

quantities and returns true.

Definition at line 77 of file externalPointEdgePointI.H.

References Foam::diff(), externalPointEdgePoint::distSqr(), and externalPointEdgePoint::origin().

Here is the call graph for this function:

◆ origin()

const Foam::point & origin ( ) const

inline

Definition at line 148 of file externalPointEdgePointI.H.

Referenced by externalPointEdgePoint::operator==(), and externalPointEdgePoint::update().

Here is the caller graph for this function:

◆ distSqr()

Foam::scalar distSqr ( ) const

inline

Definition at line 154 of file externalPointEdgePointI.H.

Referenced by externalPointEdgePoint::operator==(), externalPointEdgePoint::sameGeometry(), and externalPointEdgePoint::update().

Here is the caller graph for this function:

◆ valid()

bool valid ( TrackingData & td ) const

inline

Check whether origin has been changed at all or.

still contains original (invalid) value.

Definition at line 161 of file externalPointEdgePointI.H.

References Vector< scalar >::max.

◆ sameGeometry()

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

inline

Check for identical geometrical data. Used for cyclics checking.

Definition at line 170 of file externalPointEdgePointI.H.

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

Here is the call graph for this function:

◆ leaveDomain()

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

◆ enterDomain()

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

◆ transform()

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

inline

Apply rotation matrix to origin.

Definition at line 211 of file externalPointEdgePointI.H.

References Foam::transform().

Here is the call graph for this function:

◆ updatePoint() [1/3]

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

◆ updatePoint() [2/3]

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

◆ updatePoint() [3/3]

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

◆ updateEdge()

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

References Foam::e, primitiveMesh::edges(), and mesh.

Here is the call graph for this function:

◆ equal()

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

inline

Equivalent to operator== with TrackingData.

Definition at line 293 of file externalPointEdgePointI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const externalPointEdgePoint & rhs ) const

inline

Definition at line 305 of file externalPointEdgePointI.H.

References externalPointEdgePoint::distSqr(), and externalPointEdgePoint::origin().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const externalPointEdgePoint & rhs ) const

inline

Definition at line 315 of file externalPointEdgePointI.H.

Friends And Related Function Documentation

◆ operator<<

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

friend

◆ operator>>

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

friend

Field Documentation

◆ origin_

point origin_

private

Position of nearest wall center.

Definition at line 60 of file externalPointEdgePoint.H.

◆ distSqr_

scalar distSqr_

private

Normal distance (squared) from point to origin.

Definition at line 63 of file externalPointEdgePoint.H.

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

src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionSolver/externalPointEdgePoint.H
src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionSolver/externalPointEdgePointI.H

Data Structures

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ externalPointEdgePoint() [1/3]

◆ externalPointEdgePoint() [2/3]

◆ externalPointEdgePoint() [3/3]

Member Function Documentation

◆ update() [1/2]

◆ update() [2/2]

◆ origin()

◆ distSqr()

◆ valid()

◆ sameGeometry()

◆ leaveDomain()

◆ enterDomain()

◆ transform()

◆ updatePoint() [1/3]

◆ updatePoint() [2/3]

◆ updatePoint() [3/3]

◆ updateEdge()

◆ equal()

◆ operator==()

◆ operator!=()

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

Field Documentation

◆ origin_

◆ distSqr_