setWriteIntervalFunctionObject Class Reference

Updates the writeInterval as a Function1 of time. More...

Inheritance diagram for setWriteIntervalFunctionObject:
Collaboration diagram for setWriteIntervalFunctionObject:

Public Member Functions

 TypeName ("setWriteInterval")
 Runtime type information. More...
 
 setWriteIntervalFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from components. More...
 
 setWriteIntervalFunctionObject (const setWriteIntervalFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~setWriteIntervalFunctionObject ()
 
virtual bool read (const dictionary &)
 Read and reset the writeInterval Function1. More...
 
virtual wordList fields () const
 Return the list of fields required. More...
 
virtual bool execute ()
 Reset the writeInterval from the Function1 of time. More...
 
virtual bool write ()
 Do nothing. More...
 
void operator= (const setWriteIntervalFunctionObject &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from functionObject
 ClassName ("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, const Time &runTime)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
 functionObject (const functionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () 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 scalar maxDeltaT () const
 Return the maximum time-step for stable operation. 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< 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...
 
Switch executeAtStart_
 Switch write log to Info. More...
 
- Static Public Attributes inherited from functionObject
static bool postProcess
 Global post-processing mode switch. More...
 
- Protected Attributes inherited from functionObject
const Timetime_
 Reference to time. More...
 

Detailed Description

Updates the writeInterval as a Function1 of time.

If the case is running with userTime specified in controlDict then the write interval values returned by the Function1 are assumed to be in user-time rather than real-time.

Examples of function object specification:

setWriteInterval
{
    type            setWriteInterval;

    libs            ("libutilityFunctionObjects.so");

    writeInterval table
    (
        (0      0.005)
        (0.1    0.005)
        (0.1001 0.01)
        (0.2    0.01)
        (0.2001 0.02)
    );
}

will cause results to be written every 0.005s between 0 and 0.1s, every 0.01s between 0.1 and 0.2s and every 0.02s thereafter.

Source files

Definition at line 77 of file setWriteIntervalFunctionObject.H.

Constructor & Destructor Documentation

◆ setWriteIntervalFunctionObject() [1/2]

setWriteIntervalFunctionObject ( const word name,
const Time runTime,
const dictionary dict 
)

Construct from components.

Definition at line 49 of file setWriteIntervalFunctionObject.C.

References dict, and setWriteIntervalFunctionObject::read().

Here is the call graph for this function:

◆ setWriteIntervalFunctionObject() [2/2]

Disallow default bitwise copy construction.

◆ ~setWriteIntervalFunctionObject()

Definition at line 65 of file setWriteIntervalFunctionObject.C.

Member Function Documentation

◆ TypeName()

TypeName ( "setWriteInterval"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read and reset the writeInterval Function1.

Reimplemented from functionObject.

Definition at line 72 of file setWriteIntervalFunctionObject.C.

References dict, and Function1< Type >::New().

Referenced by setWriteIntervalFunctionObject::setWriteIntervalFunctionObject().

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

◆ fields()

virtual wordList fields ( ) const
inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 120 of file setWriteIntervalFunctionObject.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Reset the writeInterval from the Function1 of time.

Implements functionObject.

Definition at line 90 of file setWriteIntervalFunctionObject.C.

◆ write()

bool write ( )
virtual

Do nothing.

Implements functionObject.

Definition at line 101 of file setWriteIntervalFunctionObject.C.

◆ operator=()

void operator= ( const setWriteIntervalFunctionObject )
delete

Disallow default bitwise assignment.


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