PyFoam.Basics.OutFileCollection module

Collections of output files

class PyFoam.Basics.OutFileCollection.OutFileCollection(basename, titles=[], singleFile=False)[source]

Bases: object

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)

addToOpenList(name)[source]

Adds a file to the list of open files. Closes another file if limit is reached

checkTime(time)[source]

check whether the time has changed

close()[source]

Force all files to be closed

getFile(name)[source]

get a OutputFile-object

incrementCalls(name)[source]

increments the access counter for name

maxOpenFiles = 100
prevCalls(name)[source]

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

removeFromOpenList(name)[source]

Adds a file to the list of open files. Closes another file if limit is reached

setTitles(titles)[source]

Sets the titles anew

Parameters:titles – the new titles
write(name, time, data)[source]

writes data to file

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