This functionObject tracks a uncoupled kinematic particle cloud in the specified velocity field of an incompressible flow (laminar, RANS or LES). More...
Public Member Functions | |
TypeName ("icoUncoupledKinematicCloud") | |
Runtime type information. More... | |
icoUncoupledKinematicCloud (const word &name, const Time &runTime, const dictionary &dict) | |
Construct for given objectRegistry and dictionary. More... | |
virtual | ~icoUncoupledKinematicCloud () |
Destructor. More... | |
virtual bool | read (const dictionary &) |
Read the controls. More... | |
virtual bool | execute () |
Track the cloud. More... | |
virtual bool | write () |
Write the cloud. 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... | |
virtual | ~fvMeshFunctionObject () |
Destructor. 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... | |
virtual | ~regionFunctionObject () |
Destructor. More... | |
Public Member Functions inherited from 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) | |
Construct from components. More... | |
autoPtr< functionObject > | clone () const |
Return clone. More... | |
virtual | ~functionObject () |
Destructor. More... | |
const word & | name () const |
Return the name of this functionObject. More... | |
virtual bool | end () |
Called when Time::run() determines that the time-loop exits. More... | |
virtual bool | setTimeStep () |
Called by Time::setDeltaT(). Allows the function object to override. More... | |
virtual scalar | timeToNextWrite () |
Called by Time::adjustTimeStep(). Allows the function object to. More... | |
virtual void | updateMesh (const mapPolyMesh &mpm) |
Update for changes of mesh. More... | |
virtual void | movePoints (const polyMesh &mesh) |
Update for changes of mesh. 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... | |
Static Public Attributes inherited from functionObject | |
static int | debug |
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 > | |
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 (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 Time & | time_ |
Reference to the Time. More... | |
const objectRegistry & | obr_ |
Reference to the region objectRegistry. More... | |
This functionObject tracks a uncoupled kinematic 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 solver such as pisoFoam or pimpleFoam and tracks the particles or parcels without affecting the flow-field.
The kinematicCloud requires the density of the fluid which is looked-up from constant/transportProperties dictionary and the acceleration due to gravity which is read from the constant/g file if present or defaults to zero.
The kinematicCloud properties are read from the constant/kinematicCloudProperties dictionary in the usual manner.
Example of function object specification:
tracks { libs ("liblagrangianFunctionObjects.so"); type icoUncoupledKinematicCloud; }
Property | Description | Required | Default value |
---|---|---|---|
type | Type name: icoUncoupledKinematicCloud | yes | |
U | Name of the velocity field | no | U |
kinematicCloud | Name of the kinematicCloud | no | kinematicCloud |
Definition at line 109 of file icoUncoupledKinematicCloud.H.
icoUncoupledKinematicCloud | ( | 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 50 of file icoUncoupledKinematicCloud.C.
|
virtual |
Destructor.
Definition at line 112 of file icoUncoupledKinematicCloud.C.
References icoUncoupledKinematicCloud::read().
TypeName | ( | "icoUncoupledKinematicCloud" | ) |
Runtime type information.
|
virtual |
Read the controls.
Reimplemented from regionFunctionObject.
Definition at line 119 of file icoUncoupledKinematicCloud.C.
References regionFunctionObject::read().
Referenced by icoUncoupledKinematicCloud::~icoUncoupledKinematicCloud().
|
virtual |
Track the cloud.
Implements functionObject.
Definition at line 129 of file icoUncoupledKinematicCloud.C.
|
virtual |
Write the cloud.
Implements functionObject.
Definition at line 138 of file icoUncoupledKinematicCloud.C.