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[source]

Bases: object

The class that runs the hooks

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

list of weak references to the object (if defined)

addOptions()[source]
checkAndCreateHookInstances(toDict, prefix)[source]
dumpHooks(lst)[source]
executeHook(name, hDict)[source]
getHooksWithPrefix(prefix)[source]
hookmessage(*args)[source]
prepareHooks()[source]

Prepare the hooks and output additional info if wanted

runPostHooks()[source]

Run the hooks after the execution of the solver

runPreHooks()[source]

Run the hooks before the execution of the solver

stopExecutionOnHookError(spec=False)[source]