PyFoam.Execution.FoamThread module

Thread wrappers for OpenFOAM

class PyFoam.Execution.FoamThread.FoamThread(cmdline, runner)

Bases: Thread

Thread running an OpenFOAM command

The output of the command can be accessed in a thread-safe manner, line by line

Designed to be used by the BasicRunner-class

__init__(cmdline, runner)

:param cmdline:cmdline - Command line of the OpenFOAM command :param runner: the Runner-object that started this thread

__module__ = 'PyFoam.Execution.FoamThread'

check()

Returns:

False if there is no more output of the command

cpuSystemTime()

Returns:

number of seconds CPU-Time used in system mode

cpuTime()

Returns:

number of seconds CPU-Time used

cpuUserTime()

Returns:

number of seconds CPU-Time used in user mode

getLine()

gets the last line from the output

getReturnCode()

interrupt(pass_int=False)

A keyboard-interrupt is reported

read()

read another line from the output

run()

start the command

setState(state, pass_int=False, interrupted=True)

sets the state of the thread (is there any more output)

stopTimer()

usedMemory()

Returns:

maximum resident set size in MegaByte

wallTime()

Returns:

the wall-clock-time needed by the process

PyFoam.Execution.FoamThread.checkForStopFile(thrd)

Checks for the file ‘stop’ in the directory of the FoamRun. If it exists it is removed and the run is stopped gracefully

If a file ‘write’ is found then the next timestep is written

File ‘stopWrite’ stops the run at the next write

‘kill’ stops without writing

PyFoam.Execution.FoamThread.getLinuxMem(thrd)

Reads the Memory usage of a thread on a linux-System

Parameters:

thrd – the thread object in question