PyFoam.Applications.CommonSelectTimesteps module

Class that implements common functionality for selecting timesteps

class PyFoam.Applications.CommonSelectTimesteps.CommonSelectTimesteps[source]

Bases: object

This class compiles a list of timesteps that should be processed

__dict__ = mappingproxy({'__weakref__': <attribute '__weakref__' of 'CommonSelectTimesteps' objects>, '__dict__': <attribute '__dict__' of 'CommonSelectTimesteps' objects>, '__init__': <function CommonSelectTimesteps.__init__>, '__doc__': '\n This class compiles a list of timesteps that should be processed\n ', 'processTimestepOptions': <function CommonSelectTimesteps.processTimestepOptions>, '__module__': 'PyFoam.Applications.CommonSelectTimesteps', 'addOptions': <function CommonSelectTimesteps.addOptions>, 'processTimestepOptionsIndex': <function CommonSelectTimesteps.processTimestepOptionsIndex>})
__init__()[source]
__module__ = 'PyFoam.Applications.CommonSelectTimesteps'
__weakref__

list of weak references to the object (if defined)

addOptions(defaultUnique, singleTime=False)[source]

Add the necessary options :param defaultUnique: whether timesteps are unique by default :param singleTime: only a single timestep may be selected

processTimestepOptions(sol)[source]

Process the options :param sol: the solution-directory that is to be worked with

processTimestepOptionsIndex(sol)[source]

Process the time options and return a list of (time,index) tuples