Records particle face quantities on used-specified face zone. More...

Inheritance diagram for FacePostProcessing< CloudType >:

Collaboration diagram for FacePostProcessing< CloudType >:

[legend]

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

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

	FacePostProcessing (const FacePostProcessing< CloudType > &ppm)
	Construct copy. More...

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

virtual	~FacePostProcessing ()
	Destructor. More...

const Switch &	resetOnWrite () const
	Return const access to the reset on write flag. More...

virtual void	postFace (const parcelType &p, const label faceI, 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	~CloudFunctionObject ()
	Destructor. More...

virtual void	preEvolve ()
	Pre-evolve hook. More...

virtual void	postEvolve ()
	Post-evolve hook. More...

virtual void	postMove (typename CloudType::parcelType &p, const label cellI, const scalar dt, const point &position0, bool &keepParticle)
	Post-move hook. More...

virtual void	postPatch (const typename CloudType::parcelType &p, const polyPatch &pp, const scalar trackFraction, const tetIndices &testIs, bool &keepParticle)
	Post-patch hook. More...

virtual void	postFace (const typename CloudType::parcelType &p, const label faceI, bool &keepParticle)
	Post-face hook. More...

const fileName &	outputDir () const
	Return the output path. More...

fileName	outputTimeDir () 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	outputTime () const
	Flag to indicate when to write a property. 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 dependant sub-model fields. More...

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< 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...

template<class Type >
void	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=pTraits< 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...

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...

Private Types
typedef CloudType::parcelType	parcelType
	Convenience typedef for parcel type. More...

Private Member Functions
void	makeLogFile (const word &zoneName, const label zoneI, const label nFaces, const scalar totArea)
	Helper function to create log files. More...

Private Attributes
labelList	faceZoneIDs_
	Face zone IDs. More...

const word	surfaceFormat_
	Surface output format. More...

Switch	resetOnWrite_
	Flag to indicate whether data should be reset/cleared on writing. More...

scalar	totalTime_
	Total time. More...

List< scalarField >	mass_
	Mass storage. More...

List< scalarField >	massTotal_
	Mass total storage. More...

List< scalarField >	massFlowRate_
	Mass flow rate storage. More...

Switch	log_
	Flag to indicate whether data should be written to file. More...

PtrList< OFstream >	outputFilePtr_
	Output file pointer per zone. More...

scalar	timeOld_
	Last calculation time. 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 >
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::FacePostProcessing< CloudType >

Records particle face quantities on used-specified face zone.

Currently supports: accummulated mass average mass flux

Source files

Definition at line 54 of file FacePostProcessing.H.

Member Typedef Documentation

◆ parcelType

typedef CloudType::parcelType parcelType

private

Convenience typedef for parcel type.

Definition at line 63 of file FacePostProcessing.H.

Constructor & Destructor Documentation

◆ FacePostProcessing() [1/2]

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

Construct from dictionary.

Definition at line 252 of file FacePostProcessing.C.

References DynamicList::append(), GeometricField::boundaryField(), polyMesh::boundaryMesh(), polyMesh::faceZones(), ZoneMesh::findZoneID(), forAll, Foam::Info, lookup(), fvMesh::magSf(), DSMCCloud< ParcelType >::mesh(), primitiveMesh::nInternalFaces(), Foam::nl, polyBoundaryMesh::patchID(), Foam::returnReduce(), List::size(), and polyPatch::whichFace().

Here is the call graph for this function:

◆ FacePostProcessing() [2/2]

FacePostProcessing ( const FacePostProcessing< CloudType > & ppm )

Construct copy.

Definition at line 335 of file FacePostProcessing.C.

◆ ~FacePostProcessing()

~FacePostProcessing

virtual

Destructor.

Definition at line 356 of file FacePostProcessing.C.

Member Function Documentation

◆ makeLogFile()

void makeLogFile	(	const word &	zoneName,
		const label	zoneI,
		const label	nFaces,
		const scalar	totArea
	)

private

Helper function to create log files.

Definition at line 36 of file FacePostProcessing.C.

References Foam::endl(), Foam::Info, Foam::mkDir(), Foam::nl, Foam::tab, and Foam::type().

Here is the call graph for this function:

◆ write()

void write

protectedvirtual

Write post-processing info.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 78 of file FacePostProcessing.C.

References Foam::DelaunayMeshTools::allPoints(), Foam::constant::atomic::alpha, beta(), Foam::endl(), forAll, Foam::Info, Foam::inplaceRenumber(), mesh, zone::name(), Foam::compressible::New(), Foam::nl, Foam::sum(), Time::timeName(), Foam::type(), dimensioned::value(), and writer< Type >::write().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "facePostProcessing" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 137 of file FacePostProcessing.H.

◆ resetOnWrite()

const Foam::Switch & resetOnWrite

inline

Return const access to the reset on write flag.

Definition at line 28 of file FacePostProcessingI.H.

◆ postFace()

void postFace	(	const parcelType &	p,
		const label	faceI,
		bool &	keepParticle
	)

virtual

Post-face hook.

Definition at line 364 of file FacePostProcessing.C.

References faceId(), polyMesh::faceZones(), forAll, DSMCCloud< ParcelType >::mesh(), and p.

Here is the call graph for this function:

Field Documentation

◆ faceZoneIDs_

labelList faceZoneIDs_

private

Face zone IDs.

Definition at line 67 of file FacePostProcessing.H.

◆ surfaceFormat_

const word surfaceFormat_

private

Surface output format.

Definition at line 70 of file FacePostProcessing.H.

◆ resetOnWrite_

Switch resetOnWrite_

private

Flag to indicate whether data should be reset/cleared on writing.

Definition at line 73 of file FacePostProcessing.H.

◆ totalTime_

scalar totalTime_

private

Total time.

Definition at line 76 of file FacePostProcessing.H.

◆ mass_

List<scalarField> mass_

private

Mass storage.

Definition at line 79 of file FacePostProcessing.H.

◆ massTotal_

List<scalarField> massTotal_

private

Mass total storage.

Definition at line 82 of file FacePostProcessing.H.

◆ massFlowRate_

List<scalarField> massFlowRate_

private

Mass flow rate storage.

Definition at line 85 of file FacePostProcessing.H.

◆ log_

Switch log_

private

Flag to indicate whether data should be written to file.

Definition at line 88 of file FacePostProcessing.H.

◆ outputFilePtr_

PtrList<OFstream> outputFilePtr_

private

Output file pointer per zone.

Definition at line 91 of file FacePostProcessing.H.

◆ timeOld_

scalar timeOld_

private

Last calculation time.

Definition at line 94 of file FacePostProcessing.H.

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

src/lagrangian/intermediate/submodels/CloudFunctionObjects/FacePostProcessing/FacePostProcessing.H
src/lagrangian/intermediate/submodels/CloudFunctionObjects/FacePostProcessing/FacePostProcessing.C
src/lagrangian/intermediate/submodels/CloudFunctionObjects/FacePostProcessing/FacePostProcessingI.H

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::FacePostProcessing< CloudType >

Member Typedef Documentation

◆ parcelType

Constructor & Destructor Documentation

◆ FacePostProcessing() [1/2]

◆ FacePostProcessing() [2/2]

◆ ~FacePostProcessing()

Member Function Documentation

◆ makeLogFile()

◆ write()

◆ TypeName()

◆ clone()

◆ resetOnWrite()

◆ postFace()

Field Documentation

◆ faceZoneIDs_

◆ surfaceFormat_

◆ resetOnWrite_

◆ totalTime_

◆ mass_

◆ massTotal_

◆ massFlowRate_

◆ log_

◆ outputFilePtr_

◆ timeOld_

template<class CloudType>
class Foam::FacePostProcessing< CloudType >