PyFoam.Applications.ListCases module

Application-class that implements pyFoamListCases.py

class PyFoam.Applications.ListCases.ListCases(args=None, **kwargs)[source]

Bases: PyFoam.Applications.PyFoamApplication.PyFoamApplication

__init__(args=None, **kwargs)[source]
Parameters
  • description – description of the command

  • epilog – text to be printed after the options-help

  • examples – usage examples to be printed after the epilog

  • usage – Usage

  • interspersed – Is the command line allowed to be interspersed (options after the arguments)

  • args – Command line arguments when using the Application as a ‘class’ from a script

  • nr – Number of required arguments

  • changeVersion – May this application change the version of OF used?

  • exactNr – Must not have more than the required number of arguments

  • subcommands – parse and use subcommands from the command line. Either True or a list with subcommands

  • inputApp – Application with input data. Used to allow a ‘pipe-like’ behaviour if the class is used from a Script

  • localConfigurationFile – Use this file (or list of files) as a local configuration

  • findLocalConfigurationFile – Method to find a configuration file BEFORE the actual parameters are parsed

  • allowCurses – This application can wrap the output in a curses-window

__module__ = 'PyFoam.Applications.ListCases'
addOptions()[source]

Add options to the parser

fnmatch(fName)[source]

Check whether the filename matches our patterns for for cases to be processed

readState(sol, sFile, default='')[source]
run()[source]

Run the real application

sortChoices = ['name', 'first', 'last', 'mtime', 'nrSteps', 'procs', 'diskusage', 'pFirst', 'pLast', 'nrParallel', 'nowTime', 'state', 'lastOutput', 'startedAt']