Performs a file copy/replacement once a specified time has been reached. More...
Public Member Functions | |
TypeName ("timeActivatedFileUpdate") | |
Runtime type information. More... | |
timeActivatedFileUpdate (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
virtual | ~timeActivatedFileUpdate () |
Destructor. More... | |
virtual bool | read (const dictionary &) |
Read the timeActivatedFileUpdate data. More... | |
virtual wordList | fields () const |
Return the list of fields required. More... | |
virtual bool | execute () |
Execute file updates. More... | |
virtual bool | write () |
Do nothing. 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) | |
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 | timeToNextWrite () |
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... | |
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... | |
Performs a file copy/replacement once a specified time has been reached.
Example usage to update the fvSolution dictionary at various times throughout the calculation:
fileUpdate1 { type timeActivatedFileUpdate; libs ("libutilityFunctionObjects.so"); writeControl timeStep; writeInterval 1; fileToUpdate "$FOAM_CASE/system/fvSolution"; timeVsFile ( (-1 "$FOAM_CASE/system/fvSolution.0") (0.10 "$FOAM_CASE/system/fvSolution.10") (0.20 "$FOAM_CASE/system/fvSolution.20") (0.35 "$FOAM_CASE/system/fvSolution.35") ); }
Definition at line 78 of file timeActivatedFileUpdate.H.
timeActivatedFileUpdate | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict | ||
) |
Construct from Time and dictionary.
Definition at line 79 of file timeActivatedFileUpdate.C.
References Foam::read().
|
virtual |
Destructor.
Definition at line 97 of file timeActivatedFileUpdate.C.
References timeActivatedFileUpdate::read().
TypeName | ( | "timeActivatedFileUpdate" | ) |
Runtime type information.
|
virtual |
Read the timeActivatedFileUpdate data.
Reimplemented from functionObject.
Definition at line 104 of file timeActivatedFileUpdate.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::Info, Foam::isFile(), dictionary::lookup(), Foam::nl, Foam::second(), Foam::tab, and Foam::type().
Referenced by timeActivatedFileUpdate::~timeActivatedFileUpdate().
|
inlinevirtual |
Return the list of fields required.
Implements functionObject.
Definition at line 136 of file timeActivatedFileUpdate.H.
References timeActivatedFileUpdate::execute(), List< T >::null(), and timeActivatedFileUpdate::write().
|
virtual |
Execute file updates.
Implements functionObject.
Definition at line 136 of file timeActivatedFileUpdate.C.
Referenced by timeActivatedFileUpdate::fields().
|
virtual |
Do nothing.
Implements functionObject.
Definition at line 144 of file timeActivatedFileUpdate.C.
Referenced by timeActivatedFileUpdate::fields().