Package PyFoam :: Package Basics :: Module OutFileCollection :: Class OutFileCollection
[show private | hide private]
[frames | no frames]

Class OutFileCollection


Collection of output files

The files are stored in a common directory and are created on first access

Each file can be identified by a unique name. If a file is accessed a second time at the same simulation-time a file with the ending _2 is created (incrementing with each access)
Method Summary
  __init__(self, basename, titles)
  checkTime(self, time)
check whether the time has changed
  getFile(self, name)
get a OutputFile-object
  incrementCalls(self, name)
increments the access counter for name
  prevCalls(self, name)
checks whether the name was used previously at that time-step
  setTitles(self, titles)
Sets the titles anew
  write(self, name, time, data)
writes data to file

Method Details

__init__(self, basename, titles=[])
(Constructor)

Parameters:
basename - name of the base directory
titles - names of the data columns

checkTime(self, time)

check whether the time has changed

getFile(self, name)

get a OutputFile-object

incrementCalls(self, name)

increments the access counter for name

prevCalls(self, name)

checks whether the name was used previously at that time-step

setTitles(self, titles)

Sets the titles anew
Parameters:
titles - the new titles

write(self, name, time, data)

writes data to file

name - name of the file time - simulation time data - tuple with the data

Generated by Epydoc 2.1 on Mon Jan 22 23:52:48 2007 http://epydoc.sf.net