blob: a18f9a7f1cea16d054013eea3cc46c58649cda16 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
/* Copyright 2019-2022 The WarpX Community
*
* This file is part of WarpX.
*
* Authors: David Grote, Maxence Thevenet, Weiqun Zhang, Roelof Groenewald
*
* License: BSD-3-Clause-LBNL
*/
#ifndef WARPX_PY_H_
#define WARPX_PY_H_
#include "Utils/export.H"
#include "Utils/WarpXProfilerWrapper.H"
#include <map>
#include <string>
/**
* 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. See ``WarpX/Python/pywarpx/callbacks.py`` for a
* list of currently supported callback names.
*/
extern WARPX_EXPORT std::map< std::string, std::function<void()> > warpx_callback_py_map;
/**
* \brief Function to install the given name and function in warpx_callback_py_map
*/
void InstallPythonCallback ( std::string name, std::function<void()> callback );
/**
* \brief Function to check if the given name is a key in warpx_callback_py_map
*/
bool IsPythonCallbackInstalled ( std::string name );
/**
* \brief Function to look for and execute Python callbacks
*/
void ExecutePythonCallback ( std::string name );
/**
* \brief Function to clear the given callback name from warpx_callback_py_map
*/
void ClearPythonCallback ( std::string name );
#endif
|