aboutsummaryrefslogtreecommitdiff
path: root/Source
diff options
context:
space:
mode:
Diffstat (limited to 'Source')
-rw-r--r--Source/Particles/PhysicalParticleContainer.cpp1
-rw-r--r--Source/QED/BreitWheelerEngineWrapper.cpp12
-rw-r--r--Source/QED/BreitWheelerEngineWrapper.h33
-rw-r--r--Source/QED/QuantumSyncEngineWrapper.cpp13
-rw-r--r--Source/QED/QuantumSyncEngineWrapper.h33
5 files changed, 47 insertions, 45 deletions
diff --git a/Source/Particles/PhysicalParticleContainer.cpp b/Source/Particles/PhysicalParticleContainer.cpp
index ac5b98dae..3d3d3ff74 100644
--- a/Source/Particles/PhysicalParticleContainer.cpp
+++ b/Source/Particles/PhysicalParticleContainer.cpp
@@ -2143,7 +2143,6 @@ void PhysicalParticleContainer::InitTauQuantumSync()
BL_PROFILE("PhysicalParticleContainer::InitTauQuantumSync");
//Get functor
auto get_opt = shr_ptr_qs_engine->build_optical_depth_functor();
-
//Looping over all the particles
int num_levels = finestLevel() + 1;
for (int lev=0; lev < num_levels; ++lev)
diff --git a/Source/QED/BreitWheelerEngineWrapper.cpp b/Source/QED/BreitWheelerEngineWrapper.cpp
index 72fe06d63..97934589a 100644
--- a/Source/QED/BreitWheelerEngineWrapper.cpp
+++ b/Source/QED/BreitWheelerEngineWrapper.cpp
@@ -47,16 +47,16 @@ bool BreitWheelerEvolveOpticalDepth::operator()(
// Factory class =============================
-BreitWheelerEngine::BreitWheelerEngine(){}
+BreitWheelerEngine::BreitWheelerEngine (){}
//Builds the functor to initialize the optical depth
-BreitWheelerGetOpticalDepth BreitWheelerEngine::build_optical_depth_functor()
+BreitWheelerGetOpticalDepth BreitWheelerEngine::build_optical_depth_functor ()
{
return BreitWheelerGetOpticalDepth();
}
//Builds the functor to evolve the optical depth
-BreitWheelerEvolveOpticalDepth BreitWheelerEngine::build_evolve_functor()
+BreitWheelerEvolveOpticalDepth BreitWheelerEngine::build_evolve_functor ()
{
AMREX_ALWAYS_ASSERT(lookup_tables_initialized);
@@ -66,7 +66,7 @@ BreitWheelerEvolveOpticalDepth BreitWheelerEngine::build_evolve_functor()
//Initializes the Lookup tables using the default settings
//provided by the library
-void BreitWheelerEngine::computes_lookup_tables_default()
+void BreitWheelerEngine::computes_lookup_tables_default ()
{
//A control parameters structure
//with the default values provided by the library
@@ -77,13 +77,13 @@ void BreitWheelerEngine::computes_lookup_tables_default()
lookup_tables_initialized = true;
}
-bool BreitWheelerEngine::are_lookup_tables_initialized() const
+bool BreitWheelerEngine::are_lookup_tables_initialized () const
{
return lookup_tables_initialized;
}
//Private function which actually computes the lookup tables
-void BreitWheelerEngine::computes_lookup_tables(
+void BreitWheelerEngine::computes_lookup_tables (
WarpXBreitWheelerWrapperCtrl ctrl)
{
//Lambda is not actually used if S.I. units are enabled
diff --git a/Source/QED/BreitWheelerEngineWrapper.h b/Source/QED/BreitWheelerEngineWrapper.h
index 9aa897e8d..aaa94c0ec 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
@@ -33,11 +30,12 @@ struct BreitWheelerEngineInnards
// 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:
- BreitWheelerGetOpticalDepth()
+ BreitWheelerGetOpticalDepth ()
{};
AMREX_GPU_DEVICE
@@ -66,22 +64,25 @@ private:
};
// Factory class =============================
+
+/* \brief Wrapper for the Breit Wheeler engine of the PICSAR library */
class BreitWheelerEngine
{
public:
- BreitWheelerEngine();
+ BreitWheelerEngine ();
- //Builds the functor to initialize the optical depth
- BreitWheelerGetOpticalDepth build_optical_depth_functor();
+ /* \brief Builds the functor to initialize the optical depth */
+ BreitWheelerGetOpticalDepth build_optical_depth_functor ();
- //Builds the functor to evolve the optical depth
- BreitWheelerEvolveOpticalDepth build_evolve_functor();
+ /* \brief Builds the functor to evolve the optical depth */
+ BreitWheelerEvolveOpticalDepth 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:
BreitWheelerEngineInnards innards;
//Private function which actually computes the lookup tables
- void computes_lookup_tables(
+ void computes_lookup_tables (
WarpXBreitWheelerWrapperCtrl ctrl);
};
//============================================
-#endif //WARPX_breit_wheeler_engine_wrapper_H_
+#endif //WARPX_breit_wheeler_engine_wrapper_H_ \ No newline at end of file
diff --git a/Source/QED/QuantumSyncEngineWrapper.cpp b/Source/QED/QuantumSyncEngineWrapper.cpp
index 544be075e..90bd9cefc 100644
--- a/Source/QED/QuantumSyncEngineWrapper.cpp
+++ b/Source/QED/QuantumSyncEngineWrapper.cpp
@@ -47,16 +47,17 @@ bool QuantumSynchrotronEvolveOpticalDepth::operator()(
// Factory class =============================
-QuantumSynchrotronEngine::QuantumSynchrotronEngine(){}
+QuantumSynchrotronEngine::QuantumSynchrotronEngine (){}
//Builds the functor to evolve the optical depth
-QuantumSynchrotronGetOpticalDepth QuantumSynchrotronEngine::build_optical_depth_functor()
+QuantumSynchrotronGetOpticalDepth
+QuantumSynchrotronEngine::build_optical_depth_functor ()
{
return QuantumSynchrotronGetOpticalDepth();
}
//Builds the functor to evolve the optical depth
-QuantumSynchrotronEvolveOpticalDepth QuantumSynchrotronEngine::build_evolve_functor()
+QuantumSynchrotronEvolveOpticalDepth QuantumSynchrotronEngine::build_evolve_functor ()
{
AMREX_ALWAYS_ASSERT(lookup_tables_initialized);
@@ -65,7 +66,7 @@ QuantumSynchrotronEvolveOpticalDepth QuantumSynchrotronEngine::build_evolve_func
//Initializes the Lookup tables using the default settings
//provided by the library
-void QuantumSynchrotronEngine::computes_lookup_tables_default()
+void QuantumSynchrotronEngine::computes_lookup_tables_default ()
{
//A control parameters structure
//with the default values provided by the library
@@ -76,13 +77,13 @@ void QuantumSynchrotronEngine::computes_lookup_tables_default()
lookup_tables_initialized = true;
}
-bool QuantumSynchrotronEngine::are_lookup_tables_initialized() const
+bool QuantumSynchrotronEngine::are_lookup_tables_initialized () const
{
return lookup_tables_initialized;
}
//Private function which actually computes the lookup tables
-void QuantumSynchrotronEngine::computes_lookup_tables(
+void QuantumSynchrotronEngine::computes_lookup_tables (
WarpXQuantumSynchrotronWrapperCtrl ctrl)
{
//Lambda is not actually used if S.I. units are enabled
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
generated by cgit v1.2.3 (git 2.46.0) at 2025-08-18 14:32:44 +0000