Base class for function objects that refer to an fvMesh and a cloud. Used, for example, to construct and write accumulated cloud properties as finite volume fields. More...
Public Member Functions | |
| TypeName ("cloudFvMeshFunctionObject") | |
| Runtime type information. More... | |
| cloudFvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
| Construct from Time and dictionary. More... | |
| cloudFvMeshFunctionObject (const cloudFvMeshFunctionObject &)=delete | |
| Disallow default bitwise copy construction. More... | |
| virtual | ~cloudFvMeshFunctionObject () |
| Destructor. More... | |
| void | operator= (const cloudFvMeshFunctionObject &)=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) | |
| Construct from the region objectRegistry. More... | |
| fvMeshFunctionObject (const fvMeshFunctionObject &)=delete | |
| Disallow default bitwise copy construction. More... | |
| virtual | ~fvMeshFunctionObject () |
| Destructor. More... | |
| const fvMesh & | mesh () const |
| Return a reference to the mesh. 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) | |
| Construct from the region objectRegistry. 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 objectRegistryFunctionObject | |
| TypeName ("objectRegistryFunctionObject") | |
| Runtime type information. More... | |
| objectRegistryFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
| Construct from an objectRegistry and dictionary. More... | |
| objectRegistryFunctionObject (const word &name, const objectRegistry &obr) | |
| Construct from an objectRegistry. More... | |
| objectRegistryFunctionObject (const objectRegistryFunctionObject &)=delete | |
| Disallow default bitwise copy construction. More... | |
| virtual | ~objectRegistryFunctionObject () |
| Destructor. More... | |
| virtual bool | read (const dictionary &) |
| Read optional controls. More... | |
| void | operator= (const objectRegistryFunctionObject &)=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... | |
| functionObject (const word &name, const Time &runTime, const dictionary &dict) | |
| Construct from dictionary. 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 wordList | fields () const =0 |
| Return the list of fields required. More... | |
| virtual bool | executeAtStart () const |
| Return true if the functionObject should be executed at the start. More... | |
| virtual bool | execute ()=0 |
| Called at each ++ or += of the time-loop. More... | |
| virtual bool | write ()=0 |
| Called at each ++ or += of the time-loop. 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 scalar | maxDeltaT () const |
| Return the maximum time-step for stable operation. 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... | |
| Public Member Functions inherited from cloudFunctionObject | |
| TypeName ("cloudFunctionObject") | |
| Runtime type information. More... | |
| cloudFunctionObject (const LagrangianMeshFunctionObject &) | |
| Construct from a Lagrangian mesh function object. More... | |
| cloudFunctionObject (const fvMeshFunctionObject &, const dictionary &dict) | |
| Construct from an fvMesh function object and a dictionary. More... | |
| cloudFunctionObject (const cloudFunctionObject &)=delete | |
| Disallow default bitwise copy construction. More... | |
| virtual | ~cloudFunctionObject () |
| Destructor. More... | |
| const Foam::cloud & | cloud () const |
| Return the cloud. More... | |
| virtual void | preSolve () |
| Hook before solution steps. More... | |
| virtual void | calculate (const LagrangianSubScalarField &deltaT, const bool final) |
| Solve equations and/or update continually changing properties. More... | |
| virtual void | preCrossFaces (const LagrangianScalarInternalDynamicField &fraction) |
| Hook before all face crossings. More... | |
| virtual void | preCrossFaces (const LagrangianSubScalarSubField &fraction) |
| Hook before face crossings of a specific sub-mesh. More... | |
| virtual void | postCrossFaces (const LagrangianSubScalarSubField &fraction) |
| Hook following face crossings of a specific sub-mesh. More... | |
| virtual void | postCrossFaces (const LagrangianScalarInternalDynamicField &fraction) |
| Hook after all face crossings. More... | |
| virtual void | postSolve () |
| Hook following solution steps. More... | |
| void | operator= (const cloudFunctionObject &)=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 execute at start time. More... | |
| Static Public Attributes inherited from functionObject | |
| static bool | postProcess |
| Global post-processing mode switch. More... | |
| Protected Member Functions inherited from objectRegistryFunctionObject | |
| 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... | |
| void | cannotFindObjects (const wordList &fieldNames) |
| Prints a warning message that fieldNames 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 > | |
| ObjectType & | store (const tmp< ObjectType > &tfield) |
| Store the given field in the objectRegistry. More... | |
| template<class ObjectType > | |
| ObjectType & | 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 Member Functions inherited from cloudFunctionObject | |
| template<class Cloud > | |
| bool | isCloud () const |
| Determine whether the cloud is of the given type. More... | |
| template<class Cloud = Foam::cloud> | |
| const Cloud & | cloud () const |
| Get a reference to the cloud. More... | |
| Protected Attributes inherited from fvMeshFunctionObject | |
| const fvMesh & | mesh_ |
| Reference to the fvMesh. More... | |
| Protected Attributes inherited from objectRegistryFunctionObject | |
| const objectRegistry & | obr_ |
| Reference to the objectRegistry. More... | |
| Protected Attributes inherited from functionObject | |
| const Time & | time_ |
| Reference to time. More... | |
Base class for function objects that refer to an fvMesh and a cloud. Used, for example, to construct and write accumulated cloud properties as finite volume fields.
Definition at line 53 of file cloudFvMeshFunctionObject.H.
| cloudFvMeshFunctionObject | ( | const word & | name, |
| const Time & | runTime, | ||
| const dictionary & | dict | ||
| ) |
Construct from Time and dictionary.
Definition at line 41 of file cloudFvMeshFunctionObject.C.
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Destructor.
Definition at line 55 of file cloudFvMeshFunctionObject.C.
| TypeName | ( | "cloudFvMeshFunctionObject" | ) |
Runtime type information.
|
delete |
Disallow default bitwise assignment.
1.9.1 
