Standard post-processing. More...

Inheritance diagram for PatchPostProcessing< CloudType >:

Collaboration diagram for PatchPostProcessing< CloudType >:

[legend]

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

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

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

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

virtual	~PatchPostProcessing ()
	Destructor. More...

label	maxStoredParcels () const
	Return maximum number of parcels to store per patch. More...

const labelList &	patchIDs () const
	Return const mapping from local to global patch ids. More...

virtual void	postPatch (const parcelType &p, const polyPatch &pp, const scalar trackFraction, const tetIndices &tetIs, 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	~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::particleType	parcelType

Private Member Functions
label	applyToPatch (const label globalPatchI) const
	Returns local patchI if patch is in patchIds_ list. More...

Private Attributes
scalar	maxStoredParcels_
	Maximum number of parcels to store - set as a scalar for I/O. More...

labelList	patchIDs_
	List of patch indices to post-process. More...

List< DynamicList< scalar > >	times_
	List of time for each data record. More...

List< DynamicList< string > >	patchData_
	List of output data per patch. 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::PatchPostProcessing< CloudType >

Standard post-processing.

Source files

Definition at line 49 of file PatchPostProcessing.H.

Member Typedef Documentation

◆ parcelType

typedef CloudType::particleType parcelType

private

Definition at line 55 of file PatchPostProcessing.H.

Constructor & Destructor Documentation

◆ PatchPostProcessing() [1/2]

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

Construct from dictionary.

Definition at line 125 of file PatchPostProcessing.C.

References polyMesh::boundaryMesh(), Foam::endl(), Foam::findStrings(), forAll, forAllReverse, Foam::Info, HashSet< Key, Hash >::insert(), lookup(), DSMCCloud< ParcelType >::mesh(), IOobject::name(), polyBoundaryMesh::names(), HashTable::toc(), and WarningInFunction.

Here is the call graph for this function:

◆ PatchPostProcessing() [2/2]

PatchPostProcessing ( const PatchPostProcessing< CloudType > & ppm )

Construct copy.

Definition at line 174 of file PatchPostProcessing.C.

◆ ~PatchPostProcessing()

~PatchPostProcessing

virtual

Destructor.

Definition at line 189 of file PatchPostProcessing.C.

Member Function Documentation

◆ applyToPatch()

Foam::label applyToPatch ( const label globalPatchI ) const

private

Returns local patchI if patch is in patchIds_ list.

Definition at line 36 of file PatchPostProcessing.C.

References forAll.

◆ write()

void write

protectedvirtual

Write post-processing info.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 55 of file PatchPostProcessing.C.

References forAll, mesh, Foam::mkDir(), Foam::nl, and Foam::sortedOrder().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "patchPostProcessing" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 104 of file PatchPostProcessing.H.

◆ maxStoredParcels()

Foam::label maxStoredParcels

inline

Return maximum number of parcels to store per patch.

Definition at line 27 of file PatchPostProcessingI.H.

◆ patchIDs()

const Foam::labelList & patchIDs

inline

Return const mapping from local to global patch ids.

Definition at line 34 of file PatchPostProcessingI.H.

◆ postPatch()

void postPatch	(	const parcelType &	p,
		const polyPatch &	pp,
		const scalar	trackFraction,
		const tetIndices &	tetIs,
		bool &	keepParticle
	)

virtual

Post-patch hook.

Definition at line 197 of file PatchPostProcessing.C.

References patchIdentifier::index(), and p.

Here is the call graph for this function:

Field Documentation

◆ maxStoredParcels_

scalar maxStoredParcels_

private

Maximum number of parcels to store - set as a scalar for I/O.

Definition at line 58 of file PatchPostProcessing.H.

◆ patchIDs_

labelList patchIDs_

private

List of patch indices to post-process.

Definition at line 61 of file PatchPostProcessing.H.

◆ times_

List<DynamicList<scalar> > times_

private

List of time for each data record.

Definition at line 64 of file PatchPostProcessing.H.

◆ patchData_

List<DynamicList<string> > patchData_

private

List of output data per patch.

Definition at line 67 of file PatchPostProcessing.H.

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

src/lagrangian/intermediate/submodels/CloudFunctionObjects/PatchPostProcessing/PatchPostProcessing.H
src/lagrangian/intermediate/submodels/CloudFunctionObjects/PatchPostProcessing/PatchPostProcessing.C
src/lagrangian/intermediate/submodels/CloudFunctionObjects/PatchPostProcessing/PatchPostProcessingI.H

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::PatchPostProcessing< CloudType >

Member Typedef Documentation

◆ parcelType

Constructor & Destructor Documentation

◆ PatchPostProcessing() [1/2]

◆ PatchPostProcessing() [2/2]

◆ ~PatchPostProcessing()

Member Function Documentation

◆ applyToPatch()

◆ write()

◆ TypeName()

◆ clone()

◆ maxStoredParcels()

◆ patchIDs()

◆ postPatch()

Field Documentation

◆ maxStoredParcels_

◆ patchIDs_

◆ times_

◆ patchData_

template<class CloudType>
class Foam::PatchPostProcessing< CloudType >