Inheritance diagram for uniformSet:

Collaboration diagram for uniformSet:

Public Member Functions
	TypeName ("uniform")
	Runtime type information. More...

	uniformSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const word &axis, const point &start, const point &end, const label nPoints)
	Construct from components. More...

	uniformSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)
	Construct from dictionary. More...

virtual	~uniformSet ()
	Destructor. More...

Public Member Functions inherited from sampledSet
	TypeName ("sampledSet")
	Runtime type information. More...

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

	sampledSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const word &axis)
	Construct from components. More...

	sampledSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)
	Construct from dictionary. More...

autoPtr< sampledSet >	clone () const
	Clone. More...

virtual	~sampledSet ()
	Destructor. More...

const polyMesh &	mesh () const

const meshSearch &	searchEngine () const

const labelList &	segments () const

const labelList &	cells () const

const labelList &	faces () const

Ostream &	write (Ostream &) const
	Output for debugging. More...

Public Member Functions inherited from coordSet
	coordSet (const word &name, const word &axis)
	Construct from components. More...

	coordSet (const word &name, const word &axis, const List< point > &points, const scalarList &curveDist)
	Construct from components. More...

const word &	name () const

word	axis () const

const scalarList &	curveDist () const
	Cumulative distance. More...

bool	hasVectorAxis () const
	Is axis specification a vector. More...

scalar	scalarCoord (const label index) const
	Get coordinate of point according to axis specification. More...

vector	vectorCoord (const label index) const
	Get point according to axis="xyz" specification. More...

Ostream &	write (Ostream &os) const

Public Member Functions inherited from Field
	Field ()
	Construct null. More...

	Field (const label)
	Construct given size. More...

	Field (const label, const Type &)
	Construct given size and initial value. More...

	Field (const UList< Type > &)
	Construct as copy of a UList<Type> More...

	Field (const Xfer< List< Type > > &)
	Construct by transferring the List contents. More...

	Field (const UList< Type > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field. More...

	Field (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given tmp field. More...

	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field. More...

	Field (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given tmp field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given tmp field. More...

	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Supplied uniform. More...

	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Supplied values. More...

	Field (const Field< Type > &)
	Construct as copy. More...

	Field (Field< Type > &, bool reUse)
	Construct as copy or re-use as specified. More...

	Field (const Xfer< Field< Type > > &)
	Construct by transferring the Field contents. More...

	Field (const tmp< Field< Type > > &)
	Construct as copy of tmp<Field> More...

	Field (Istream &)
	Construct from Istream. More...

	Field (const word &keyword, const dictionary &, const label size)
	Construct from a dictionary entry. More...

tmp< Field< Type > >	clone () const
	Clone. More...

void	map (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field More...

void	map (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	1 to 1 map from the given tmp field More...

void	map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given field. More...

void	map (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given tmp field. More...

void	map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given field. More...

void	map (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given tmp field. More...

void	autoMap (const FieldMapper &map, const bool applyFlip=true)
	Map from self. More...

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field More...

void	rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field More...

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field. More...

void	rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field. More...

void	negate ()
	Negate this field. More...

tmp< Field< cmptType > >	component (const direction) const
	Return a component field of the field. More...

void	replace (const direction, const UList< cmptType > &)
	Replace a component field of the field. More...

void	replace (const direction, const tmp< Field< cmptType > > &)
	Replace a component field of the field. More...

void	replace (const direction, const cmptType &)
	Replace a component field of the field. More...

tmp< Field< Type > >	T () const
	Return the field transpose (only defined for second rank tensors) More...

void	writeEntry (const word &keyword, Ostream &os) const
	Write the field as a dictionary entry. More...

void	operator= (const Field< Type > &)

void	operator= (const UList< Type > &)

void	operator= (const SubField< Type > &)

void	operator= (const tmp< Field< Type > > &)

void	operator= (const Type &)

template<class Form , class Cmpt , int nCmpt>
void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)

void	operator+= (const UList< Type > &)

void	operator+= (const tmp< Field< Type > > &)

void	operator-= (const UList< Type > &)

void	operator-= (const tmp< Field< Type > > &)

void	operator*= (const UList< scalar > &)

void	operator*= (const tmp< Field< scalar > > &)

void	operator/= (const UList< scalar > &)

void	operator/= (const tmp< Field< scalar > > &)

void	operator+= (const Type &)

void	operator-= (const Type &)

void	operator*= (const scalar &)

void	operator/= (const scalar &)

template<class Type >
void	operator= (const Field< Type > &rhs)

template<class Type >
void	operator= (const SubField< Type > &rhs)

template<class Type >
void	operator= (const UList< Type > &rhs)

template<class Type >
void	operator= (const tmp< Field > &rhs)

template<class Type >
void	operator= (const Type &t)

Private Member Functions
bool	nextSample (const point &currentPt, const vector &offset, const scalar smallDist, point &samplePt, label &sampleI) const
	Calculates - starting at samplePt - the first sampling point. More...

bool	trackToBoundary (passiveParticleCloud &particleCloud, passiveParticle &singleParticle, point &samplePt, label &sampleI, DynamicList< point > &samplingPts, DynamicList< label > &samplingCells, DynamicList< label > &samplingFaces, DynamicList< scalar > &samplingCurveDist) const
	Samples from startTrackPt/CellI. Updates particle/samplePt/sampleI. More...

void	calcSamples (DynamicList< point > &samplingPts, DynamicList< label > &samplingCells, DynamicList< label > &samplingFaces, DynamicList< label > &samplingSegments, DynamicList< scalar > &samplingCurveDist) const
	Samples from start_ to end_. samplingSegments contains segmentNo. More...

void	genSamples ()
	Uses calcSamples to obtain samples. Copies them into *this. More...

Private Attributes
point	start_
	Starting point. More...

point	end_
	End point. More...

label	nPoints_
	Number of points. More...

Additional Inherited Members
Public Types inherited from coordSet
enum	coordFormat { XYZ, X, Y, Z, DISTANCE }
	Enumeration defining the output format for coordinates. More...

Public Types inherited from Field
typedef pTraits< Type >::cmptType	cmptType
	Component type. More...

typedef SubField< Type >	subField
	Declare type of subField. More...

Static Public Member Functions inherited from sampledSet
static autoPtr< sampledSet >	New (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)
	Return a reference to the selected sampledSet. More...

Static Public Member Functions inherited from Field
static const Field< Type > &	null ()
	Return a null field. More...

template<class Type2 >
static tmp< Field< Type > >	NewCalculatedType (const Field< Type2 > &f)
	Return a pointer to a new calculatedFvPatchFieldField created on. More...

Static Public Attributes inherited from sampledSet
static const scalar	tol = 1e-6
	Tolerance when comparing points. Usually relative to difference. More...

Static Public Attributes inherited from Field
static const char *const	typeName

Protected Member Functions inherited from sampledSet
label	getBoundaryCell (const label) const
	Returns cell next to boundary face. More...

label	getCell (const label faceI, const point &sample) const
	Returns cell using face and containing sample. More...

scalar	calcSign (const label faceI, const point &sample) const
	Calculates inproduct of face normal and vector sample-face centre. More...

label	findNearFace (const label cellI, const point &sample, const scalar smallDist) const
	Returns face label (or -1) of face which is close to sample. More...

point	pushIn (const point &sample, const label faceI) const
	Moves sample in direction of -n to it is 'inside' of faceI. More...

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

void	setSamples (const List< point > &samplingPts, const labelList &samplingCells, const labelList &samplingFaces, const labelList &samplingSegments, const scalarList &samplingCurveDist)
	Sets sample data. More...

Protected Attributes inherited from sampledSet
labelList	segments_
	Segment numbers. More...

labelList	cells_
	Cell numbers. More...

labelList	faces_
	Face numbers (-1 if not known) More...

Protected Attributes inherited from coordSet
const word	name_
	Name. More...

const coordFormat	axis_
	Axis write type. More...

scalarList	curveDist_
	Cumulative distance "distance" write specifier. More...

Detailed Description

Source files

Definition at line 49 of file uniformSet.H.

Constructor & Destructor Documentation

◆ uniformSet() [1/2]

uniformSet	(	const word &	name,
		const polyMesh &	mesh,
		const meshSearch &	searchEngine,
		const word &	axis,
		const point &	start,
		const point &	end,
		const label	nPoints
	)

Construct from components.

Definition at line 432 of file uniformSet.C.

References Foam::Pout, and write().

Here is the call graph for this function:

◆ uniformSet() [2/2]

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

Construct from dictionary.

Definition at line 457 of file uniformSet.C.

References Foam::Pout, and write().

Here is the call graph for this function:

◆ ~uniformSet()

~uniformSet ( )

virtual

Destructor.

Definition at line 480 of file uniformSet.C.

Member Function Documentation

◆ nextSample()

bool nextSample	(	const point &	currentPt,
		const vector &	offset,
		const scalar	smallDist,
		point &	samplePt,
		label &	sampleI
	)		const

private

Calculates - starting at samplePt - the first sampling point.

on or after currentPt. smallDist is the tolerance used to compare positions. Returns false if end of samples reached.

Definition at line 45 of file uniformSet.C.

References Foam::mag(), and s().

Here is the call graph for this function:

◆ trackToBoundary()

bool trackToBoundary	(	passiveParticleCloud &	particleCloud,
		passiveParticle &	singleParticle,
		point &	samplePt,
		label &	sampleI,
		DynamicList< point > &	samplingPts,
		DynamicList< label > &	samplingCells,
		DynamicList< label > &	samplingFaces,
		DynamicList< scalar > &	samplingCurveDist
	)		const

private

Samples from startTrackPt/CellI. Updates particle/samplePt/sampleI.

and puts samples in the DynamicLists. Returns false if end of all samples reached

Definition at line 79 of file uniformSet.C.

References DynamicList::append(), particle< Type >::cell(), Foam::endl(), particle< Type >::face(), Foam::mag(), particle< Type >::onBoundary(), particle< Type >::position(), Foam::Pout, particle< Type >::stepFraction(), and particle< Type >::track().

Here is the call graph for this function:

◆ calcSamples()

void calcSamples	(	DynamicList< point > &	samplingPts,
		DynamicList< label > &	samplingCells,
		DynamicList< label > &	samplingFaces,
		DynamicList< label > &	samplingSegments,
		DynamicList< scalar > &	samplingCurveDist
	)		const

private

Samples from start_ to end_. samplingSegments contains segmentNo.

for each sample.

Definition at line 209 of file uniformSet.C.

References DynamicList::append(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::mag(), mesh, particle< Type >::position(), Foam::Pout, and List::size().

Referenced by uniformSet::genSamples().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ genSamples()

void genSamples ( )

private

Uses calcSamples to obtain samples. Copies them into *this.

Definition at line 394 of file uniformSet.C.

References uniformSet::calcSamples(), sampledSet::setSamples(), and DynamicList::shrink().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "uniform" )

Runtime type information.

Field Documentation

◆ start_

point start_

private

Starting point.

Definition at line 56 of file uniformSet.H.

◆ end_

point end_

private

End point.

Definition at line 59 of file uniformSet.H.

◆ nPoints_

label nPoints_

private

Number of points.

Definition at line 62 of file uniformSet.H.

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

src/sampling/sampledSet/uniform/uniformSet.H
src/sampling/sampledSet/uniform/uniformSet.C

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ uniformSet() [1/2]

◆ uniformSet() [2/2]

◆ ~uniformSet()

Member Function Documentation

◆ nextSample()

◆ trackToBoundary()

◆ calcSamples()

◆ genSamples()

◆ TypeName()

Field Documentation

◆ start_

◆ end_

◆ nPoints_