Add KSIntSurfaceScattering to simulate scatterings on a surface

Documentation/Bindings/bindings_full.xml

@@ -2152,6 +2152,7 @@
         <theta_cosine
             angle_max="(double)"
             angle_min="(double)"
+            direction="(string)"
             mode="(string)"
             name="(string)"
         >
@@ -2315,6 +2316,7 @@
         <theta_cosine
             angle_max="(double)"
             angle_min="(double)"
+            direction="(string)"
             mode="(string)"
             name="(string)"
         >
@@ -2479,6 +2481,7 @@
         <theta_cosine
             angle_max="(double)"
             angle_min="(double)"
+            direction="(string)"
             mode="(string)"
             name="(string)"
         >
@@ -4194,6 +4197,7 @@
             <theta_cosine
                 angle_max="(double)"
                 angle_min="(double)"
+                direction="(string)"
                 mode="(string)"
                 name="(string)"
             >
@@ -4348,6 +4352,7 @@
             <theta_cosine
                 angle_max="(double)"
                 angle_min="(double)"
+                direction="(string)"
                 mode="(string)"
                 name="(string)"
             >
@@ -4701,6 +4706,7 @@
     <ksgen_value_angle_cosine
         angle_max="(double)"
         angle_min="(double)"
+        direction="(string)"
         mode="(string)"
         name="(string)"
     >
@@ -5022,6 +5028,14 @@
     >
     </ksint_calculator_ion>
 
+    <ksint_calculator_mott
+        name="(string)"
+        nucleus="(string)"
+        theta_max="(double)"
+        theta_min="(double)"
+    >
+    </ksint_calculator_mott>
+
     <ksint_decay
         calculator="(string)"
         calculators="(string)"
@@ -5298,6 +5312,14 @@
         >
         </calculator_kess>
 
+        <calculator_mott
+            name="(string)"
+            nucleus="(string)"
+            theta_max="(double)"
+            theta_min="(double)"
+        >
+        </calculator_mott>
+
         <density_constant
             density="(double)"
             name="(string)"
@@ -5355,6 +5377,16 @@
     >
     </ksint_surface_multiplication>
 
+    <ksint_surface_scattering
+        name="(string)"
+        scat_loss_fraction="(double)"
+        scat_probability="(double)"
+        sec_electron_mean_energy="(double)"
+        sec_electron_probability="(double)"
+        side="(string)"
+    >
+    </ksint_surface_scattering>
+
     <ksint_surface_specular
         name="(string)"
         probability="(double)"

Kassiopeia/Bindings/CMakeLists.txt

@@ -129,6 +129,7 @@ set( BINDINGS_HEADER_FILES
     Interactions/Include/KSIntSurfaceSpecularBuilder.h
     Interactions/Include/KSIntSurfaceUCNBuilder.h
     Interactions/Include/KSIntSurfaceDiffuseBuilder.h
+    Interactions/Include/KSIntSurfaceScatteringBuilder.h
     Interactions/Include/KSIntSurfaceMultiplicationBuilder.h
     Interactions/Include/KSIntSurfaceSpinFlipBuilder.h
     Interactions/Include/KESSSurfaceInteractionBuilder.h
@@ -357,6 +358,7 @@ set( BINDINGS_SOURCE_FILES
     Interactions/Source/KSIntSurfaceSpecularBuilder.cxx
     Interactions/Source/KSIntSurfaceUCNBuilder.cxx
     Interactions/Source/KSIntSurfaceDiffuseBuilder.cxx
+    Interactions/Source/KSIntSurfaceScatteringBuilder.cxx
     Interactions/Source/KSIntSurfaceMultiplicationBuilder.cxx
     Interactions/Source/KSIntSurfaceSpinFlipBuilder.cxx
     Interactions/Source/KESSSurfaceInteractionBuilder.cxx

Kassiopeia/Bindings/Interactions/Include/KSIntSurfaceScatteringBuilder.h

@@ -0,0 +1,47 @@
+//////////////////////////////////////////////////////////////////////////
+// Routine to simulate scattering of an electron on a surface with a given
+// probability for backscattering of the electron and a given probability 
+// for production of a secondary electron from the surface.
+//////////////////////////////////////////////////////////////////////////
+#ifndef Kassiopeia_KSIntSurfaceScatteringBuilder_h_
+#define Kassiopeia_KSIntSurfaceScatteringBuilder_h_
+
+#include "KComplexElement.hh"
+#include "KSIntSurfaceScattering.h"
+
+using namespace Kassiopeia;
+namespace katrin
+{
+  typedef KComplexElement<KSIntSurfaceScattering> KSIntSurfaceScatteringBuilder;
+
+  template<> inline bool KSIntSurfaceScatteringBuilder::AddAttribute(KContainer* aContainer)
+    {
+      if (aContainer->GetName() == "name") {
+          aContainer->CopyTo(fObject, &KNamed::SetName);
+          return true;
+      }
+      if (aContainer->GetName() == "sec_electron_probability") {
+          aContainer->CopyTo(fObject, &KSIntSurfaceScattering::SetSecElectronProbability);
+          return true;
+      }
+      if (aContainer->GetName() == "sec_electron_mean_energy") {
+          aContainer->CopyTo(fObject, &KSIntSurfaceScattering::SetSecElectronMeanEnergy);
+          return true;
+      }
+      if (aContainer->GetName() == "scat_probability") {
+          aContainer->CopyTo(fObject, &KSIntSurfaceScattering::SetScatProbability);
+          return true;
+      }
+      if (aContainer->GetName() == "scat_loss_fraction") {
+          aContainer->CopyTo(fObject, &KSIntSurfaceScattering::SetScatLossFraction);
+          return true;
+      }
+      if (aContainer->GetName() == "side") {
+        aContainer->CopyTo(fObject, &KSIntSurfaceScattering::SetSide);
+        return true;
+      }
+      return false;
+    }
+}  // namespace katrin
+
+#endif

Kassiopeia/Bindings/Interactions/Source/KSIntSurfaceScatteringBuilder.cxx

@@ -0,0 +1,25 @@
+//////////////////////////////////////////////////////////////////////////
+// Routine to simulate scattering of an electron on a surface with a given
+// probability for backscattering of the electron and a given probability 
+// for production of a secondary electron from the surface.
+//////////////////////////////////////////////////////////////////////////
+#include "KSIntSurfaceScatteringBuilder.h"
+
+#include "KSRootBuilder.h"
+
+using namespace Kassiopeia;
+using namespace std;
+
+namespace katrin
+{
+  template<> KSIntSurfaceScatteringBuilder::~KComplexElement() = default;
+
+  STATICINT sKSIntSurfaceScatteringStructure = KSIntSurfaceScatteringBuilder::Attribute<std::string>("name") +
+                                               KSIntSurfaceScatteringBuilder::Attribute<double>("sec_electron_probability") +
+                                               KSIntSurfaceScatteringBuilder::Attribute<double>("sec_electron_mean_energy") +
+                                               KSIntSurfaceScatteringBuilder::Attribute<double>("scat_probability") +
+                                               KSIntSurfaceScatteringBuilder::Attribute<double>("scat_loss_fraction") +
+                                               KSIntSurfaceScatteringBuilder::Attribute<std::string>("side");
+
+  STATICINT sKSIntSurfaceScatteringElement = KSRootBuilder::ComplexElement<KSIntSurfaceScattering>("ksint_surface_scattering");
+}  // namespace katrin

Kassiopeia/Interactions/CMakeLists.txt

@@ -29,6 +29,7 @@ set( INTERACTIONS_HEADER_BASENAMES
     KSIntSurfaceSpecular.h
     KSIntSurfaceUCN.h
     KSIntSurfaceDiffuse.h
+    KSIntSurfaceScattering.h
     KSIntSurfaceMultiplication.h
 
     KSIntSurfaceSpinFlip.h
@@ -84,6 +85,7 @@ set( INTERACTIONS_SOURCE_BASENAMES
     KSIntSurfaceSpecular.cxx
     KSIntSurfaceUCN.cxx
     KSIntSurfaceDiffuse.cxx
+    KSIntSurfaceScattering.cxx
     KSIntSurfaceMultiplication.cxx
 
     KSIntSurfaceSpinFlip.cxx

Kassiopeia/Interactions/Include/KSIntSurfaceScattering.h

@@ -0,0 +1,83 @@
+//////////////////////////////////////////////////////////////////////////
+// Routine to simulate scattering of an electron on a surface with a given
+// probability for backscattering of the electron and a given probability 
+// for production of a secondary electron from the surface.
+//////////////////////////////////////////////////////////////////////////
+#ifndef Kassiopeia_KSIntSurfaceScattering_h_
+#define Kassiopeia_KSIntSurfaceScattering_h_
+
+#include "KField.h"
+#include "KSInteractionsMessage.h"
+#include "KSSurfaceInteraction.h"
+#include "KThreeVector.hh"
+
+#include <string>
+namespace Kassiopeia
+{
+
+class KSStep;
+
+enum class KSIntSurfaceScatteringSide
+{
+    Both,
+    Top,
+    Bottom
+};
+
+class KSIntSurfaceScattering : public KSComponentTemplate<KSIntSurfaceScattering, KSSurfaceInteraction>
+{
+  public:
+    KSIntSurfaceScattering();
+    KSIntSurfaceScattering(const KSIntSurfaceScattering& aCopy);
+    KSIntSurfaceScattering* Clone() const override;
+    ~KSIntSurfaceScattering() override;
+
+  public:
+    void ExecuteInteraction(const KSParticle& anInitialParticle,
+                                  KSParticle& aFinalParticle,
+                                  KSParticleQueue& aSecondaries) override;
+    void CreateSecondaryElectron(const KSParticle& anInitialParticle,
+                                       KSParticle& aFinalParticle,
+                                       KSParticleQueue& aSecondaries);
+    void ExecuteReflection(const KSParticle& anInitialParticle,
+                                 KSParticle& aFinalParticle,
+                                 KSParticleQueue& aSecondaries);
+    katrin::KThreeVector GetReflectionDirection(const KSParticle& anInitialParticle,
+                                        const double tSinTheta,
+                                        const double tCosTheta,
+                                        const double tAzimuthalAngle);
+
+    void SetSide(std::string side_name)
+    {
+        if (side_name == "both") {
+            fSide = KSIntSurfaceScatteringSide::Both;
+            return;
+        }
+
+        if (side_name == "top") {
+            fSide = KSIntSurfaceScatteringSide::Top;
+            return;
+        }
+
+        if (side_name == "bottom") {
+            fSide = KSIntSurfaceScatteringSide::Bottom;
+            return;
+        }
+
+       intmsg(eError) << "surface diffuse interaction named <" << GetName()
+        << "> does not understand side <" << side_name
+        << ">. Valid sides are: both, top, bottom." << eom;
+       return;
+    }
+
+  public:
+    K_SET_GET(double, ScatProbability)
+    K_SET_GET(double, ScatLossFraction)
+    K_SET_GET(double, SecElectronProbability)
+    K_SET_GET(double, SecElectronMeanEnergy)
+    K_SET_GET(KSIntSurfaceScatteringSide, Side)
+};
+
+}  // namespace Kassiopeia
+
+#endif