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({'__module__': 'PyFoam.Applications.CommonPrePostHooks', '__doc__': ' The class that runs the hooks\n ', 'addOptions': <function CommonPrePostHooks.addOptions>, '_hookmessage': <function CommonPrePostHooks._hookmessage>, '_stopExecutionOnHookError': <function CommonPrePostHooks._stopExecutionOnHookError>, 'runPreHooks': <function CommonPrePostHooks.runPreHooks>, 'runPostHooks': <function CommonPrePostHooks.runPostHooks>, '_executeHook': <function CommonPrePostHooks._executeHook>, 'prepareHooks': <function CommonPrePostHooks.prepareHooks>, '_checkAndCreateHookInstances': <function CommonPrePostHooks._checkAndCreateHookInstances>, '_dumpHooks': <function CommonPrePostHooks._dumpHooks>, '_getHooksWithPrefix': <function CommonPrePostHooks._getHooksWithPrefix>, '__dict__': <attribute '__dict__' of 'CommonPrePostHooks' objects>, '__weakref__': <attribute '__weakref__' of 'CommonPrePostHooks' objects>})
__module__ = 'PyFoam.Applications.CommonPrePostHooks'
__weakref__

list of weak references to the object (if defined)

_checkAndCreateHookInstances(toDict, prefix)[source]
_dumpHooks(lst)[source]
_executeHook(name, hDict)[source]
_getHooksWithPrefix(prefix)[source]
_hookmessage(*args)[source]
_stopExecutionOnHookError(spec=False)[source]
addOptions(auto_enable=True)[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