particleTracksSampler Class Reference

Helper class when generating particle tracks. The interface is fairly rudimentary. More...

#include <particleTracksSampler.H>

Collaboration diagram for particleTracksSampler:

Public Member Functions
const globalIndex &	parcelAddr () const noexcept
	The original parcel addressing.
label	nParticle () const
	Total number of particles.
label	nTracks () const noexcept
	Number of tracks to generate.
void	reset (const labelUList &origParcelCounts)
	Define the orig parcel mappings.
label	setSampleRate (const label sampleFreq, const label maxPositions, const label maxTracks=-1)
	Set the sampling stride, upper limits.
void	resetCloud (const label localCloudSize)
template<class Type>
void	gatherInplace (List< Type > &fld) const
template<class Type>
void	createTrackField (const UList< Type > &values, List< DynamicList< Type > > &trackValues) const
template<class Type>
label	setTrackFields (const objectRegistry &obr, HashTable< List< DynamicList< Type > > > &fieldTable) const

Public Attributes
labelField	origParcelIds_
	The originating parcel ids.
labelField	origProcIds_
	The originating processor ids.

Detailed Description

Helper class when generating particle tracks. The interface is fairly rudimentary.

Source files

• particleTracksSampler.H
• particleTracksSamplerTemplates.C

Definition at line 54 of file particleTracksSampler.H.

Member Function Documentation

parcelAddr()

const globalIndex & parcelAddr ( ) const

inlinenoexcept

The original parcel addressing.

Definition at line 109 of file particleTracksSampler.H.

References Foam::noexcept.

nParticle()

label nParticle ( ) const

inline

Total number of particles.

Definition at line 117 of file particleTracksSampler.H.

nTracks()

label nTracks ( ) const

inlinenoexcept

Number of tracks to generate.

Definition at line 125 of file particleTracksSampler.H.

References Foam::noexcept.

reset()

void reset ( const labelUList & origParcelCounts )

inline

Define the orig parcel mappings.

Definition at line 133 of file particleTracksSampler.H.

References origParcelIds_, and origProcIds_.

setSampleRate()

label setSampleRate ( const label sampleFreq, const label maxPositions, const label maxTracks = -1 )

inline

Set the sampling stride, upper limits.

Returns

Number of tracks to generate

Definition at line 146 of file particleTracksSampler.H.

References Foam::max(), maxPositions(), maxTracks(), and Foam::min().

Here is the call graph for this function:

resetCloud()

void resetCloud ( const label localCloudSize )

inline

Definition at line 167 of file particleTracksSampler.H.

References origParcelIds_, and origProcIds_.

gatherInplace()

template<class Type>

void gatherInplace ( List< Type > & fld ) const

inline

Definition at line 175 of file particleTracksSampler.H.

References fld().

Here is the call graph for this function:

createTrackField()

template<class Type>

void createTrackField	(	const UList< Type > &	values,
		List< DynamicList< Type > > &	trackValues ) const

setTrackFields()

template<class Type>

label setTrackFields	(	const objectRegistry &	obr,
		HashTable< List< DynamicList< Type > > > &	fieldTable ) const

Member Data Documentation

origParcelIds_

labelField origParcelIds_

The originating parcel ids.

Definition at line 96 of file particleTracksSampler.H.

Referenced by reset(), and resetCloud().

origProcIds_

labelField origProcIds_

The originating processor ids.

Definition at line 101 of file particleTracksSampler.H.

Referenced by reset(), and resetCloud().

---

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

• applications/utilities/postProcessing/lagrangian/particleTracks/particleTracksSampler.H