Public Member Functions | List of all members
timeActivatedFileUpdate Class Reference

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 objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~timeActivatedFileUpdate ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the set of timeActivatedFileUpdate. More...
 
virtual void read (const dictionary &)
 Read the timeActivatedFileUpdate data. More...
 
virtual void execute ()
 Execute, currently does nothing. More...
 
virtual void end ()
 Execute at the final time-loop, currently does nothing. More...
 
virtual void timeSet ()
 Called when time was set at the end of the Time::operator++. More...
 
virtual void write ()
 Calculate the timeActivatedFileUpdate and write. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &)
 Update for changes of mesh. 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;
    functionObjectLibs ("libutilityFunctionObjects.so");
    outputControl     timeStep;
    outputInterval    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 79 of file timeActivatedFileUpdate.H.

Constructor & Destructor Documentation

timeActivatedFileUpdate ( const word name,
const objectRegistry obr,
const dictionary dict,
const bool  loadFromFiles = false 
)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 67 of file timeActivatedFileUpdate.C.

References Foam::read().

Here is the call graph for this function:

Destructor.

Definition at line 87 of file timeActivatedFileUpdate.C.

Member Function Documentation

TypeName ( "timeActivatedFileUpdate"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual
void read ( const dictionary dict)
virtual

Read the timeActivatedFileUpdate data.

Definition at line 93 of file timeActivatedFileUpdate.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, forAll, Foam::Info, Foam::isFile(), dictionary::lookup(), Foam::nl, Foam::tab, and Foam::type().

Referenced by timeActivatedFileUpdate::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void execute ( )
virtual

Execute, currently does nothing.

Definition at line 124 of file timeActivatedFileUpdate.C.

Referenced by timeActivatedFileUpdate::name().

Here is the caller graph for this function:

void end ( )
virtual

Execute at the final time-loop, currently does nothing.

Definition at line 133 of file timeActivatedFileUpdate.C.

Referenced by timeActivatedFileUpdate::name().

Here is the caller graph for this function:

void timeSet ( )
virtual

Called when time was set at the end of the Time::operator++.

Definition at line 142 of file timeActivatedFileUpdate.C.

Referenced by timeActivatedFileUpdate::name().

Here is the caller graph for this function:

void write ( )
virtual

Calculate the timeActivatedFileUpdate and write.

Definition at line 148 of file timeActivatedFileUpdate.C.

Referenced by timeActivatedFileUpdate::name().

Here is the caller graph for this function:

virtual void updateMesh ( const mapPolyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 161 of file timeActivatedFileUpdate.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 165 of file timeActivatedFileUpdate.H.


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