Face zone-based particle interactions. More...

Inheritance diagram for FaceInteraction< CloudType >:

Collaboration diagram for FaceInteraction< CloudType >:

[legend]

Public Types
enum	interactionType { ESCAPE, STICK, REBOUND }

typedef CloudType::parcelType	parcelType

Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType

Public Member Functions
	TypeName ("faceInteraction")

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

	FaceInteraction (const FaceInteraction< CloudType > &ppm)

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

virtual	~FaceInteraction ()=default

virtual void	postFace (const parcelType &p, 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	preEvolve (const typename parcelType::trackingData &td)

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

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

virtual void	postPatch (const parcelType &p, const polyPatch &pp, 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)

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true)

	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true)

	writeFile (const writeFile &wf)

virtual	~writeFile ()=default

virtual bool	read (const dictionary &dict)

virtual OFstream &	file ()

virtual bool	writeToFile () const

virtual bool	canWriteHeader () const

virtual label	charWidth () const

virtual void	writeCommented (Ostream &os, const string &str) const

virtual void	writeTabbed (Ostream &os, const string &str) const

virtual void	writeHeader (Ostream &os, const string &str) const

virtual void	writeCurrentTime (Ostream &os) const

virtual void	writeBreak (Ostream &os) const

template<class Type >
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const

Static Public Attributes
static const Enum< interactionType >	interactionTypeNames_

Static Public Attributes inherited from writeFile
static label	addChars = 8

Protected Member Functions
bool	processParticle (const parcelType &p, const label localZonei)

void	write ()

Protected Member Functions inherited from subModelBase
bool	inLine () const

Protected Member Functions inherited from writeFile
void	initStream (Ostream &os) const

fileName	baseFileDir () const

fileName	baseTimeDir () const

virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const

virtual autoPtr< OFstream >	createFile (const word &name) const

virtual void	resetFile (const word &name)

Omanip< int >	valueWidth (const label offset=0) const

void	operator= (const writeFile &)=delete

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_

Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_

const fileName	prefix_

word	fileName_

autoPtr< OFstream >	filePtr_

label	writePrecision_

bool	writeToFile_

bool	updateHeader_

bool	writtenHeader_

bool	useUserTime_

scalar	startTime_

Detailed Description

template<class CloudType>
class Foam::FaceInteraction< CloudType >

Face zone-based particle interactions.

faceInteraction1
{
    type            faceInteraction;

    // List of (faceZone interactionType)
    faceZones
    (
        (faceZone1      stick)
        (faceZone2      escape)
        (faceZone3      rebound)
    );

    // Optional limiting to diameter range
    dMin            0;
    dMax            1;

    writeToFile     yes; // default = yes
}

File written per faceZone as:

postProcessing/lagrangian/cloudName/modelName/time/modelName_faceZone.dat

Source files

Definition at line 77 of file FaceInteraction.H.

Member Typedef Documentation

◆ parcelType

typedef CloudType::parcelType parcelType

Definition at line 87 of file FaceInteraction.H.

Member Enumeration Documentation

◆ interactionType

enum interactionType

strong

Enumerator
ESCAPE	particles escape/are removed
STICK	particles stick to the faceZone faces
REBOUND	particles rebound from the faceZone faces

Definition at line 90 of file FaceInteraction.H.

Constructor & Destructor Documentation

◆ FaceInteraction() [1/2]

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

Definition at line 129 of file FaceInteraction.C.

References Foam::endl(), polyMesh::faces(), polyMesh::faceZones(), ZoneMesh::findZoneID(), Foam::Info, DSMCCloud< ParcelType >::mesh(), Foam::nl, points, polyMesh::points(), reduce(), Foam::returnReduce(), WarningInFunction, Foam::Zero, and zoneIDs.

Here is the call graph for this function:

◆ FaceInteraction() [2/2]

FaceInteraction ( const FaceInteraction< CloudType > & ppm )

Definition at line 239 of file FaceInteraction.C.

◆ ~FaceInteraction()

virtual ~FaceInteraction ( )

virtualdefault

Member Function Documentation

◆ processParticle()

bool processParticle	(	const parcelType &	p,
		const label	localZonei
	)

protected

Definition at line 40 of file FaceInteraction.C.

References p.

◆ write()

void write

protectedvirtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 61 of file FaceInteraction.C.

References Foam::endl(), forAll, Foam::Info, mesh, Foam::nl, nZones, os(), Foam::returnReduce(), Foam::tab, and Foam::Zero.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "faceInteraction" )

◆ clone()

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

inlinevirtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 164 of file FaceInteraction.H.

◆ postFace()

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

virtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 260 of file FaceInteraction.C.

References Foam::abort(), f(), polyMesh::faces(), polyMesh::faceZones(), Foam::FatalError, FatalErrorInFunction, forAll, mesh, DSMCCloud< ParcelType >::mesh(), n, p, points, and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

◆ interactionTypeNames_

const Foam::Enum< typename Foam::FaceInteraction< CloudType >::interactionType > interactionTypeNames_

static

Definition at line 98 of file FaceInteraction.H.

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

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::FaceInteraction< CloudType >

Member Typedef Documentation

◆ parcelType

Member Enumeration Documentation

◆ interactionType

Constructor & Destructor Documentation

◆ FaceInteraction() [1/2]

◆ FaceInteraction() [2/2]

◆ ~FaceInteraction()

Member Function Documentation

◆ processParticle()

◆ write()

◆ TypeName()

◆ clone()

◆ postFace()

Member Data Documentation

◆ interactionTypeNames_

template<class CloudType>
class Foam::FaceInteraction< CloudType >