diff options
Diffstat (limited to 'Source/QED/QuantumSyncEngineWrapper.h')
| -rw-r--r-- | Source/QED/QuantumSyncEngineWrapper.h | 33 |
1 files changed, 17 insertions, 16 deletions
diff --git a/Source/QED/QuantumSyncEngineWrapper.h b/Source/QED/QuantumSyncEngineWrapper.h index 54a4b5ce6..af3731f6c 100644 --- a/Source/QED/QuantumSyncEngineWrapper.h +++ b/Source/QED/QuantumSyncEngineWrapper.h @@ -1,9 +1,6 @@ #ifndef WARPX_quantum_sync_engine_wrapper_h_ #define WARPX_quantum_sync_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" //QS ENGINE from PICSAR @@ -33,11 +30,12 @@ struct QuantumSynchrotronEngineInnards // 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 leptons for the +* Quantum Synchrotron process */ class QuantumSynchrotronGetOpticalDepth { public: - QuantumSynchrotronGetOpticalDepth() + QuantumSynchrotronGetOpticalDepth () {}; AMREX_GPU_DEVICE @@ -66,22 +64,25 @@ private: }; // Factory class ============================= + +/* \brief Wrapper for the Quantum Synchrotron engine of the PICSAR library */ class QuantumSynchrotronEngine { public: - QuantumSynchrotronEngine(); + QuantumSynchrotronEngine (); - //Builds the functor to initialize the optical depth - QuantumSynchrotronGetOpticalDepth build_optical_depth_functor(); + /* \brief Builds the functor to initialize the optical depth */ + QuantumSynchrotronGetOpticalDepth build_optical_depth_functor (); - //Builds the functor to evolve the optical depth - QuantumSynchrotronEvolveOpticalDepth build_evolve_functor(); + /* \brief Builds the functor to evolve the optical depth */ + QuantumSynchrotronEvolveOpticalDepth build_evolve_functor (); - //Computes the Lookup tables using the default settings - //provided by the library - void computes_lookup_tables_default(); + /* \brief Computes the Lookup tables using the default settings + * provided by the PICSAR library */ + void computes_lookup_tables_default (); - bool are_lookup_tables_initialized() const; + /* \brief Checks if lookup tables are properly initialized */ + bool are_lookup_tables_initialized () const; private: bool lookup_tables_initialized = false; @@ -89,10 +90,10 @@ private: QuantumSynchrotronEngineInnards innards; //Private function which actually computes the lookup tables - void computes_lookup_tables( + void computes_lookup_tables ( WarpXQuantumSynchrotronWrapperCtrl ctrl); }; //============================================ -#endif //WARPX_quantum_sync_engine_wrapper_h_ +#endif //WARPX_quantum_sync_engine_wrapper_h_
\ No newline at end of file |