Merge pull request ComputationalRadiationPhysics#2530 from ax3l/topic-pngParam

visualization -> png.param

Author: PrometheusPi

docs/source/usage/param/plugins.rst

@@ -51,19 +51,19 @@ radiationObserver.param
    :path: include/picongpu/param/radiationObserver.param
    :no-link:
 
-visualization.param
-^^^^^^^^^^^^^^^^^^^
+png.param
+^^^^^^^^^
 
-.. doxygenfile:: visualization.param
+.. doxygenfile:: png.param
    :project: PIConGPU
-   :path: include/picongpu/param/visualization.param
+   :path: include/picongpu/param/png.param
    :no-link:
 
-visColorScales.param
+pngColorScales.param
 ^^^^^^^^^^^^^^^^^^^^
 
-.. doxygenfile:: visColorScales.param
+.. doxygenfile:: pngColorScales.param
    :project: PIConGPU
-   :path: include/picongpu/param/visColorScales.param
+   :path: include/picongpu/param/pngColorScales.param
    :no-link:
 

docs/source/usage/plugins/png.rst

@@ -59,13 +59,13 @@ E.g. in the following example, two different slices are visualized and stored in
 .param files
 ^^^^^^^^^^^^
 
-The two param files :ref:`visualization.param <usage-params-plugins>` and :ref:`visColorScales.param <usage-params-plugins>` are used to specify the desired output.
+The two param files :ref:`png.param <usage-params-plugins>` and :ref:`pngColorScales.param <usage-params-plugins>` are used to specify the desired output.
 
-**Specifying the field values using** ``visualization.param``
+**Specifying the field values using** ``png.param``
 
 Depending on the used prefix in the command line flags, electron and/or ion density is drawn. 
 Additionally to that, three field values can be visualized together with the particle density.
-In order to set up the visualized field values, the ``visualization.param`` needs to be changed.
+In order to set up the visualized field values, the ``png.param`` needs to be changed.
 In this file, a variety of other parameters used for the PngModule can be specified. 
 
 The ratio of the image can be set.
@@ -86,7 +86,7 @@ In order to scale the image, ``scale_to_cellsize`` needs to be set to ``true`` a
    Make sure to reduce the preview size!
 
 It  is possible to draw the borders between the GPUs used as white lines. 
-This can be done by setting the parameter ``white_box_per_GPU`` in ``visualization.param`` to ``true``
+This can be done by setting the parameter ``white_box_per_GPU`` in ``png.param`` to ``true``
 
 .. code:: cpp
 
@@ -137,11 +137,11 @@ and add different coloring:
    namespace preChannel2Col = colorScales::green;    /* draw channel 2 in green */
    namespace preChannel3Col = colorScales::none;     /* do not draw channel 3 */
 
-The colors available are defined in ``visColorScales.param`` and their usage is described below. 
+The colors available are defined in ``pngColorScales.param`` and their usage is described below. 
 If ``colorScales::none`` is used, the channel is not drawn.
 
 
-In order to specify what the three channels represent, three functions can be defined in ``visualization.param``. 
+In order to specify what the three channels represent, three functions can be defined in ``png.param``. 
 The define the values computed for the png visualization.
 The data structures used are those available in PIConGPU. 
 
@@ -174,7 +174,7 @@ Only positive values are drawn. Negative values are clipped to zero.
 In the above example, this feature is used for ``preChannel3``. 
 
 
-**Defining coloring schemes in** ``visColorScales.param``
+**Defining coloring schemes in** ``pngColorScales.param``
 
 There are several predefined color schemes available:
 

include/picongpu/_defaultParam.loader

@@ -57,8 +57,8 @@
 #include "picongpu/param/fieldBackground.param"
 
 #include "picongpu/param/fileOutput.param"
-#include "picongpu/param/visColorScales.param"
-#include "picongpu/param/visualization.param"
+#include "picongpu/param/pngColorScales.param"
+#include "picongpu/param/png.param"
 #include "picongpu/param/particleCalorimeter.param"
 #include "picongpu/param/isaac.param"
 #include "picongpu/param/radiationObserver.param"

include/picongpu/_defaultUnitless.loader

@@ -46,5 +46,5 @@
 
 #include "picongpu/unitless/fileOutput.unitless"
 #include "picongpu/unitless/checkpoints.unitless"
-#include "picongpu/unitless/visualization.unitless"
+#include "picongpu/unitless/png.unitless"
 #include "picongpu/unitless/radiation.unitless"

include/picongpu/param/visualization.param renamed to include/picongpu/param/png.param

@@ -74,7 +74,7 @@ namespace picongpu
         }
 
         /* scale the image by a user defined relative factor
-         * `scale_image` is defined in `visualization.param`
+         * `scale_image` is defined in `png.param`
          */
         float_X scale_x( scale_image );
         float_X scale_y( scale_image );

include/picongpu/param/visColorScales.param renamed to include/picongpu/param/pngColorScales.param

@@ -29,28 +29,28 @@ namespace picongpu
     //
     // setting 1: Laser
 #if( EM_FIELD_SCALE_CHANNEL1 == 1 || EM_FIELD_SCALE_CHANNEL2 == 1 || EM_FIELD_SCALE_CHANNEL3 == 1 )
-    PMACC_DEF_IN_NAMESPACE_MSG( You_can_not_scale_your_preview_to_laser_without_using_a_laser___change_visualization_param, laserProfile, AMPLITUDE );
+    PMACC_DEF_IN_NAMESPACE_MSG( You_can_not_scale_your_preview_to_laser_without_using_a_laser___change_png_param, laserProfile, AMPLITUDE );
 #endif
 
     // setting 2: Drifting Plasma
 #if( EM_FIELD_SCALE_CHANNEL1 == 2 || EM_FIELD_SCALE_CHANNEL2 == 2 || EM_FIELD_SCALE_CHANNEL3 == 2 )
-    PMACC_CASSERT_MSG( You_can_not_scale_your_preview_to_drift_without_a_initially_drifting_plasma___change_visualization_param, ((PARTICLE_INIT_DRIFT_GAMMA)>1.0) );
+    PMACC_CASSERT_MSG( You_can_not_scale_your_preview_to_drift_without_a_initially_drifting_plasma___change_png_param, ((PARTICLE_INIT_DRIFT_GAMMA)>1.0) );
 #endif
 
     // setting 3: Plasma Wave
 #if( EM_FIELD_SCALE_CHANNEL1 == 3 || EM_FIELD_SCALE_CHANNEL2 == 3 || EM_FIELD_SCALE_CHANNEL3 == 3 )
-    PMACC_CASSERT_MSG( You_can_not_scale_your_preview_to_a_zero_plasma_density___change_visualization_param, (BASE_DENSITY>0.0) );
+    PMACC_CASSERT_MSG( You_can_not_scale_your_preview_to_a_zero_plasma_density___change_png_param, (BASE_DENSITY>0.0) );
 #endif
 
     // setting 4: Thermal Warm Plasma
 #if( EM_FIELD_SCALE_CHANNEL1 == 4 || EM_FIELD_SCALE_CHANNEL2 == 4 || EM_FIELD_SCALE_CHANNEL3 == 4 )
-    PMACC_CASSERT_MSG( You_can_not_scale_your_preview_to_a_zero_plasma_density___change_visualization_param, (BASE_DENSITY>0.0) );
-    PMACC_CASSERT_MSG( You_can_not_scale_your_preview_to_a_zero_electron_temperature___change_visualization_param, ((ELECTRON_TEMPERATURE)>0.0) );
+    PMACC_CASSERT_MSG( You_can_not_scale_your_preview_to_a_zero_plasma_density___change_png_param, (BASE_DENSITY>0.0) );
+    PMACC_CASSERT_MSG( You_can_not_scale_your_preview_to_a_zero_electron_temperature___change_png_param, ((ELECTRON_TEMPERATURE)>0.0) );
 #endif
 
     // setting 5: Blow Out
 #if( EM_FIELD_SCALE_CHANNEL1 == 5 || EM_FIELD_SCALE_CHANNEL2 == 5 || EM_FIELD_SCALE_CHANNEL3 == 5 )
-    //PMACC_CASSERT_MSG( You_can_not_scale_your_preview_to_a_zero_plasma_density___change_visualization_param, (BASE_DENSITY>0.0) );
-    PMACC_DEF_IN_NAMESPACE_MSG( You_can_not_scale_your_preview_to_blowout_with_a_laser_without_beam_waist___change_visualization_param, laserProfile, W0 );
+    //PMACC_CASSERT_MSG( You_can_not_scale_your_preview_to_a_zero_plasma_density___change_png_param, (BASE_DENSITY>0.0) );
+    PMACC_DEF_IN_NAMESPACE_MSG( You_can_not_scale_your_preview_to_blowout_with_a_laser_without_beam_waist___change_png_param, laserProfile, W0 );
 #endif
 }