Public Member Functions | Public Attributes | List of all members
particleTracksSampler Class Reference

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

Collaboration diagram for particleTracksSampler:
[legend]

Public Member Functions

const globalIndex & parcelAddr () const noexcept
 The original parcel addressing. More...
 
label nParticle () const
 Total number of particles. More...
 
label nTracks () const noexcept
 Number of tracks to generate. More...
 
void reset (const labelUList &origParcelCounts)
 Define the orig parcel mappings. More...
 
label setSampleRate (const label sampleFreq, const label maxPositions, const label maxTracks=-1)
 Set the sampling stride, upper limits. More...
 
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. More...
 
labelField origProcIds_
 The originating processor ids. More...
 

Detailed Description

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

Source files

Definition at line 58 of file particleTracksSampler.H.

Member Function Documentation

◆ parcelAddr()

const globalIndex & parcelAddr ( ) const
inlinenoexcept

The original parcel addressing.

Definition at line 95 of file particleTracksSampler.H.

◆ nParticle()

label nParticle ( ) const
inline

Total number of particles.

Definition at line 101 of file particleTracksSampler.H.

References globalIndex::totalSize().

Here is the call graph for this function:

◆ nTracks()

label nTracks ( ) const
inlinenoexcept

Number of tracks to generate.

Definition at line 107 of file particleTracksSampler.H.

◆ reset()

void reset ( const labelUList &  origParcelCounts)
inline

Define the orig parcel mappings.

Definition at line 113 of file particleTracksSampler.H.

References List< T >::clear(), particleTracksSampler::origParcelIds_, particleTracksSampler::origProcIds_, and globalIndex::reset().

Here is the call graph for this function:

◆ 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 123 of file particleTracksSampler.H.

◆ resetCloud()

void resetCloud ( const label  localCloudSize)
inline

Definition at line 144 of file particleTracksSampler.H.

References particleTracksSampler::origParcelIds_, particleTracksSampler::origProcIds_, globalIndex::reset(), and List< T >::resize_nocopy().

Here is the call graph for this function:

◆ gatherInplace()

void gatherInplace ( List< Type > &  fld) const
inline

Definition at line 152 of file particleTracksSampler.H.

References fld(), and globalIndex::gatherInplace().

Here is the call graph for this function:

◆ createTrackField()

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

◆ setTrackFields()

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

Member Data Documentation

◆ origParcelIds_

labelField origParcelIds_

The originating parcel ids.

Definition at line 86 of file particleTracksSampler.H.

Referenced by particleTracksSampler::reset(), and particleTracksSampler::resetCloud().

◆ origProcIds_

labelField origProcIds_

The originating processor ids.

Definition at line 89 of file particleTracksSampler.H.

Referenced by particleTracksSampler::reset(), and particleTracksSampler::resetCloud().

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