Public Member Functions | List of all members
timeActivatedFileUpdate Class Reference

Performs a file copy/replacement once a specified time has been reached. More...

Inheritance diagram for timeActivatedFileUpdate:
Inheritance graph
[legend]
Collaboration diagram for timeActivatedFileUpdate:
Collaboration graph
[legend]

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 bool execute ()
 Execute file updates. More...
 
virtual bool write ()
 Do nothing. More...
 
- Public Member Functions inherited from functionObject
virtual const wordtype () 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< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () 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< functionObjectNew (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...
 

Detailed Description

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")
    );
}
Source files

Definition at line 76 of file timeActivatedFileUpdate.H.

Constructor & Destructor Documentation

◆ timeActivatedFileUpdate()

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().

Here is the call graph for this function:

◆ ~timeActivatedFileUpdate()

Destructor.

Definition at line 97 of file timeActivatedFileUpdate.C.

References timeActivatedFileUpdate::read().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "timeActivatedFileUpdate"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
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::tab, and Foam::type().

Referenced by timeActivatedFileUpdate::~timeActivatedFileUpdate().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ execute()

bool execute ( )
virtual

Execute file updates.

Implements functionObject.

Definition at line 136 of file timeActivatedFileUpdate.C.

◆ write()

bool write ( )
virtual

Do nothing.

Implements functionObject.

Definition at line 144 of file timeActivatedFileUpdate.C.


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