This functionObject tracks a particle cloud in the specified velocity field of an incompressible flow (laminar, RANS or LES). More...

Inheritance diagram for particles:

[legend]

Collaboration diagram for particles:

[legend]

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

	particles (const word &name, const Time &runTime, const dictionary &dict)
	Construct for given objectRegistry and dictionary. More...

	particles (const particles &)=delete
	Disallow default bitwise copy construction. More...

virtual	~particles ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read the controls. More...

virtual wordList	fields () const
	Return the list of fields required. More...

virtual bool	execute ()
	Track the cloud. More...

virtual bool	write ()
	Write the cloud. More...

void	operator== (const particles &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	Runtime type information. More...

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvMeshFunctionObject ()
	Destructor. More...

void	operator= (const fvMeshFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information. More...

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

void	operator= (const regionFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const Time &runTime)
	Construct from components. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. More...

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual scalar	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual void	movePoints (const polyMesh &mesh)
	Update topology using the given map. More...

virtual void	topoChange (const polyTopoChangeMap &map)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

void	operator= (const functionObject &)=delete
	Disallow default bitwise assignment. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &, const dictionary &)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Switch	executeAtStart_
	Switch write log to Info. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
bool	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
bool	store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the given field in the objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the objectRegistry if present. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. More...

Detailed Description

This functionObject tracks a particle cloud in the specified velocity field of an incompressible flow (laminar, RANS or LES).

It may be used in conjunction with any transient single-phase incompressible flow solvers or solver modules such as incompressibleFluid and tracks the particles or parcels without affecting the flow-field.

The cloud requires the density of the fluid which is looked-up from constant/phaseProperties dictionary and the acceleration due to gravity which is read from the constant/g file if present or defaults to zero.

The cloud properties are read from the constant/<cloudName>Properties dictionary in the usual manner.

Example of function object specification:

    particles
    {
        libs        ("liblagrangianFunctionObjects.so");
        type        particles;
    }

Usage

Property	Description	Required	Default value
`type`	Type name: particles	yes
`U`	Name of the velocity field	no	U
`cloud`	Name of the cloud	no	cloud

See also: Foam::functionObjects::fvMeshFunctionObject

Source files

Definition at line 108 of file particles.H.

Constructor & Destructor Documentation

◆ particles() [1/2]

particles	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 49 of file particles.C.

◆ particles() [2/2]

particles ( const particles & )

delete

Disallow default bitwise copy construction.

◆ ~particles()

~particles ( )

virtual

Destructor.

Definition at line 115 of file particles.C.

Member Function Documentation

◆ TypeName()

TypeName ( "particles" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the controls.

Reimplemented from regionFunctionObject.

Definition at line 121 of file particles.C.

References dict, and regionFunctionObject::read().

Here is the call graph for this function:

◆ fields()

virtual wordList fields ( ) const

inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 170 of file particles.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Track the cloud.

Implements functionObject.

Definition at line 132 of file particles.C.

◆ write()

bool write ( )

virtual

Write the cloud.

Implements functionObject.

Definition at line 142 of file particles.C.

◆ operator==()

void operator== ( const particles & )

delete

Disallow default bitwise assignment.

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

src/lagrangian/functionObjects/particles/particles.H
src/lagrangian/functionObjects/particles/particles.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ particles() [1/2]

◆ particles() [2/2]

◆ ~particles()

Member Function Documentation

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()

◆ operator==()