timeActivatedFileUpdate Class Reference

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

Inheritance diagram for timeActivatedFileUpdate:

Collaboration diagram for timeActivatedFileUpdate:

Public Member Functions
	TypeName ("timeActivatedFileUpdate")
	timeActivatedFileUpdate (const word &name, const Time &runTime, const dictionary &dict)
virtual	~timeActivatedFileUpdate ()=default
virtual bool	read (const dictionary &)
virtual bool	execute ()
virtual bool	write ()
virtual bool	filesModified () const
Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
virtual	~timeFunctionObject ()=default
const Time &	time () const
objectRegistry &	storedObjects ()
const objectRegistry &	storedObjects () const
Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
autoPtr< functionObject >	clone () const
virtual	~functionObject ()=default
virtual const word &	type () const =0
const word &	name () const noexcept
bool	useNamePrefix () const noexcept
bool	useNamePrefix (bool on) noexcept
virtual bool	execute (const label subIndex)
virtual bool	end ()
virtual bool	adjustTimeStep ()
virtual void	updateMesh (const mapPolyMesh &mpm)
virtual void	movePoints (const polyMesh &mesh)

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
Public Attributes inherited from functionObject
bool	log
Static Public Attributes inherited from functionObject
static int	debug
static bool	postProcess
static bool	defaultUseNamePrefix
static word	outputPrefix
Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	timeFunctionObject (const timeFunctionObject &)=delete
void	operator= (const timeFunctionObject &)=delete
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
Protected Attributes inherited from timeFunctionObject
const Time &	time_

Detailed Description

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

Usage

Example usage to update the fvSolution dictionary at various times throughout the calculation:

fileUpdate1
{
    type              timeActivatedFileUpdate;
    libs              (utilityFunctionObjects);
    writeControl      timeStep;
    writeInterval     1;
    fileToUpdate      "<system>/fvSolution";
    timeVsFile
    (
        (-1   "<system>/fvSolution.0")
        (0.10 "<system>/fvSolution.10")
        (0.20 "<system>/fvSolution.20")
        (0.35 "<system>/fvSolution.35")
    );
    ...
}

Where the entries comprise:

Property	Description	Required	Default value
type	Type name: timeActivatedFileUpdate	yes
fileToUpdate	Name of file to update	yes
timeVsFile	List of time vs file	yes

Source files

• timeActivatedFileUpdate.H
• timeActivatedFileUpdate.C

Definition at line 109 of file timeActivatedFileUpdate.H.

Constructor & Destructor Documentation

timeActivatedFileUpdate()

timeActivatedFileUpdate	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Definition at line 82 of file timeActivatedFileUpdate.C.

References dict, and Foam::read().

Here is the call graph for this function:

~timeActivatedFileUpdate()

virtual ~timeActivatedFileUpdate ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"timeActivatedFileUpdate"

)

read()

bool read ( const dictionary &  dict )

virtual

Reimplemented from functionObject.

Definition at line 101 of file timeActivatedFileUpdate.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::Info, Foam::isFile(), Foam::name(), Foam::nl, functionObject::read(), Foam::tab, and Foam::type().

Here is the call graph for this function:

execute()

bool execute ( )

virtual

Implements functionObject.

Definition at line 137 of file timeActivatedFileUpdate.C.

write()

bool write ( )

virtual

Implements functionObject.

Definition at line 145 of file timeActivatedFileUpdate.C.

filesModified()

bool filesModified ( ) const

virtual

Reimplemented from functionObject.

Definition at line 151 of file timeActivatedFileUpdate.C.

---

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

• src/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H
• src/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.C