documentation example/Bunch

examples/Bunch/documentation.yml

@@ -0,0 +1,60 @@
+--- # Documentation for the Kelvin-Helmholtz Example
+example:
+  name:        Thomson scattering from laser electron-bunch interaction
+  short:       Bunch
+  author:      Richard Pausch <r.pausch (at) hzdr.de>, Rene Widera <r.widera (at) hzdr.de>
+  maintainer:  Richard Pausch <r.pausch (at) hzdr.de>
+
+  description: |
+               This is a simulation of an electron bunch that collides
+               head-on with a laser pulse. Depending on the number of
+               electrons in the bunch, their momentum and their distribution
+               and depending on the laser wavelength and intensity,
+               the emitted radiation differs. A general description of this
+               simulation can be found in *PauschDipl. A detailed analysis of
+               this bunch simulation can be found in *Pausch13. A theoretical
+               study of the emitted radiation in head-on laser electron
+               collisions can be found in *Esarey93.  
+
+  references:
+    - PauschDipl: &PauschDipl
+        author:  Richard Pausch
+        title:   Electromagnetic Radiation from Relativistic Electrons as Characteristic Signature of their Dynamics
+        journal: Diploma Thesis TU Dresden
+        year:    2012
+        link:    http://www.hzdr.de/db/Cms?pOid=38997
+    - Pausch13: &Pausch13
+        author:  R. Pausch, A. Debus, R. Widera, K. Steiniger, A. Huebl, H. Burau, M. Bussmann, U. Schramm
+        title:   How to test and verify radiation diagnostics simulations within particle-in-cell frameworks
+        journal: Nuclear Instruments and Methods in Physics Research Section A
+        year:    2013
+        link:    http://dx.doi.org/10.1016/j.nima.2013.10.073
+    - Esarey93: &Esarey93
+        author:  E. Esarey, S. Ride, P. Sprangle
+        title:   Nonlinear Thomson scattering of intense laser pulses from beams and plasmas
+        journal: Physical Review E
+        year:    1993
+        link:    http://dx.doi.org/10.1103/PhysRevE.48.3003
+
+--- # Run-Time Tests for the Bunch Example
+test:
+  - nonlinearThomsonScattering:
+      name:        nonlinear Thomson scattering from an electron bunch Test
+      description: |
+                   This test simulates an electron bunch with an reltivistic
+                   gamma factor of gamma=5.0 with an laser with a_0=1.5.
+                   The resulting radiation should scale with the number of 
+                   real electrons (incoherent radiation). 
+      cmakeflag:   0
+      cfgfile:     submit/0032gpus.cfg
+      gpus:        16
+
+      pre-run:
+        - echo "Starting nonlinear Thomson scattering Test"
+      post-run:
+        - echo "get total electron number (from histogram)"
+        - echo "check emitted spectra (totalRad)"
+        - echo "compare with theoretical predictions:"
+        - echo "(higher harmonics, intensity, relativistic frequency shift)"
+        - echo "ok / failed"
+

examples/Bunch/include/simulation_defines/param/laserConfig.param

@@ -43,13 +43,13 @@ const double UNITCONV_A0_to_Amplitude_SI = -2.0 * PI / WAVE_LENGTH_SI * ::picong
 //const double _A0  = _PEAK_INTENSITY_SI * UNITCONV_Intens_to_A0;
 
 /** unit: none */
-//const double _A0  = 1.5;
+const double _A0  = 1.5;
 
 /** unit: Volt /meter */
-//const double AMPLITUDE_SI = _A0 * UNITCONV_A0_to_Amplitude_SI;
+const double AMPLITUDE_SI = _A0 * UNITCONV_A0_to_Amplitude_SI;
 
 /** unit: Volt /meter */
-const double AMPLITUDE_SI = 1.738e13;
+//const double AMPLITUDE_SI = 1.738e13;
 
 /** Pulse length: sigma of std. gauss for intensity (E^2)
  *  PULSE_LENGTH_SI = FWHM_of_Intensity   / [ 2*sqrt{ 2* ln(2) } ]

examples/KelvinHelmholtz/documentation.yml

@@ -12,13 +12,13 @@ example:
 
   references:
     - Alves12: &Alves12
-        author ...
+        author:  ...
         title:   ...
         journal: ...
         year:    ...
         link:    doi link!
     - Bussmann13: &Bussmann13
-        author: ...
+        author:  ...
         title:   ...
         journal: ...
         year:    ...