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)[source]¶ Bases:
object
The class that handles the actual requests (only needed to hide the Thread-methods from the world
-
__dict__
= dict_proxy({'__module__': 'PyFoam.Infrastructure.FoamServer', 'writeDictionaryText': <function writeDictionaryText>, 'lastLine': <function lastLine>, 'actualCommandLine': <function actualCommandLine>, 'isLiving': <function isLiving>, 'ip': <function ip>, 'startTimestamp': <function startTimestamp>, 'pid': <function pid>, 'getEnviron': <function getEnviron>, 'jobId': <function jobId>, 'lastTimeStepSeen': <function lastTimeStepSeen>, 'uname': <function uname>, 'getPlots': <function getPlots>, 'isFoamServer': <function isFoamServer>, '__weakref__': <attribute '__weakref__' of 'FoamAnswerer' objects>, 'id': <function id>, '__init__': <function __init__>, 'writtenTimesteps': <function writtenTimesteps>, 'write': <function write>, 'getDictionaryContents': <function getDictionaryContents>, 'deltaT': <function deltaT>, 'procNr': <function procNr>, 'isParallel': <function isParallel>, 'commandLine': <function commandLine>, 'hostname': <function hostname>, 'scriptName': <function scriptName>, 'pathToSolution': <function pathToSolution>, 'elapsedTime': <function elapsedTime>, 'tail': <function tail>, 'runnerData': <function runnerData>, 'listFiles': <function listFiles>, 'getDictionaryText': <function getDictionaryText>, '__doc__': 'The class that handles the actual requests (only needed to hide the\n Thread-methods from the world\n ', 'foamVersion': <function foamVersion>, 'solutionFiles': <function solutionFiles>, 'writeDictionaryContents': <function writeDictionaryContents>, '_readParameter': <function _readParameter>, 'stop': <function stop>, 'setRemark': <function setRemark>, '_kill': <function _kill>, 'mpi': <function mpi>, '__dict__': <attribute '__dict__' of 'FoamAnswerer' objects>, 'lastLogLineSeen': <function lastLogLineSeen>, 'loadAvg': <function loadAvg>, 'argv': <function argv>, 'startTime': <function startTime>, 'usedArgv': <function usedArgv>, 'configuration': <function configuration>, 'createTime': <function createTime>, 'pyFoamVersion': <function pyFoamVersion>, 'getRemark': <function getRemark>, '_insertLine': <function _insertLine>, 'stopAtNextWrite': <function stopAtNextWrite>, 'controlDictUnmodified': <function controlDictUnmodified>, 'cwd': <function cwd>, 'getPlotData': <function getPlotData>, 'time': <function time>, 'endTime': <function endTime>, 'nrWarnings': <function nrWarnings>, 'user': <function user>})¶
-
__init__
(run=None, master=None, lines=100, foamserver=None)[source]¶ 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)
-
_readParameter
(name)[source]¶ Reads a parametr from the controlDict :param name: the parameter :return: The value
-
getDictionaryContents
(*args)[source]¶ 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
(*args)[source]¶ Parameters: - directory – Sub-directory of the case
- name – name of the dictionary file
Returns: the contents of the file as a big string
-
getEnviron
(*args)[source]¶ Parameters: name – name of an environment variable Returns: value of the variable, empty string if non-existing
-
listFiles
(*args)[source]¶ Parameters: directory – Sub-directory of the case Returns: List of the filenames (not directories) in that case
-
setRemark
(*args)[source]¶ Overwrite the user-defined remark :return: True if the remark was set previously
-
solutionFiles
(*args)[source]¶ Parameters: time – name of the timestep Returns: list of the solution files at that timestep
-
writeDictionaryContents
(*args)[source]¶ 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
-
-
class
PyFoam.Infrastructure.FoamServer.
FoamServer
(run=None, master=None, lines=100)[source]¶ Bases:
threading.Thread
This is the class that serves the requests about the FOAM-Run
-
__init__
(run=None, master=None, lines=100)[source]¶ 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'¶
-
run
()[source]¶ 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)[source]¶ 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.
random
() → x in the interval [0, 1).¶