Introduce new Param File: dimension.param

CHANGELOG.md

@@ -1,6 +1,24 @@
 Change Log / Release Log for PIConGPU
 ================================================================
 
+Open Beta RC3
+-------------
+**Date:** TBA
+
+This is the third release candidate, a *pre-beta* version.
+
+### Changes to "Open Beta RC2"
+
+**.param file changes:**
+ - `componentsConfig.param`:
+   - remove simDim defines #134
+     (example how to update your existing `componentsConfig.param`, see
+     [https://github.com/ax3l/picongpu/commit/af1f20790ad2aa15e6fc2c9a51d8c870437a5fb7])
+ - `dimension.param`: new file with simDim setting #134
+   - only add this file to your example/test/config if you want to change it
+     from the default value (3D)
+
+
 Open Beta RC2
 -------------
 **Date:** 2013-11-27
@@ -10,12 +28,12 @@ This is the second release candidate, a *pre-beta* version.
 ### Changes to "Open Beta RC1"
 
 **.param file changes:**
- - gasConfig.param:
+ - `gasConfig.param`:
    - add gasFreeFormula #96
-     (example how to update your existing gasConfig.param, see
+     (example how to update your existing `gasConfig.param`, see
      [https://github.com/ComputationalRadiationPhysics/picongpu/pull/96/files#diff-1])
    - add inner radius to gasSphereFlanks #66
-     (example how to update your existing gasConfig.param, see
+     (example how to update your existing `gasConfig.param`, see
      [https://github.com/ComputationalRadiationPhysics/picongpu/pull/66/files#diff-0])
 
 **New Features:**

examples/Bunch/include/simulation_defines/param/componentsConfig.param

@@ -22,10 +22,6 @@
 #pragma once
 
 
-#define SIMDIM DIM3
-
-const uint32_t simDim = SIMDIM;
-
 namespace picongpu
 {
 /*! Simulation Starter ---------------------------------------------------

examples/KelvinHelmholtz/include/simulation_defines/param/componentsConfig.param

@@ -22,10 +22,6 @@
 #pragma once
 
 
-#define SIMDIM DIM3
-
-const uint32_t simDim = SIMDIM;
-
 namespace picongpu
 {
     /*! Simulation Starter ---------------------------------------------------

examples/LaserWakefield/include/simulation_defines/param/componentsConfig.param

@@ -22,10 +22,6 @@
 #pragma once
 
 
-#define SIMDIM DIM3
-
-const uint32_t simDim = SIMDIM;
-
 namespace picongpu
 {
 /*! Simulation Starter ---------------------------------------------------

examples/SingleParticleCurrent/include/simulation_defines/param/componentsConfig.param

@@ -22,10 +22,6 @@
 
 #pragma once
 
-#define SIMDIM DIM3
-
-const uint32_t simDim = SIMDIM;
-
 namespace picongpu
 {
 /** Simulation Starter ---------------------------------------------------

examples/SingleParticleRadiationWithLaser/include/simulation_defines/param/componentsConfig.param

@@ -22,10 +22,6 @@
 
 #pragma once
 
-#define SIMDIM DIM3
-
-const uint32_t simDim = SIMDIM;
-
 namespace picongpu
 {
 /** Simulation Starter ---------------------------------------------------

examples/SingleParticleTest/include/simulation_defines/param/componentsConfig.param

@@ -22,10 +22,6 @@
 
 #pragma once
 
-#define SIMDIM DIM3
-
-const uint32_t simDim = SIMDIM;
-
 namespace picongpu
 {
 /** Simulation Starter ---------------------------------------------------

examples/ThermalTest/include/simulation_defines/param/componentsConfig.param

@@ -22,10 +22,6 @@
 
 #pragma once
 
-#define SIMDIM DIM3
-
-const uint32_t simDim = SIMDIM;
-
 namespace picongpu
 {
 /*! Simulation Starter ---------------------------------------------------

examples/WeibelTransverse/include/simulation_defines/param/componentsConfig.param

@@ -22,10 +22,6 @@
 #pragma once
 
 
-#define SIMDIM DIM3
-
-const uint32_t simDim = SIMDIM;
-
 namespace picongpu
 {
     /*! Simulation Starter ---------------------------------------------------

src/picongpu/include/simulation_defines/_defaultParam.loader

@@ -25,6 +25,7 @@
  */
 #pragma once
 
+#include "simulation_defines/param/dimension.param"
 #include "simulation_defines/param/precision.param"
 #include "simulation_defines/param/physicalConstants.param"
 #include "simulation_defines/param/particleDefinition.param"

src/picongpu/include/simulation_defines/param/dimension.param

@@ -0,0 +1,28 @@
+/**
+ * Copyright 2014 Axel Huebl
+ *
+ * This file is part of PIConGPU.
+ *
+ * PIConGPU is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * PIConGPU is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with PIConGPU.
+ * If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#define SIMDIM DIM3
+
+namespace picongpu
+{
+    const uint32_t simDim = SIMDIM;
+} // namespace picongpu