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)
-
__dict__
= dict_proxy({'__module__': 'PyFoam.Basics.OutFileCollection', 'addToOpenList': <function addToOpenList>, 'maxOpenFiles': 100, '__weakref__': <attribute '__weakref__' of 'OutFileCollection' objects>, 'prevCalls': <function prevCalls>, 'incrementCalls': <function incrementCalls>, 'checkTime': <function checkTime>, 'write': <function write>, 'getFile': <function getFile>, '__dict__': <attribute '__dict__' of 'OutFileCollection' objects>, 'close': <function close>, 'removeFromOpenList': <function removeFromOpenList>, 'setTitles': <function setTitles>, '__doc__': 'Collection of output files\n\n The files are stored in a common directory and are created on\n first access\n\n Each file can be identified by a unique name. If a file is\n accessed a second time at the same simulation-time a file with the\n ending _2 is created (incrementing with each access)', '__init__': <function __init__>})¶
-
__init__
(basename, titles=[], singleFile=False)[source]¶ Parameters: - basename – name of the base directory
- titles – names of the data columns
- singleFile – don’t split into multiple files if more than one
datum is insert per time-step
-
__module__
= 'PyFoam.Basics.OutFileCollection'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
addToOpenList
(name)[source]¶ Adds a file to the list of open files. Closes another file if limit is reached
-
maxOpenFiles
= 100¶
-