ParticleTracks< CloudType > Class Template Reference

Records particle state (all variables) on each call to postFace. More...

Inheritance diagram for ParticleTracks< CloudType >:
[legend]
Collaboration diagram for ParticleTracks< CloudType >:
[legend]

Public Member Functions

 TypeName ("particleTracks")
 Runtime type information. More...
 
 ParticleTracks (const dictionary &dict, CloudType &owner, const word &modelName)
 Construct from dictionary. More...
 
 ParticleTracks (const ParticleTracks< CloudType > &ppm)
 Construct copy. More...
 
virtual autoPtr< CloudFunctionObject< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~ParticleTracks ()=default
 Destructor. More...
 
label trackInterval () const
 Return const access to the track interval. More...
 
label maxSamples () const
 Return const access to the max samples. More...
 
bool resetOnWrite () const
 Should data be reset on write? More...
 
const labelPairLookupfaceHitCounter () const
 Return the table of number of times a particle has hit a face. More...
 
const Cloud< parcelType > & cloud () const
 Return const access to the cloud. More...
 
virtual void preEvolve (const typename parcelType::trackingData &td)
 Pre-evolve hook. More...
 
virtual void postFace (const parcelType &p, bool &keepParticle)
 Post-face hook. More...
 
- Public Member Functions inherited from CloudFunctionObject< CloudType >
 TypeName ("cloudFunctionObject")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, CloudFunctionObject, dictionary,(const dictionary &dict, CloudType &owner, const word &modelName),(dict, owner, modelName))
 Declare runtime constructor selection table. More...
 
 CloudFunctionObject (CloudType &owner)
 Construct null from owner. More...
 
 CloudFunctionObject (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)
 Construct from dictionary. More...
 
 CloudFunctionObject (const CloudFunctionObject< CloudType > &ppm)
 Construct copy. More...
 
virtual autoPtr< CloudFunctionObject< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~CloudFunctionObject ()=default
 Destructor. More...
 
virtual void preEvolve (const typename parcelType::trackingData &td)
 Pre-evolve hook. More...
 
virtual void postEvolve (const typename parcelType::trackingData &td)
 Post-evolve hook. More...
 
virtual void postMove (parcelType &p, const scalar dt, const point &position0, bool &keepParticle)
 Post-move hook. More...
 
virtual void postPatch (const parcelType &p, const polyPatch &pp, bool &keepParticle)
 Post-patch hook. More...
 
virtual void postFace (const parcelType &p, bool &keepParticle)
 Post-face hook. More...
 
const fileNameoutputDir () const
 Return the output path. More...
 
fileName writeTimeDir () const
 Return the output time path. More...
 
- Public Member Functions inherited from CloudSubModelBase< CloudType >
 CloudSubModelBase (CloudType &owner)
 Construct null from owner cloud. More...
 
 CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from owner cloud without name. More...
 
 CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from owner cloud with name. More...
 
 CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
 Construct as copy. More...
 
virtual ~CloudSubModelBase ()
 Destructor. More...
 
const CloudTypeowner () const
 Return const access to the owner cloud. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
virtual fileName localPath () const
 Output directory. More...
 
CloudTypeowner ()
 Return non-const access to the owner cloud for manipulation. More...
 
virtual void write (Ostream &os) const
 Write. More...
 
- Public Member Functions inherited from subModelBase
 subModelBase (dictionary &properties)
 Construct null. More...
 
 subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from components without name. More...
 
 subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from components with name. More...
 
 subModelBase (const subModelBase &smb)
 Construct as copy. More...
 
virtual ~subModelBase ()
 Destructor. More...
 
const wordmodelName () const
 Return const access to the name of the sub-model. More...
 
const dictionarydict () const
 Return const access to the cloud dictionary. More...
 
const wordbaseName () const
 Return const access to the base name of the sub-model. More...
 
const wordmodelType () const
 Return const access to the sub-model type. More...
 
const dictionarycoeffDict () const
 Return const access to the coefficients dictionary. More...
 
const dictionaryproperties () const
 Return const access to the properties dictionary. More...
 
virtual bool defaultCoeffs (const bool printMsg) const
 Returns true if defaultCoeffs is true and outputs on printMsg. More...
 
virtual bool active () const
 Return the model 'active' status - default active = true. More...
 
virtual void cacheFields (const bool store)
 Cache dependent sub-model fields. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
virtual fileName localPath () const
 Output directory. More...
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 Retrieve generic property from the base model. More...
 
template<class Type >
void getBaseProperty (const word &entryName, Type &value) const
 Retrieve generic property from the base model. More...
 
template<class Type >
void setBaseProperty (const word &entryName, const Type &value)
 Add generic property to the base model. More...
 
bool getModelDict (const word &entryName, dictionary &dict) const
 Retrieve dictionary, return true if set. More...
 
template<class Type >
bool getModelProperty (const word &entryName, Type &value) const
 Retrieve generic property from the sub-model. More...
 
template<class Type >
Type getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 Retrieve generic property from the sub-model. More...
 
template<class Type >
void setModelProperty (const word &entryName, const Type &value)
 Add generic property to the sub-model. More...
 
virtual void write (Ostream &os) const
 Write. More...
 

Protected Member Functions

void write ()
 Write post-processing info. More...
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 

Additional Inherited Members

- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 
- Static Public Member Functions inherited from CloudFunctionObject< CloudType >
static autoPtr< CloudFunctionObject< CloudType > > New (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)
 Selector. More...
 
- Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudTypeowner_
 Reference to the cloud. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionaryproperties_
 Reference to properties dictionary e.g. for restart. More...
 
const dictionary dict_
 Copy of dictionary used during construction. More...
 
const word baseName_
 Name of the sub-model base class. More...
 
const word modelType_
 Type of the sub-model. More...
 
const dictionary coeffDict_
 Coefficients dictionary. More...
 

Detailed Description

template<class CloudType>
class Foam::ParticleTracks< CloudType >

Records particle state (all variables) on each call to postFace.

Source files

Definition at line 56 of file ParticleTracks.H.

Constructor & Destructor Documentation

◆ ParticleTracks() [1/2]

ParticleTracks ( const dictionary dict,
CloudType owner,
const word modelName 
)

Construct from dictionary.

Definition at line 58 of file ParticleTracks.C.

◆ ParticleTracks() [2/2]

Construct copy.

Definition at line 75 of file ParticleTracks.C.

◆ ~ParticleTracks()

virtual ~ParticleTracks ( )
virtualdefault

Destructor.

Member Function Documentation

◆ write()

void write
protectedvirtual

Write post-processing info.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 37 of file ParticleTracks.C.

References DebugInFunction, and Foam::endl().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "particleTracks"  )

Runtime type information.

◆ clone()

virtual autoPtr< CloudFunctionObject< CloudType > > clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 110 of file ParticleTracks.H.

◆ trackInterval()

Foam::label trackInterval
inline

Return const access to the track interval.

Definition at line 34 of file ParticleTracksI.H.

◆ maxSamples()

Foam::label maxSamples
inline

Return const access to the max samples.

Definition at line 41 of file ParticleTracksI.H.

◆ resetOnWrite()

bool resetOnWrite
inline

Should data be reset on write?

Definition at line 48 of file ParticleTracksI.H.

◆ faceHitCounter()

const Foam::labelPairLookup & faceHitCounter
inline

Return the table of number of times a particle has hit a face.

Definition at line 56 of file ParticleTracksI.H.

◆ cloud()

const Foam::Cloud< typename CloudType::parcelType > & cloud
inline

Return const access to the cloud.

Definition at line 64 of file ParticleTracksI.H.

◆ preEvolve()

void preEvolve ( const typename parcelType::trackingData td)
virtual

Pre-evolve hook.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 92 of file ParticleTracks.C.

References Foam::name().

Here is the call graph for this function:

◆ postFace()

void postFace ( const parcelType &  p,
bool keepParticle 
)
virtual

Post-face hook.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 108 of file ParticleTracks.C.

References Foam::abort(), GeometricField< Type, PatchField, GeoMesh >::clone(), Foam::FatalError, FatalErrorInFunction, nSamples(), Foam::output(), and p.

Here is the call graph for this function:

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