ARTEMIS
Functions | Variables
WarpX_py.cpp File Reference
#include "WarpX_py.H"

Functions

bool IsPythonCallBackInstalled (std::string name)
 Function to check if the given name is a key in warpx_callback_py_map. More...
 
void ExecutePythonCallback (std::string name)
 Function to look for and execute Python callbacks. More...
 

Variables

std::map< std::string, WARPX_CALLBACK_PY_FUNC_0warpx_callback_py_map
 

Function Documentation

◆ ExecutePythonCallback()

void ExecutePythonCallback ( std::string  name)

Function to look for and execute Python callbacks.

◆ IsPythonCallBackInstalled()

bool IsPythonCallBackInstalled ( std::string  name)

Function to check if the given name is a key in warpx_callback_py_map.

Variable Documentation

◆ warpx_callback_py_map

std::map< std::string, WARPX_CALLBACK_PY_FUNC_0 > warpx_callback_py_map

Declare global map to hold python callback functions.

The keys of the map describe at what point in the simulation the python functions will be called. Currently supported keys (callback points) are afterinit, beforecollisions, aftercollisions, beforeEsolve, poissonsolver, afterEsolve, beforeInitEsolve, afterInitEsolve, beforedeposition, afterdeposition, particlescraper, particleloader, beforestep, afterstep, afterdiagnostics, afterrestart, oncheckpointsignal, onbreaksignal, particleinjection and appliedfields.