PyFoam.Applications.CommonSelectTimesteps module

Class that implements common functionality for selecting timesteps

class PyFoam.Applications.CommonSelectTimesteps.CommonSelectTimesteps

Bases: object

This class compiles a list of timesteps that should be processed

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

__init__()

__module__ = 'PyFoam.Applications.CommonSelectTimesteps'

__weakref__

list of weak references to the object (if defined)

addOptions(defaultUnique, singleTime=False)

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

processTimestepOptions(sol)

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

processTimestepOptionsIndex(sol)

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