PyFoam.RunDictionary.TimelineDirectory module

Working with a directory of timelines

Currently not optimal as it reads the files more often than necessary

class PyFoam.RunDictionary.TimelineDirectory.TimelineDirectory(case=None, dirName='probes', writeTime=None)

Bases: object

A directory of sampled times

__contains__(value)

__dict__ = mappingproxy({'__module__': 'PyFoam.RunDictionary.TimelineDirectory', '__doc__': 'A directory of sampled times', '__init__': <function TimelineDirectory.__init__>, '__iter__': <function TimelineDirectory.__iter__>, '__getitem__': <function TimelineDirectory.__getitem__>, '__contains__': <function TimelineDirectory.__contains__>, '__len__': <function TimelineDirectory.__len__>, 'positions': <function TimelineDirectory.positions>, 'timeRange': <function TimelineDirectory.timeRange>, 'getDataLocation': <function TimelineDirectory.getDataLocation>, 'getData': <function TimelineDirectory.getData>, '__dict__': <attribute '__dict__' of 'TimelineDirectory' objects>, '__weakref__': <attribute '__weakref__' of 'TimelineDirectory' objects>, '__annotations__': {}})

__getitem__(value)

__init__(case=None, dirName='probes', writeTime=None)

Parameters:

• case – The case directory

• dirName – Name of the directory with the timelines

• writeTime – The write time-directory where the data in question is to be plotted

__iter__()

__len__()

__module__ = 'PyFoam.RunDictionary.TimelineDirectory'

__weakref__

list of weak references to the object (if defined)

getData(times, value=None, position=None, vectorMode=None)

Get data that mstches the given times most closely :param times: a list with times :param value: name of the value. All if unspecified :param position: name of the position of the value. All if unspecified :param vectorMode: which component of the vector to use

getDataLocation(value=None, position=None, vectorMode=None)

Get Timeline sets :param value: name of the value. All if unspecified :param position: name of the position of the value. All if unspecified

positions()

Returns all the found positions

timeRange()

Return the range of possible times

class PyFoam.RunDictionary.TimelineDirectory.TimelineValue(sDir, val, time)

Bases: object

A file with one timelined value

__call__(addTitle=True)

Return the data as a SpreadsheetData-object

__dict__ = mappingproxy({'__module__': 'PyFoam.RunDictionary.TimelineDirectory', '__doc__': 'A file with one timelined value', '__init__': <function TimelineValue.__init__>, '__repr__': <function TimelineValue.__repr__>, 'isProbe': <function TimelineValue.isProbe>, 'timeRange': <function TimelineValue.timeRange>, 'getData': <function TimelineValue.getData>, '__call__': <function TimelineValue.__call__>, '__dict__': <attribute '__dict__' of 'TimelineValue' objects>, '__weakref__': <attribute '__weakref__' of 'TimelineValue' objects>, '__annotations__': {}})

__init__(sDir, val, time)

Parameters:

• sDir – The timeline-dir

• val – the value

• time – the timename

__module__ = 'PyFoam.RunDictionary.TimelineDirectory'

__repr__()

Return repr(self).

__weakref__

list of weak references to the object (if defined)

getData(times, vectorMode=None)

Get the data values that are nearest to the actual times

isProbe()

Is this a probe-file

timeRange()

Range of times