change documentation

- change TBG_macros.cfg documentation
- remove emty line in CountParticles.hpp

doc/TBG_macros.cfg

@@ -88,67 +88,67 @@ TBG_movingWindow="-m"
 ##  
 ## placeholders must be substituted with the real data name
 ##
-## SPECIES = species name e.g. e (electrons), i (ions)
-## FIELDS  = field names e.g. FieldE, FieldB, FieldJ
+## <species> = species name e.g. e (electrons), i (ions)
+## <field>  = field names e.g. FieldE, FieldB, FieldJ
 ################################################################################
 
 # The following flags are available for the radiation plugin.
 # For a full description, see the plugins section in the online wiki.
-#--SPECIES_radiation.period 	Radiation is calculated every .period steps. Currently 0 or 1
-#--SPECIES_radiation.dump 	Period, after which the calculated radiation data should be dumped to the file system
-#--SPECIES_radiation.lastRadiation 	If set to 1, the spectra summed between the last and the current dump-time-step are stored
-#--SPECIES_radiation.folderLastRad 	Folder in which the summed spectra are stored
-#--SPECIES_radiation.totalRadiation 	Set to 1 to store spectra summed from simulation start till current time step
-#--SPECIES_radiation.folderTotalRad 	Folder in which total radiation spectra are stored
-#--SPECIES_radiation.start 	Time step to start calculating the radition
-#--SPECIES_radiation.end 	Time step to stop calculating the radiation
-#--SPECIES_radiation.omegaList 	If spectrum frequencies are taken from a file, this gives the path to this list
-#--SPECIES_radiation.radPerGPU 	If set to 1, each GPU stores its own spectra without summing the entire simulation area
-#--SPECIES_radiation.folderRadPerGPU 	Folder where the GPU specific spectras are stored
-TBG_radiation="--SPECIES_radiation.period 1 --SPECIES_radiation.dump 2 --SPECIES_radiation.totalRadiation 1 \
-               --SPECIES_radiation.lastRadiation 0 --SPECIES_radiation.start 2800 --SPECIES_radiation.end 3000"
+#--<species>_radiation.period 	Radiation is calculated every .period steps. Currently 0 or 1
+#--<species>_radiation.dump 	Period, after which the calculated radiation data should be dumped to the file system
+#--<species>_radiation.lastRadiation 	If set to 1, the spectra summed between the last and the current dump-time-step are stored
+#--<species>_radiation.folderLastRad 	Folder in which the summed spectra are stored
+#--<species>_radiation.totalRadiation 	Set to 1 to store spectra summed from simulation start till current time step
+#--<species>_radiation.folderTotalRad 	Folder in which total radiation spectra are stored
+#--<species>_radiation.start 	Time step to start calculating the radition
+#--<species>_radiation.end 	Time step to stop calculating the radiation
+#--<species>_radiation.omegaList 	If spectrum frequencies are taken from a file, this gives the path to this list
+#--<species>_radiation.radPerGPU 	If set to 1, each GPU stores its own spectra without summing the entire simulation area
+#--<species>_radiation.folderRadPerGPU 	Folder where the GPU specific spectras are stored
+TBG_radiation="--<species>_radiation.period 1 --<species>_radiation.dump 2 --<species>_radiation.totalRadiation 1 \
+               --<species>_radiation.lastRadiation 0 --<species>_radiation.start 2800 --<species>_radiation.end 3000"
 
 
 # Create 2D images in PNG format every .period steps.
 # The slice plane is defined using .axis [yx,yz] and .slicePoint (offset from origin
 # as a float within [0.0,1.0].
 # The output folder can be set with .folder.
 # Can be used more than once to print different images, e.g. for YZ and YX planes.
-TBG_SPECIES_pngYZ="--SPECIES_png.period 10 --SPECIES_png.axis yz --SPECIES_png.slicePoint 0.5 --SPECIES_png.folder pngElectronsYZ"
-TBG_SPECIES_pngYX="--SPECIES_png.period 10 --SPECIES_png.axis yx --SPECIES_png.slicePoint 0.5 --SPECIES_png.folder pngElectronsYX"
+TBG_<species>_pngYZ="--<species>_png.period 10 --<species>_png.axis yz --<species>_png.slicePoint 0.5 --<species>_png.folder pngElectronsYZ"
+TBG_<species>_pngYX="--<species>_png.period 10 --<species>_png.axis yx --<species>_png.slicePoint 0.5 --<species>_png.folder pngElectronsYX"
 
 
 # Notification period of position plugin (single-particle debugging)
-TBG_SPECIES_pos_dbg="--SPECIES_position.period 1"
+TBG_<species>_pos_dbg="--<species>_position.period 1"
 
 
 # Create a particle-energy histogram [in keV] per species for every .period steps
-TBG_SPECIES_Histogram="--SPECIES_energyHistogram.period 500 --SPECIES_energyHistogram.binCount 1024 \
-                       --SPECIES_energyHistogram.minEnergy 0 --SPECIES_energyHistogram.maxEnergy 500000"
+TBG_<species>_Histogram="--<species>_energyHistogram.period 500 --<species>_energyHistogram.binCount 1024 \
+                       --<species>_energyHistogram.minEnergy 0 --<species>_energyHistogram.maxEnergy 500000"
 
 
 # Calculate a 2D phase space
 # - requires parallel libSplash for HDF5 output
 # - momentum range in m_e c
-TBG_SPECIES_PSxpx="--SPECIES_phaseSpace.period 10 --SPECIES_phaseSpace.space x --SPECIES_phaseSpace.momentum px --SPECIES_phaseSpace.min -1.0 --SPECIES_phaseSpace.max 1.0"
-TBG_SPECIES_PSxpz="--SPECIES_phaseSpace.period 10 --SPECIES_phaseSpace.space x --SPECIES_phaseSpace.momentum pz --SPECIES_phaseSpace.min -1.0 --SPECIES_phaseSpace.max 1.0"
-TBG_SPECIES_ePSypx="--SPECIES_phaseSpace.period 10 --SPECIES_phaseSpace.space y --SPECIES_phaseSpace.momentum px --SPECIES_phaseSpace.min -1.0 --SPECIES_phaseSpace.max 1.0"
-TBG_SPECIES_PSypy="--SPECIES_phaseSpace.period 10 --SPECIES_phaseSpace.space y --SPECIES_phaseSpace.momentum py --SPECIES_phaseSpace.min -1.0 --SPECIES_phaseSpace.max 1.0"
-TBG_SPECIES_PSypz="--SPECIES_phaseSpace.period 10 --SPECIES_phaseSpace.space y --SPECIES_phaseSpace.momentum pz --SPECIES_phaseSpace.min -1.0 --SPECIES_phaseSpace.max 1.0"
+TBG_<species>_PSxpx="--<species>_phaseSpace.period 10 --<species>_phaseSpace.space x --<species>_phaseSpace.momentum px --<species>_phaseSpace.min -1.0 --<species>_phaseSpace.max 1.0"
+TBG_<species>_PSxpz="--<species>_phaseSpace.period 10 --<species>_phaseSpace.space x --<species>_phaseSpace.momentum pz --<species>_phaseSpace.min -1.0 --<species>_phaseSpace.max 1.0"
+TBG_<species>_ePSypx="--<species>_phaseSpace.period 10 --<species>_phaseSpace.space y --<species>_phaseSpace.momentum px --<species>_phaseSpace.min -1.0 --<species>_phaseSpace.max 1.0"
+TBG_<species>_PSypy="--<species>_phaseSpace.period 10 --<species>_phaseSpace.space y --<species>_phaseSpace.momentum py --<species>_phaseSpace.min -1.0 --<species>_phaseSpace.max 1.0"
+TBG_<species>_PSypz="--<species>_phaseSpace.period 10 --<species>_phaseSpace.space y --<species>_phaseSpace.momentum pz --<species>_phaseSpace.min -1.0 --<species>_phaseSpace.max 1.0"
 
 
 # Sum up total energy every .period steps for
-# - species   (--SPECIES_energy)
+# - species   (--<species>_energy)
 # - fields    (--fields_energy)
-TBG_sumEnergy="--fields_energy.period 10 --SPECIES_energy.period 10"
+TBG_sumEnergy="--fields_energy.period 10 --<species>_energy.period 10"
 
 
 # Count the number of macro particles per species for every .period steps
-TBG_macroCount="--SPECIES_macroParticlesCount.period 100"
+TBG_macroCount="--<species>_macroParticlesCount.period 100"
 
 
 # Count makro particles of a species per super cell
-TBG_countPerSuper="--SPECIES_macroParticlesPerSuperCell.period 100 --SPECIES_macroParticlesPerSuperCell.period 100"
+TBG_countPerSuper="--<species>_macroParticlesPerSuperCell.period 100 --<species>_macroParticlesPerSuperCell.period 100"
 
 # Dump simulation data (fields and particles) to HDF5 files using libSplash.
 # Data is dumped every .period steps to the fileset .file.
@@ -175,10 +175,10 @@ TBG_restart="--restart"
 #   --restart-directory /path/to/simOutput/checkpoints
 
 # Connect to a live-view server (start the server in advance)
-TBG_liveViewYX="--SPECIES_liveView.period 1 --SPECIES_liveView..slicePoint 0.5 --SPECIES_liveView..ip 10.0.2.254 \
-                --SPECIES_liveView..port 2020 --SPECIES_liveView..axis yx"
-TBG_liveViewYZ="--SPECIES_liveView..period 1 --SPECIES_liveView.slicePoint 0.5 --SPECIES_liveView.ip 10.0.2.254 \
-                --SPECIES_liveView.port 2021 --SPECIES_liveView.axis yz"
+TBG_liveViewYX="--<species>_liveView.period 1 --<species>_liveView.slicePoint 0.5 --<species>_liveView.ip 10.0.2.254 \
+                --<species>_liveView.port 2020 --<species>_liveView.axis yx"
+TBG_liveViewYZ="--<species>_liveView.period 1 --<species>_liveView.slicePoint 0.5 --<species>_liveView.ip 10.0.2.254 \
+                --<species>_liveView.port 2021 --<species>_liveView.axis yz"
 
 
 ################################################################################

src/picongpu/include/plugins/CountParticles.hpp

@@ -80,7 +80,6 @@ class CountParticles : public ISimulationPlugin
     notifyPeriod(0),
     writeToFile(false)
     {
-
         Environment<>::get().PluginConnector().registerPlugin(this);
     }