Merge branch '48_particle_creator' into 'master'

48 particle creator

See merge request !68

.gitlab-ci.yml

@@ -22,6 +22,7 @@ build:
     - ls
     - pwd
   artifacts:
+    expire_in: 1 week
     paths:
       - build/test.log.gz
     when: on_failure

COAST/CMakeLists.txt

@@ -45,7 +45,12 @@ target_include_directories (
   PUBLIC
   $<BUILD_INTERFACE:${PROJECT_BINARY_DIR}/include>
   $<INSTALL_INTERFACE:include/include>
-  SYSTEM 
+  )
+
+target_include_directories (
+  COAST
+  SYSTEM
+  PUBLIC
   $ENV{COAST_DIR}/include
   )
 

COAST/COASTProcess.cc

-/**
+
+/*
  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
  *
  * See file AUTHORS for a list of contributors.

COAST/COASTProcess.h

+
+/*
+ * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
+ *
+ * See file AUTHORS for a list of contributors.
+ *
+ * This software is distributed under the terms of the GNU General Public
+ * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
+ * the license.
+ */
+
 #ifndef _include_corsika_coast_coastprocess_h_
 #define _include_corsika_coast_coastprocess_h_
 

COAST/COASTStack.h

 
-/**
+/*
  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
  *
  * See file AUTHORS for a list of contributors.

COAST/COASTUserLib.cc

+
+/*
+ * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
+ *
+ * See file AUTHORS for a list of contributors.
+ *
+ * This software is distributed under the terms of the GNU General Public
+ * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
+ * the license.
+ */
+
 #include <interface/CorsikaInterface.h>
 
 #include <corsika/coast/COASTProcess.h>

COAST/ParticleConversion.cc

 
-/**
+/*
  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
  *
  * See file AUTHORS for a list of contributors.

COAST/ParticleConversion.h

 
-/**
+/*
  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
  *
  * See file AUTHORS for a list of contributors.

COAST/README.md

+# COAST interface {#COASTinterface}
+
+With the COAST interface of CORSIKA 8 you can write a CORSIKA 8
+"process" class and link it to CORSIKA 7. This can be very powerful to
+benchmark new CORSIKA 8 physics code in the context of "old" CORSIKA 7
+simulations. 
+
 This is based on corsika7/trunk/coast/CoastOptions/example with an
-additional interface to CORSIKA8. 
+additional interface to CORSIKA 8. 
 
-This is an example for a "COAST user library" using CORSIKA8
+We provide a step-by-step example for a "COAST user library" using CORSIKA 8
 technology. It explains the steps, how to use the COAST_USER_LIB
 option of CORSIKA together with CORSIKA8/COAST
 

Documentation/Doxygen/Doxyfile.in

@@ -8,12 +8,13 @@ EXCLUDE_PATTERNS       = */ThirdParty/*/*
 GENERATE_HTML          = YES
 GENERATE_LATEX         = YES
 
-FILE_PATTERNS          = *.cc *.cpp *.cxx *.h *.dox *.inc
+FILE_PATTERNS          = *.cc *.cpp *.cxx *.h *.dox *.inc *.md
 EXTENSION_MAPPING      = inc=C++
 RECURSIVE              = YES
 
 SOURCE_BROWSER         = YES
 # INLINE_SOURCES
+GENERATE_TREEVIEW      = YES
 
 CLASS_DIAGRAMS         = NO
 HAVE_DOT               = YES

Documentation/Examples/cascade_example.cc

-/**
+
+/*
  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
  *
  * See file AUTHORS for a list of contributors.
@@ -256,8 +257,6 @@ int main() {
   double theta = 0.;
   double phi = 0.;
   {
-    auto particle = stack.NewParticle();
-    particle.SetPID(Code::Proton);
     HEPMomentumType P0 = sqrt(E0 * E0 - Proton::GetMass() * Proton::GetMass());
     auto momentumComponents = [](double theta, double phi, HEPMomentumType ptot) {
       return std::make_tuple(ptot * sin(theta) * cos(phi), ptot * sin(theta) * sin(phi),
@@ -268,11 +267,8 @@ int main() {
     auto plab = stack::super_stupid::MomentumVector(rootCS, {px, py, pz});
     cout << "input angles: theta=" << theta << " phi=" << phi << endl;
     cout << "input momentum: " << plab.GetComponents() / 1_GeV << endl;
-    particle.SetEnergy(E0);
-    particle.SetMomentum(plab);
-    particle.SetTime(0_ns);
-    Point p(rootCS, 0_m, 0_m, 0_m);
-    particle.SetPosition(p);
+    Point pos(rootCS, 0_m, 0_m, 0_m);
+    stack.AddParticle(Code::Proton, E0, plab, pos, 0_ns);
   }
 
   // define air shower object, run simulation

Documentation/Examples/geometry_example.cc

 
-/**
+/*
  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
  *
  * See file AUTHORS for a list of contributors.

Documentation/Examples/helix_example.cc

 
-/**
+/*
  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
  *
  * See file AUTHORS for a list of contributors.

Documentation/Examples/logger_example.cc

 
-/**
+/*
  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
  *
  * See file AUTHORS for a list of contributors.

Documentation/Examples/stack_example.cc

 
-/**
+/*
  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
  *
  * See file AUTHORS for a list of contributors.
@@ -11,6 +11,10 @@
 
 #include <corsika/particles/ParticleProperties.h>
 #include <corsika/stack/super_stupid/SuperStupidStack.h>
+
+#include <corsika/geometry/Point.h>
+#include <corsika/geometry/RootCoordinateSystem.h>
+
 #include <cassert>
 #include <iomanip>
 #include <iostream>
@@ -20,10 +24,12 @@ using namespace corsika::stack;
 using namespace std;
 
 void fill(corsika::stack::super_stupid::SuperStupidStack& s) {
+  const geometry::CoordinateSystem& rootCS =
+      geometry::RootCoordinateSystem::GetInstance().GetRootCoordinateSystem();
   for (int i = 0; i < 11; ++i) {
-    auto p = s.NewParticle();
-    p.SetPID(corsika::particles::Code::Electron);
-    p.SetEnergy(1.5_GeV * i);
+    s.AddParticle(corsika::particles::Code::Electron, 1.5_GeV * i,
+                  stack::super_stupid::MomentumVector(rootCS, {0_GeV, 0_GeV, 1_GeV}),
+                  geometry::Point(rootCS, 0_m, 0_m, 0_m), 0_ns);
   }
 }
 

Documentation/Examples/staticsequence_example.cc

 
-/**
+/*
  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
  *
  * See file AUTHORS for a list of contributors.

Environment/Environment.h

-/**
+
+/*
  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
  *
  * See file AUTHORS for a list of contributors.

Environment/FlatAtmosphere/FlatAtmosphere.h

 
-/**
+/*
  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
  *
  * See file AUTHORS for a list of contributors.

Environment/HomogeneousMedium.h

-/**
+
+/*
  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
  *
  * See file AUTHORS for a list of contributors.

Environment/IMediumModel.h

-/**
+
+/*
  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
  *
  * See file AUTHORS for a list of contributors.