RemoveParcels< CloudType > Class Template Reference

Removes parcels that hit user-specified face zone faces. More...

Inheritance diagram for RemoveParcels< CloudType >:

Collaboration diagram for RemoveParcels< CloudType >:

Public Member Functions
	TypeName ("removeParcels")
	RemoveParcels (const dictionary &dict, CloudType &owner, const word &modelName)
	RemoveParcels (const RemoveParcels< CloudType > &ppm)
virtual autoPtr< CloudFunctionObject< CloudType > >	clone () const
virtual	~RemoveParcels ()=default
virtual void	postEvolve (const typename parcelType::trackingData &td)
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	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)

Protected Member Functions
void	write ()
Protected Member Functions inherited from subModelBase
bool	inLine () const

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
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::RemoveParcels< CloudType >

Removes parcels that hit user-specified face zone faces.

Example usage:

removeParcels1
{
    type            removeParcels;
    log             yes;
    resetOnWrite    no;
    resetOnStart    no;
    faceZones       (cycLeft cycRight);
}

Source files

• RemoveParcels.H
• RemoveParcels.C

Definition at line 64 of file RemoveParcels.H.

Constructor & Destructor Documentation

RemoveParcels() [1/2]

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

Definition at line 143 of file RemoveParcels.C.

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

Here is the call graph for this function:

RemoveParcels() [2/2]

RemoveParcels

(

const RemoveParcels< CloudType > &

ppm

)

Definition at line 226 of file RemoveParcels.C.

~RemoveParcels()

virtual ~RemoveParcels ( )

virtualdefault

Member Function Documentation

write()

void write

protectedvirtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 100 of file RemoveParcels.C.

References Foam::endl(), forAll, Foam::Info, mesh, os(), Foam::returnReduce(), and Time::timeName().

Here is the call graph for this function:

TypeName()

TypeName

(

"removeParcels"

)

clone()

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

inlinevirtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 139 of file RemoveParcels.H.

postEvolve()

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

virtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 73 of file RemoveParcels.C.

References forAll, Foam::Info, mesh, Foam::nl, and Foam::returnReduce().

Here is the call graph for this function:

postFace()

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

virtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 246 of file RemoveParcels.C.

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

Here is the call graph for this function:

---

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

• src/lagrangian/intermediate/submodels/CloudFunctionObjects/RemoveParcels/RemoveParcels.H
• src/lagrangian/intermediate/submodels/CloudFunctionObjects/RemoveParcels/RemoveParcels.C