PyFoam.Applications.CommonPrePostHooks module

Class that implements the common functionality for executing hooks before and after the running of the solver

class PyFoam.Applications.CommonPrePostHooks.CommonPrePostHooks

Bases: object

The class that runs the hooks

__dict__ = mappingproxy({'stopExecutionOnHookError': <function CommonPrePostHooks.stopExecutionOnHookError>, '__weakref__': <attribute '__weakref__' of 'CommonPrePostHooks' objects>, 'prepareHooks': <function CommonPrePostHooks.prepareHooks>, '__dict__': <attribute '__dict__' of 'CommonPrePostHooks' objects>, 'executeHook': <function CommonPrePostHooks.executeHook>, 'addOptions': <function CommonPrePostHooks.addOptions>, '__doc__': ' The class that runs the hooks\n ', '__module__': 'PyFoam.Applications.CommonPrePostHooks', 'checkAndCreateHookInstances': <function CommonPrePostHooks.checkAndCreateHookInstances>, 'runPreHooks': <function CommonPrePostHooks.runPreHooks>, 'dumpHooks': <function CommonPrePostHooks.dumpHooks>, 'hookmessage': <function CommonPrePostHooks.hookmessage>, 'getHooksWithPrefix': <function CommonPrePostHooks.getHooksWithPrefix>, 'runPostHooks': <function CommonPrePostHooks.runPostHooks>})

__module__ = 'PyFoam.Applications.CommonPrePostHooks'

__weakref__

list of weak references to the object (if defined)

addOptions()

checkAndCreateHookInstances(toDict, prefix)

dumpHooks(lst)

executeHook(name, hDict)

getHooksWithPrefix(prefix)

hookmessage(*args)

prepareHooks()

Prepare the hooks and output additional info if wanted

runPostHooks()

Run the hooks after the execution of the solver

runPreHooks()

Run the hooks before the execution of the solver

stopExecutionOnHookError(spec=False)