sampledSet Class Reference

Holds list of sampling points which is filled at construction time. Various implementations of this base class to e.g. get sampling points at uniform distance along a line (uniformSet) or directly specified (cloudSet). More...

Inheritance diagram for sampledSet:

[legend]

Collaboration diagram for sampledSet:

[legend]

List of all members.


Classes
class	iNew
	Class used for the read-construction of. More...
Public Member Functions
	TypeName ("sampledSet")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, sampledSet, word,(const word &name, const polyMesh &mesh, meshSearch &searchEngine, const dictionary &dict),(name, mesh, searchEngine, dict))
	sampledSet (const word &name, const polyMesh &mesh, meshSearch &searchEngine, const word &axis)
	Construct from components.
	sampledSet (const word &name, const polyMesh &mesh, meshSearch &searchEngine, const dictionary &dict)
	Construct from dictionary.
autoPtr< sampledSet >	clone () const
	Clone.
virtual	~sampledSet ()
const polyMesh &	mesh () const
meshSearch &	searchEngine () const
const labelList &	segments () const
const scalarList &	curveDist () const
const labelList &	cells () const
const labelList &	faces () const
virtual point	getRefPoint (const List< point > &) const =0
	Given all sampling points (on all processors) return reference point.
Ostream &	write (Ostream &) const
	Output for debugging.
Static Public Member Functions
static autoPtr< sampledSet >	New (const word &name, const polyMesh &mesh, meshSearch &searchEngine, const dictionary &dict)
	Return a reference to the selected sampledSet.
Static Public Attributes
static const scalar	tol = 1e-6
	Tolerance when comparing points. Usually relative to difference.
Protected Member Functions
label	getBoundaryCell (const label) const
	Returns cell next to boundary face.
label	getCell (const label faceI, const point &sample) const
	Returns cell using face and containing sample.
scalar	calcSign (const label faceI, const point &sample) const
	Calculates inproduct of face normal and vector sample-face centre.
label	findNearFace (const label cellI, const point &sample, const scalar smallDist) const
	Returns face label (or -1) of face which is close to sample.
point	pushIn (const point &sample, const label faceI) const
	Moves sample in direction of -n to it is 'inside' of faceI.
bool	getTrackingPoint (const vector &offset, const point &samplePt, const point &bPoint, const label bFaceI, point &trackPt, label &trackCellI, label &trackFaceI) const
	Calculates start of tracking given samplePt and first boundary.
void	setSamples (const List< point > &samplingPts, const labelList &samplingCells, const labelList &samplingFaces, const labelList &samplingSegments, const scalarList &samplingCurveDist)
	Sets sample data.
Protected Attributes
labelList	segments_
	Segment numbers.
scalarList	curveDist_
	Parameter along sample curve. Uniquely identifies position.
labelList	cells_
	Cell numbers.
labelList	faces_
	Face numbers (-1 if not known).

Detailed Description

Holds list of sampling points which is filled at construction time. Various implementations of this base class to e.g. get sampling points at uniform distance along a line (uniformSet) or directly specified (cloudSet).

Each 'sampledSet' has a name and a specifier of how the axis should be write (x/y/z component or all 3 components)

Source files

Definition at line 60 of file sampledSet.H.

Constructor & Destructor Documentation

sampledSet	(	const word &	name,
		const polyMesh &	mesh,
		meshSearch &	searchEngine,
		const word &	axis
	)

Construct from components.

Definition at line 359 of file sampledSet.C.

sampledSet	(	const word &	name,
		const polyMesh &	mesh,
		meshSearch &	searchEngine,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 377 of file sampledSet.C.

~sampledSet ( ) [virtual]

Definition at line 396 of file sampledSet.C.

Member Function Documentation

Foam::label getBoundaryCell ( const label faceI ) const [protected]

Returns cell next to boundary face.

Definition at line 37 of file sampledSet.C.

Foam::label getCell	(	const label	faceI,
		const point &	sample
	)			const `[protected]`

Returns cell using face and containing sample.

Definition at line 44 of file sampledSet.C.

References polyMesh::faceOwner(), and sampledSet::mesh().

Here is the call graph for this function:

Foam::scalar calcSign	(	const label	faceI,
		const point &	sample
	)			const `[protected]`

Calculates inproduct of face normal and vector sample-face centre.

<0 if sample inside.

Definition at line 108 of file sampledSet.C.

Foam::label findNearFace	(	const label	cellI,
		const point &	sample,
		const scalar	smallDist
	)			const `[protected]`

Returns face label (or -1) of face which is close to sample.

Definition at line 135 of file sampledSet.C.

Foam::point pushIn	(	const point &	sample,
		const label	faceI
	)			const `[protected]`

Moves sample in direction of -n to it is 'inside' of faceI.

Definition at line 172 of file sampledSet.C.

bool getTrackingPoint	(	const vector &	offset,
		const point &	samplePt,
		const point &	bPoint,
		const label	bFaceI,
		point &	trackPt,
		label &	trackCellI,
		label &	trackFaceI
	)			const `[protected]`

Calculates start of tracking given samplePt and first boundary.

intersection (bPoint, bFaceI) (bFaceI == -1 if no boundary intersection) Returns true if trackPt is valid sampling point. Sets trackPt, trackFaceI, trackCellI (-1 if no tracking point found)

Definition at line 205 of file sampledSet.C.

void setSamples	(	const List< point > &	samplingPts,
		const labelList &	samplingCells,
		const labelList &	samplingFaces,
		const labelList &	samplingSegments,
		const scalarList &	samplingCurveDist
	)			`[protected]`

Sets sample data.

Definition at line 313 of file sampledSet.C.

TypeName ( "sampledSet" )

Runtime type information.

declareRunTimeSelectionTable	(	autoPtr	,
		sampledSet	,
		word	,
		(const word &name, const polyMesh &mesh, meshSearch &searchEngine, const dictionary &dict)	,
		(name, mesh, searchEngine, dict)
	)