Creates volume fields whose boundaries are used to store patch interaction statistics. More...

Inheritance diagram for PatchInteractionFields< CloudType >:

Collaboration diagram for PatchInteractionFields< CloudType >:

Public Types
enum	resetMode { none, timeStep, writeTime }

Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType

Public Member Functions
	TypeName ("patchInteractionFields")

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

	PatchInteractionFields (const PatchInteractionFields< CloudType > &pii)

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

virtual	~PatchInteractionFields ()=default

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

virtual void	postPatch (const parcelType &p, const polyPatch &pp, bool &keepParticle)

Public Member Functions inherited from CloudFunctionObject< CloudType >
	TypeName ("cloudFunctionObject")

	declareRunTimeSelectionTable (autoPtr, CloudFunctionObject, dictionary,(const dictionary &dict, CloudType &owner, const word &modelName),(dict, owner, modelName))

	CloudFunctionObject (CloudType &owner)

	CloudFunctionObject (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)

	CloudFunctionObject (const CloudFunctionObject< CloudType > &ppm)

virtual	~CloudFunctionObject ()=default

virtual void	postEvolve (const typename parcelType::trackingData &td)

virtual void	postMove (parcelType &p, const scalar dt, const point &position0, bool &keepParticle)

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

const fileName &	outputDir () const

fileName	writeTimeDir () const

Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)

	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")

	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)

	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)

virtual	~CloudSubModelBase ()

const CloudType &	owner () const

virtual bool	writeTime () const

virtual fileName	localPath () const

CloudType &	owner ()

virtual void	write (Ostream &os) const

Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)

	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")

	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)

	subModelBase (const subModelBase &smb)

virtual	~subModelBase ()

const word &	modelName () const

const dictionary &	dict () const

const word &	baseName () const

const word &	modelType () const

const dictionary &	coeffDict () const

const dictionary &	properties () const

virtual bool	defaultCoeffs (const bool printMsg) const

virtual bool	active () const

virtual void	cacheFields (const bool store)

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
void	getBaseProperty (const word &entryName, Type &value) const

template<class Type >
void	setBaseProperty (const word &entryName, const Type &value)

bool	getModelDict (const word &entryName, dictionary &dict) const

template<class Type >
void	getModelProperty (const word &entryName, Type &value) const

template<class Type >
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
void	setModelProperty (const word &entryName, const Type &value)

Static Public Attributes
static const Enum< resetMode >	resetModeNames_

Protected Member Functions
void	reset ()

virtual void	write ()

void	clearOrReset (autoPtr< volScalarField > &fieldPtr, const word &fieldName, const dimensionSet &dims) const

Protected Member Functions inherited from subModelBase
bool	inLine () const

Additional Inherited Members
Static Public Member Functions inherited from CloudFunctionObject< CloudType >
static autoPtr< CloudFunctionObject< CloudType > >	New (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)

Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_

Protected Attributes inherited from subModelBase
const word	modelName_

dictionary &	properties_

const dictionary	dict_

const word	baseName_

const word	modelType_

const dictionary	coeffDict_

Detailed Description

template<class CloudType>
class Foam::PatchInteractionFields< CloudType >

Creates volume fields whose boundaries are used to store patch interaction statistics.

Current field output per patch face:

<cloud><model>:count - cumulative particle hits
<cloud><model>:mass - cumulative mass of hitting particles

Fields can be reset according to:

none: fields are not reset
timeStep: reset at each time step
writeTime: reset at each write time

Usage

patchInteractionFields1
{
    type            patchInteractionFields;
    resetMode       writeTime;
}

Source files

Definition at line 72 of file PatchInteractionFields.H.

Member Enumeration Documentation

◆ resetMode

enum resetMode

strong

Enumerator
none
timeStep
writeTime

Definition at line 81 of file PatchInteractionFields.H.

Constructor & Destructor Documentation

◆ PatchInteractionFields() [1/2]

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

Definition at line 114 of file PatchInteractionFields.C.

References reset().

Here is the call graph for this function:

◆ PatchInteractionFields() [2/2]

PatchInteractionFields ( const PatchInteractionFields< CloudType > & pii )

Definition at line 139 of file PatchInteractionFields.C.

◆ ~PatchInteractionFields()

virtual ~PatchInteractionFields ( )

virtualdefault

Member Function Documentation

◆ reset()

void reset

protected

Definition at line 73 of file PatchInteractionFields.C.

References Foam::dimless, and Foam::dimMass.

◆ write()

void write

protectedvirtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 81 of file PatchInteractionFields.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and reset().

Here is the call graph for this function:

◆ clearOrReset()

void clearOrReset	(	autoPtr< volScalarField > &	fieldPtr,
		const word &	fieldName,
		const dimensionSet &	dims
	)		const

protected

Definition at line 38 of file PatchInteractionFields.C.

References mesh, Foam::name(), autoPtr::reset(), and Foam::Zero.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "patchInteractionFields" )

◆ clone()

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

inlinevirtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 147 of file PatchInteractionFields.H.

◆ preEvolve()

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

virtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 154 of file PatchInteractionFields.C.

References reset().

Here is the call graph for this function:

◆ postPatch()

void postPatch	(	const parcelType &	p,
		const polyPatch &	pp,
		bool &	keepParticle
	)

virtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 167 of file PatchInteractionFields.C.

References patchIdentifier::index(), p, and polyPatch::whichFace().

Here is the call graph for this function:

Member Data Documentation

◆ resetModeNames_

const Foam::Enum< typename Foam::PatchInteractionFields< CloudType >::resetMode > resetModeNames_

static

Definition at line 88 of file PatchInteractionFields.H.

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

src/lagrangian/intermediate/submodels/CloudFunctionObjects/PatchInteractionFields/PatchInteractionFields.H
src/lagrangian/intermediate/submodels/CloudFunctionObjects/PatchInteractionFields/PatchInteractionFields.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::PatchInteractionFields< CloudType >

Member Enumeration Documentation

◆ resetMode

Constructor & Destructor Documentation

◆ PatchInteractionFields() [1/2]

◆ PatchInteractionFields() [2/2]

◆ ~PatchInteractionFields()

Member Function Documentation

◆ reset()

◆ write()

◆ clearOrReset()

◆ TypeName()

◆ clone()

◆ preEvolve()

◆ postPatch()

Member Data Documentation

◆ resetModeNames_

template<class CloudType>
class Foam::PatchInteractionFields< CloudType >