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

#include <ParticleTracks.H>

Inheritance diagram for ParticleTracks< CloudType >:

Collaboration diagram for ParticleTracks< CloudType >:

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

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

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for.
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.
Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info.
Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud.
Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model.
dictionary &	properties_
	Reference to properties dictionary e.g. for restart.
const dictionary	dict_
	Copy of dictionary used during construction.
const word	baseName_
	Name of the sub-model base class.
const word	modelType_
	Type of the sub-model.
const dictionary	coeffDict_
	Coefficients dictionary.

Detailed Description

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

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

Source files

Definition at line 52 of file ParticleTracks.H.

Constructor & Destructor Documentation

◆ ParticleTracks() [1/2]

template<class CloudType>

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

Construct from dictionary.

Definition at line 51 of file ParticleTracks.C.

References CloudFunctionObject< CloudType >::CloudFunctionObject(), subModelBase::coeffDict(), subModelBase::dict(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, subModelBase::modelName(), and CloudSubModelBase< CloudType >::owner().

Referenced by clone(), ParticleTracks(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParticleTracks() [2/2]

template<class CloudType>

ParticleTracks ( const ParticleTracks< CloudType > & ppm )

Construct copy.

Definition at line 68 of file ParticleTracks.C.

References CloudFunctionObject< CloudType >::CloudFunctionObject(), and ParticleTracks().

Here is the call graph for this function:

◆ ~ParticleTracks()

template<class CloudType>

virtual ~ParticleTracks ( )

virtualdefault

Destructor.

References p, and td().

Here is the call graph for this function:

Member Function Documentation

◆ write()

template<class CloudType>

void write ( )

protectedvirtual

Write post-processing info.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 30 of file ParticleTracks.C.

References DebugInFunction, and Foam::endl().

Here is the call graph for this function:

◆ TypeName()

template<class CloudType>

TypeName ( "particleTracks" )

Runtime type information.

References subModelBase::dict(), subModelBase::modelName(), CloudSubModelBase< CloudType >::owner(), and ParticleTracks().

Here is the call graph for this function:

◆ clone()

template<class CloudType>

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

inlinevirtual

Construct and return a clone.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 128 of file ParticleTracks.H.

References ParticleTracks().

Here is the call graph for this function:

◆ trackInterval()

template<class CloudType>

Foam::label trackInterval ( ) const

inline

Return const access to the track interval.

Definition at line 27 of file ParticleTracksI.H.

◆ maxSamples()

template<class CloudType>

Foam::label maxSamples ( ) const

inline

Return const access to the max samples.

Definition at line 34 of file ParticleTracksI.H.

◆ resetOnWrite()

template<class CloudType>

bool resetOnWrite ( ) const

inline

Should data be reset on write?

Definition at line 41 of file ParticleTracksI.H.

◆ faceHitCounter()

template<class CloudType>

const Foam::labelPairLookup & faceHitCounter ( ) const

inline

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

Definition at line 49 of file ParticleTracksI.H.

◆ cloud()

template<class CloudType>

const Foam::Cloud< typename CloudType::parcelType > & cloud ( ) const

inline

Return const access to the cloud.

Definition at line 57 of file ParticleTracksI.H.

◆ preEvolve()

template<class CloudType>

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

virtual

Pre-evolve hook.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 85 of file ParticleTracks.C.

References name, CloudSubModelBase< CloudType >::owner(), and td().

Here is the call graph for this function:

◆ postFace()

template<class CloudType>

bool postFace	(	const parcelType &	p,
		const typename parcelType::trackingData &	td )

virtual

Post-face hook.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 101 of file ParticleTracks.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, nSamples(), CloudSubModelBase< CloudType >::owner(), p, and td().

Here is the call graph for this function:

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

src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleTracks/ParticleTracks.H
src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleTracks/ParticleTracks.C
src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleTracks/ParticleTracksI.H

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ParticleTracks() [1/2]

◆ ParticleTracks() [2/2]

◆ ~ParticleTracks()

Member Function Documentation

◆ write()

◆ TypeName()

◆ clone()

◆ trackInterval()

◆ maxSamples()

◆ resetOnWrite()

◆ faceHitCounter()

◆ cloud()

◆ preEvolve()

◆ postFace()