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__ = dict_proxy({'__module__': 'PyFoam.Applications.CommonSelectTimesteps', 'processTimestepOptions': <function processTimestepOptions>, 'addOptions': <function addOptions>, '__dict__': <attribute '__dict__' of 'CommonSelectTimesteps' objects>, '__weakref__': <attribute '__weakref__' of 'CommonSelectTimesteps' objects>, '__doc__': '\n This class compiles a list of timesteps that should be processed\n ', '__init__': <function __init__>, 'processTimestepOptionsIndex': <function processTimestepOptionsIndex>})

__init__()

x.__init__(…) initializes x; see help(type(x)) for signature

__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