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 class	resetMode { none , timeStep , writeTime }
	Reset mode. More...

Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for. More...

Public Member Functions
	TypeName ("patchInteractionFields")
	Runtime type information. More...

	PatchInteractionFields (const dictionary &dict, CloudType &owner, const word &modelName)
	Construct from dictionary. More...

	PatchInteractionFields (const PatchInteractionFields< CloudType > &pii)
	Construct copy. More...

virtual autoPtr< CloudFunctionObject< CloudType > >	clone () const
	Construct and return a clone. More...

virtual	~PatchInteractionFields ()=default
	Destructor. More...

virtual void	preEvolve (const typename parcelType::trackingData &td)
	Pre-evolve hook. More...

virtual void	postPatch (const parcelType &p, const polyPatch &pp, bool &keepParticle)
	Post-patch 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 fileName &	outputDir () 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 CloudType &	owner () 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...

CloudType &	owner ()
	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 word &	modelName () const
	Return const access to the name of the sub-model. More...

const dictionary &	dict () const
	Return const access to the cloud dictionary. More...

const word &	baseName () const
	Return const access to the base name of the sub-model. More...

const word &	modelType () const
	Return const access to the sub-model type. More...

const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary. More...

const dictionary &	properties () 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...

Static Public Attributes
static const Enum< resetMode >	resetModeNames_

Protected Member Functions
void	reset ()
	Create\|read\|reset the fields. More...

virtual void	write ()
	Write post-processing info. More...

void	clearOrReset (autoPtr< volScalarField > &fieldPtr, const word &fieldName, const dimensionSet &dims) const
	Helper function to clear or reset fields. More...

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

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)
	Selector. More...

Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud. More...

Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model. More...

dictionary &	properties_
	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::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 76 of file PatchInteractionFields.H.

Member Enumeration Documentation

◆ resetMode

enum class resetMode

strong

Reset mode.

Enumerator
none
timeStep
writeTime

Definition at line 85 of file PatchInteractionFields.H.

Constructor & Destructor Documentation

◆ PatchInteractionFields() [1/2]

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

Construct from dictionary.

Definition at line 120 of file PatchInteractionFields.C.

References PatchInteractionFields< CloudType >::reset().

Here is the call graph for this function:

◆ PatchInteractionFields() [2/2]

PatchInteractionFields ( const PatchInteractionFields< CloudType > & pii )

Construct copy.

Definition at line 145 of file PatchInteractionFields.C.

◆ ~PatchInteractionFields()

virtual ~PatchInteractionFields ( )

virtualdefault

Destructor.

Member Function Documentation

◆ reset()

void reset

protected

Create|read|reset the fields.

Definition at line 80 of file PatchInteractionFields.C.

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

Referenced by PatchInteractionFields< CloudType >::PatchInteractionFields().

Here is the caller graph for this function:

◆ write()

void write

protectedvirtual

Write post-processing info.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 88 of file PatchInteractionFields.C.

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

Here is the call graph for this function:

◆ clearOrReset()

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

protected

Helper function to clear or reset fields.

Definition at line 44 of file PatchInteractionFields.C.

References mesh, Foam::name(), and autoPtr< T >::reset().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "patchInteractionFields" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 151 of file PatchInteractionFields.H.

◆ preEvolve()

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

virtual

Pre-evolve hook.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 160 of file PatchInteractionFields.C.

◆ postPatch()

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

virtual

Post-patch hook.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 173 of file PatchInteractionFields.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), 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 92 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

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_