PyFoam.Applications.PyFoamApplication module

Base class for pyFoam-applications

Classes can also be called with a command-line string

class PyFoam.Applications.PyFoamApplication.PyFoamApplication(args=None, description=None, epilog=None, examples=None, usage=None, interspersed=False, nr=None, changeVersion=True, exactNr=True, subcommands=None, inputApp=None, localConfigurationFile=None, findLocalConfigurationFile=None, allowCurses=True, **kwArgs)[source]

Bases: object

This class is the base for all pyFoam-utilities

CWindowType

alias of PyFoam.Applications.CursesApplicationWrapper.CWindow

addLocalConfig(directory=None)[source]

Adds a local directory (assuming it is found)

addOptions()[source]

Add options to the parser

addToCaseLog(name, *text)[source]

Add information about the application that was run to the case-log

checkCase(name, fatal=True, verbose=True)[source]

Check whether this is a valid OpenFOAM-case :param name: the directory-bame that is supposed to be the case :param fatal: If this is not a case then the application ends :param verbose: If this is not a case no warning is issued

depreciationWarning(reason)[source]
ensureGeneralOptions()[source]
error(*args)[source]

Raise a error exception. How it will be handled is a different story :param args: Arguments to the exception

errorPrint(*args)[source]

Prints an error message and exits :param args: Arguments that are to be printed

escapeArgument(arg)[source]

Check if this argument has spaces etc and surround it with ” to make it copypastable

getApplication()[source]
getCasePath(args)[source]

Try to determine the actual case location from the arguments

getData()[source]

Get the application data

class iDict[source]

Bases: dict

This class is a quick and dirty wrapper to use a dictionary like a struct

iteritems()[source]
iterkeys()[source]
localConfigFromCasename(args)[source]

Look for the local configuration assuming that the first argument after ‘-case’ is the case directory

localConfigInArgs(args)[source]

Assume that the first argument that is no option and a directory can have a local configuration

localConfigInArgsFile(args)[source]

Assume that the first argument that is no option and a file can has a local configuration in the same directory

localConfigInCWD(args)[source]

find the local configuration in the current directory

replaceAutoInArgs(args)[source]

If the first argument is ‘auto’ replace it with the ‘application’ entry from the controlDict

run()[source]

Run the real application

setData(data)[source]

Set the application data

Parameters:data – dictionary whose entries will be added to the

application data (possibly overwriting old entries of the same name)

silent(*args)[source]

Don’t print a warning message :param args: Arguments that are to be printed

warning(*args)[source]

Prints a warning message :param args: Arguments that are to be printed

exception PyFoam.Applications.PyFoamApplication.PyFoamApplicationException(app, *text)[source]

Bases: PyFoam.Error.FatalErrorPyFoamException

PyFoam.Applications.PyFoamApplication.pyFoamExceptionHook(type, value, tb, debugOnSyntaxError=False)[source]
PyFoam.Applications.PyFoamApplication.pyFoamSIG1HandlerPrintStack(nr, frame)[source]