PyFoam.Infrastructure.FoamServer module

A XMLRPC-Server that answeres about the current state of a Foam-Run

class PyFoam.Infrastructure.FoamServer.FoamAnswerer(run=None, master=None, lines=100, foamserver=None)

Bases: object

The class that handles the actual requests (only needed to hide the Thread-methods from the world

__dict__ = mappingproxy({'__module__': 'PyFoam.Infrastructure.FoamServer', '__doc__': 'The class that handles the actual requests (only needed to hide the\n    Thread-methods from the world\n    ', '__init__': <function FoamAnswerer.__init__>, '_insertLine': <function FoamAnswerer._insertLine>, 'isFoamServer': <function FoamAnswerer.isFoamServer>, 'isLiving': <function FoamAnswerer.isLiving>, '_kill': <function FoamAnswerer._kill>, 'stop': <function FoamAnswerer.stop>, 'stopAtNextWrite': <function FoamAnswerer.stopAtNextWrite>, 'write': <function FoamAnswerer.write>, 'argv': <function FoamAnswerer.argv>, 'usedArgv': <function FoamAnswerer.usedArgv>, 'isParallel': <function FoamAnswerer.isParallel>, 'procNr': <function FoamAnswerer.procNr>, 'nrWarnings': <function FoamAnswerer.nrWarnings>, 'commandLine': <function FoamAnswerer.commandLine>, 'actualCommandLine': <function FoamAnswerer.actualCommandLine>, 'scriptName': <function FoamAnswerer.scriptName>, 'runnerData': <function FoamAnswerer.runnerData>, 'lastLogLineSeen': <function FoamAnswerer.lastLogLineSeen>, 'lastTimeStepSeen': <function FoamAnswerer.lastTimeStepSeen>, 'lastLine': <function FoamAnswerer.lastLine>, 'tail': <function FoamAnswerer.tail>, 'elapsedTime': <function FoamAnswerer.elapsedTime>, 'getEnviron': <function FoamAnswerer.getEnviron>, 'mpi': <function FoamAnswerer.mpi>, 'foamVersion': <function FoamAnswerer.foamVersion>, 'pyFoamVersion': <function FoamAnswerer.pyFoamVersion>, 'uname': <function FoamAnswerer.uname>, 'ip': <function FoamAnswerer.ip>, 'hostname': <function FoamAnswerer.hostname>, 'configuration': <function FoamAnswerer.configuration>, 'cwd': <function FoamAnswerer.cwd>, 'pid': <function FoamAnswerer.pid>, 'loadAvg': <function FoamAnswerer.loadAvg>, 'user': <function FoamAnswerer.user>, 'id': <function FoamAnswerer.id>, 'startTimestamp': <function FoamAnswerer.startTimestamp>, 'time': <function FoamAnswerer.time>, 'createTime': <function FoamAnswerer.createTime>, '_readParameter': <function FoamAnswerer._readParameter>, 'startTime': <function FoamAnswerer.startTime>, 'endTime': <function FoamAnswerer.endTime>, 'deltaT': <function FoamAnswerer.deltaT>, 'pathToSolution': <function FoamAnswerer.pathToSolution>, 'writtenTimesteps': <function FoamAnswerer.writtenTimesteps>, 'solutionFiles': <function FoamAnswerer.solutionFiles>, 'listFiles': <function FoamAnswerer.listFiles>, 'getDictionaryText': <function FoamAnswerer.getDictionaryText>, 'getDictionaryContents': <function FoamAnswerer.getDictionaryContents>, 'writeDictionaryText': <function FoamAnswerer.writeDictionaryText>, 'writeDictionaryContents': <function FoamAnswerer.writeDictionaryContents>, 'getPlots': <function FoamAnswerer.getPlots>, 'getPlotData': <function FoamAnswerer.getPlotData>, 'controlDictUnmodified': <function FoamAnswerer.controlDictUnmodified>, 'getRemark': <function FoamAnswerer.getRemark>, 'setRemark': <function FoamAnswerer.setRemark>, 'jobId': <function FoamAnswerer.jobId>, '__dict__': <attribute '__dict__' of 'FoamAnswerer' objects>, '__weakref__': <attribute '__weakref__' of 'FoamAnswerer' objects>, '__annotations__': {}})

__init__(run=None, master=None, lines=100, foamserver=None)

Parameters:

• run – The thread that controls the run

• master – The Runner-Object that controls everything

• lines – the number of lines the server should remember

__module__ = 'PyFoam.Infrastructure.FoamServer'

__weakref__

list of weak references to the object (if defined)

_insertLine(line)

Inserts a new line, not to be called via XMLRPC

_kill()

Interrupts the FOAM-process

_readParameter(name)

Reads a parametr from the controlDict :param name: the parameter :return: The value

actualCommandLine()

The actual command line used

argv()

Argument vector with which the runner was called

commandLine()

The command line

configuration()

Returns:

all the configured parameters

controlDictUnmodified()

Checks whether there is a pending change to the controlDict

createTime()

Returns:

the time in the simulation for which the mesh was created

cwd()

Returns:

the current working directory

deltaT()

Returns:

parameter startTime from the controlDict

elapsedTime()

Returns:

time in seconds since the last line was output

endTime()

Returns:

parameter endTime from the controlDict

foamVersion()

Version number of the Foam-Version

getDictionaryContents(directory, name)

Parameters:

• directory – Sub-directory of the case

• name – name of the dictionary file

Returns:

the contents of the file as a python data-structure

getDictionaryText(directory, name)

Parameters:

• directory – Sub-directory of the case

• name – name of the dictionary file

Returns:

the contents of the file as a big string

getEnviron(name)

Parameters:

name – name of an environment variable

Returns:

value of the variable, empty string if non-existing

getPlotData()

Get all the data for the plots

getPlots()

Get all the information about the plots

getRemark()

Get the user-defined remark for this job

hostname()

Returns:

The name of the computer

id()

Returns:

an ID for this run: IP:port:startTimestamp

ip()

Returns:

the ip of this machine

isFoamServer()

This is a Foam-Server (True by default)

isLiving()

The calculation still generates output and therefor seems to be living

isParallel()

Is it a parallel run?

jobId()

Return the job-ID of the queuing-system. Empty if unset

lastLine()

Returns:

the last line that was output by the running FOAM-process

lastLogLineSeen()

Returns:

the time at which the last log-line was seen

lastTimeStepSeen()

Returns:

the time at which the last log-line was seen

listFiles(directory)

Parameters:

directory – Sub-directory of the case

Returns:

List of the filenames (not directories) in that case

loadAvg()

Returns:

a tuple with the average loads of the last 1, 5 and 15 minutes

mpi()

Returns:

name of the MPI-implementation

nrWarnings()

Number of warnings the executable emitted

pathToSolution()

Returns:

the path to the solution directory

pid()

Returns:

the PID of the script

procNr()

How many processors are used?

pyFoamVersion()

Returns:

Version number of the PyFoam

runnerData()

Returns:

the data the runner collected so far

scriptName()

Name of the Python-Script that runs the show

setRemark(remark)

Overwrite the user-defined remark :return: True if the remark was set previously

solutionFiles(time)

Parameters:

time – name of the timestep

Returns:

list of the solution files at that timestep

startTime()

Returns:

parameter startTime from the controlDict

startTimestamp()

Returns:

the unix-timestamp of the process start

stop()

Stops the run gracefully (after writing the last time-step to disk)

stopAtNextWrite()

Stops the run gracefully the next time data is written to disk

tail()

Returns:

the current last lines as a string

time()

Returns:

the current time in the simulation

uname()

Returns:

the complete uname-information

usedArgv()

Argument vector with which the runner started the run

user()

Returns:

the user that runs this script

write()

Makes the program write the next time-step to disk and the continue

writeDictionaryContents(directory, name, contents)

Writes the contents of a dictionary :param directory: Sub-directory of the case :param name: name of the dictionary file :param contents: Python-dictionary with the dictionary contents

writeDictionaryText(directory, name, text)

Writes the contents of a dictionary :param directory: Sub-directory of the case :param name: name of the dictionary file :param text: String with the dictionary contents

writtenTimesteps()

Returns:

list of the timesteps on disc

class PyFoam.Infrastructure.FoamServer.FoamServer(run=None, master=None, lines=100)

Bases: Thread

This is the class that serves the requests about the FOAM-Run

__annotations__ = {}

__init__(run=None, master=None, lines=100)

Parameters:

• run – The thread that controls the run

• master – The Runner-Object that controls everything

• lines – the number of lines the server should remember

__module__ = 'PyFoam.Infrastructure.FoamServer'

_insertLine(line)

Inserts a new line, not to be called via XMLRPC

deregister()

Tries to deregister with the Meta-Server

info()

Returns the IP, the PID and the port of the server (as one tuple)

kill()

Interrupts the FOAM-process (and kills the server)

killServer()

Kills the server process

register()

Tries to register with the Meta-Server

run()

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

PyFoam.Infrastructure.FoamServer.findFreePort(useSSL=None)

Finds a free server port on this machine and returns it

Valid server ports are in the range 18000 upward (the function tries to find the lowest possible port number

ATTENTION: this part may introduce race conditions

PyFoam.Infrastructure.FoamServer.needsAuthentication(func)

PyFoam.Infrastructure.FoamServer.random() → x in the interval [0, 1).