diff options
Diffstat (limited to 'Source/QED/BreitWheelerEngineWrapper.h')
| -rw-r--r-- | Source/QED/BreitWheelerEngineWrapper.h | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Source/QED/BreitWheelerEngineWrapper.h b/Source/QED/BreitWheelerEngineWrapper.h index 6aacf4f4e..2e040f5ab 100644 --- a/Source/QED/BreitWheelerEngineWrapper.h +++ b/Source/QED/BreitWheelerEngineWrapper.h @@ -1,9 +1,6 @@ #ifndef WARPX_breit_wheeler_engine_wrapper_h_ #define WARPX_breit_wheeler_engine_wrapper_h_ -//This file provides a wrapper aroud the breit_wheeler engine -//provided by the QED modules of the PICSAR library - #include "QedWrapperCommons.h" //BW ENGINE from PICSAR @@ -17,7 +14,8 @@ using WarpXBreitWheelerWrapper = // These functors provide the core elementary functions of the library // Can be included in GPU kernels -// Initialization of the optical depth +/* \brief Functor to initialize the optical depth of photons for the +* Breit-Wheeler process */ class BreitWheelerGetOpticalDepth { public: @@ -30,15 +28,17 @@ public: //____________________________________________ // Factory class ============================= + +/* \brief Wrapper for the Breit Wheeler engine of the PICSAR library */ class BreitWheelerEngine { public: BreitWheelerEngine(); - //Builds the functor to initialize the optical depth + /* \brief Builds the functor to initialize the optical depth */ BreitWheelerGetOpticalDepth build_optical_depth_functor(); }; //============================================ -#endif //WARPX_breit_wheeler_engine_wrapper_H_ +#endif //WARPX_breit_wheeler_engine_wrapper_H_
\ No newline at end of file |