Controls the time-step to the minimum nucleation time scale. A specific nucleation model can be specified, otherwise it will scan for and use all the nucleation fvModels in operation. More...
Public Member Functions | |
| TypeName ("adjustTimeStepToNucleation") | |
| Runtime type information. More... | |
| adjustTimeStepToNucleation (const word &name, const Time &runTime, const dictionary &dict) | |
| Construct from components. More... | |
| adjustTimeStepToNucleation (const adjustTimeStepToNucleation &)=delete | |
| Disallow default bitwise copy construction. More... | |
| virtual | ~adjustTimeStepToNucleation () |
| virtual bool | read (const dictionary &) |
| Read and reset the timeStep Function1. More... | |
| virtual wordList | fields () const |
| Return the list of fields required. More... | |
| virtual bool | execute () |
| Do nothing. More... | |
| virtual bool | write () |
| Do nothing. More... | |
| virtual scalar | maxDeltaT () const |
| Return the minimum chemistry.deltaTChem() More... | |
| void | operator= (const adjustTimeStepToNucleation &)=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... | |
| 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 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 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 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... | |
Controls the time-step to the minimum nucleation time scale. A specific nucleation model can be specified, otherwise it will scan for and use all the nucleation fvModels in operation.
Note that this function only does anything if time step adjustment is enabled in the controlDict.
Example of function object specification:
adjustTimeStepToNucleation
{
type adjustTimeStepToNucleation;
libs ("libmultiphaseEulerFunctionObjects.so");
maxCo 0.1;
}
| Property | Description | Required | Default value |
|---|---|---|---|
type | type name: adjustTimeStepToNucleation | yes | |
model | name of the nucleation fvModel | no | |
maxCo | maximum nucleation "Courant" number | no | 1 |
Definition at line 93 of file adjustTimeStepToNucleation.H.
| adjustTimeStepToNucleation | ( | const word & | name, |
| const Time & | runTime, | ||
| const dictionary & | dict | ||
| ) |
Construct from components.
Definition at line 51 of file adjustTimeStepToNucleation.C.
References dict, and adjustTimeStepToNucleation::read().
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Definition at line 68 of file adjustTimeStepToNucleation.C.
| TypeName | ( | "adjustTimeStepToNucleation" | ) |
Runtime type information.
|
virtual |
Read and reset the timeStep Function1.
Reimplemented from objectRegistryFunctionObject.
Definition at line 74 of file adjustTimeStepToNucleation.C.
References dict, and word::null.
Referenced by adjustTimeStepToNucleation::adjustTimeStepToNucleation().
|
inlinevirtual |
Return the list of fields required.
Implements functionObject.
Definition at line 136 of file adjustTimeStepToNucleation.H.
References List< word >::null().
|
virtual |
|
virtual |
|
virtual |
Return the minimum chemistry.deltaTChem()
Reimplemented from functionObject.
Definition at line 99 of file adjustTimeStepToNucleation.C.
References Foam::dimTime, Foam::exit(), Foam::FatalError, forAll, found, Foam::gMin(), mesh, Foam::min(), DimensionedField< Type, GeoMesh, PrimitiveField >::New(), dictionary::New(), word::null, nucleation::tau(), Foam::typedName(), and WarningInFunction.
|
delete |
Disallow default bitwise assignment.
1.9.1