Fix comment formatting according to @psychocoderHPC's review suggestions.

Author: BeyondEspresso

examples/Bunch/include/simulation_defines/param/fieldBackground.param

@@ -43,11 +43,17 @@ namespace picongpu
         PMACC_ALIGN(unitField, const float3_64);
 
         /* TWTS E-fields need to be initialized on host,
-         *  so they can look up global grid dimensions. */
+         * so they can look up global grid dimensions.
+         *
+         * Note: No PMACC_ALIGN(...) used, since this *additional* memory alignment would require
+         *       roughly double the number of registers in the corresponding kernel on the device.
+         */
         const templates::twts::EField twtsFieldE;
 
         /* Constructor is host-only, because of subGrid and halfSimSize initialization */
-        HINLINE FieldBackgroundE( const float3_64 unitField ) : unitField(unitField),
+        HINLINE FieldBackgroundE( const float3_64 unitField ) :
+
+            unitField(unitField),
 
             twtsFieldE(
                 /* focus_y [m], the distance to the laser focus in y-direction */
@@ -78,8 +84,7 @@ namespace picongpu
         operator()( const DataSpace<simDim>& cellIdx,
                     const uint32_t currentStep ) const
         {
-            /* example 1: TWTS background pulse */
-            /** unit: meter */
+            /* unit: meter */
             const double WAVE_LENGTH_SI = 0.8e-6;
 
             /** UNITCONV */
@@ -92,24 +97,27 @@ namespace picongpu
                 * SI::ELECTRON_MASS_SI * SI::SPEED_OF_LIGHT_SI
                 * SI::SPEED_OF_LIGHT_SI / SI::ELECTRON_CHARGE_SI;
 
-            /** unit: W / m^2 */
-            /* const double _PEAK_INTENSITY_SI = 3.4e19 * 1.0e4; */
-            /** unit: none */
-            /* const double _A0  = _PEAK_INTENSITY_SI * UNITCONV_Intens_to_A0; */
+            /* unit: W / m^2
+             * const double _PEAK_INTENSITY_SI = 3.4e19 * 1.0e4;
+             * unit: none
+             * const double _A0  = _PEAK_INTENSITY_SI * UNITCONV_Intens_to_A0;
+             */
 
-            /** unit: none */
+            /* unit: none */
             const double _A0  = 1.0;
 
-            /** unit: Volt /meter */
-            /*\todo #738 implement math::vector, native type operations */
+            /* unit: Volt /meter
+             *\todo #738 implement math::vector, native type operations
+             */
             const float3_64 invUnitField = float3_64(1.0 / unitField[0],
                                                      1.0 / unitField[1],
                                                      1.0 / unitField[2] );
 
             /* laser amplitude in picongpu units [ unit: (Volt /meter) / unitField-factor ]
              * Note: the laser amplitude is included in all field components
              * polarization and other properties are established by the peak amplitude
-             * normalized twtsFieldE(...) */
+             * normalized twtsFieldE(...)
+             */
             const float3_X amplitude = precisionCast<float_X>(
                                 float_64(_A0 * UNITCONV_A0_to_Amplitude_SI) * invUnitField );
 
@@ -125,13 +133,19 @@ namespace picongpu
         static const bool InfluenceParticlePusher = PARAM_INCLUDE_FIELDBACKGROUND;
 
         /* TWTS B-fields need to be initialized on host,
-         * so they can look up global grid dimensions. */
+         * so they can look up global grid dimensions.
+         *
+         * Note: No PMACC_ALIGN(...) used, since this *additional* memory alignment would require
+         *       roughly double the number of registers in the corresponding kernel on the device.
+         */
         const templates::twts::BField twtsFieldB;
 
         /* We use this to calculate your SI input back to our unit system */
         PMACC_ALIGN(unitField, const float3_64);
 
-        HINLINE FieldBackgroundB( const float3_64 unitField ) : unitField(unitField),
+        HINLINE FieldBackgroundB( const float3_64 unitField ) :
+
+            unitField(unitField),
 
             twtsFieldB(
                 /* focus_y [m], the distance to the laser focus in y-direction */
@@ -162,7 +176,7 @@ namespace picongpu
         operator()( const DataSpace<simDim>& cellIdx,
                     const uint32_t currentStep ) const
         {
-            /** unit: meter */
+            /* unit: meter */
             const double WAVE_LENGTH_SI = 0.8e-6;
 
             /** UNITCONV */
@@ -175,10 +189,11 @@ namespace picongpu
                 * SI::ELECTRON_MASS_SI * SI::SPEED_OF_LIGHT_SI
                 * SI::SPEED_OF_LIGHT_SI / SI::ELECTRON_CHARGE_SI;
 
-            /** unit: W / m^2 */
-            /* const double _PEAK_INTENSITY_SI = 3.4e19 * 1.0e4; */
-            /** unit: none */
-            /* const double _A0  = _PEAK_INTENSITY_SI * UNITCONV_Intens_to_A0; */
+            /* unit: W / m^2
+             * const double _PEAK_INTENSITY_SI = 3.4e19 * 1.0e4;
+             * unit: none
+             * const double _A0  = _PEAK_INTENSITY_SI * UNITCONV_Intens_to_A0;
+             */
 
             /** unit: none */
             const double _A0  = 1.0;
@@ -191,7 +206,8 @@ namespace picongpu
             /* laser amplitude in picongpu units [ unit: (Volt/meter) / unitField-factor ]
              * Note: the laser amplitude is included in all field components
              * polarization and other properties are established by the peak amplitude
-             * normalized twtsFieldB(...) */
+             * normalized twtsFieldB(...)
+             */
             const float3_X amplitude = precisionCast<float_X>(
                     float_64(_A0 * UNITCONV_A0_to_Amplitude_SI) * invUnitField );
 

src/picongpu/include/fields/background/templates/TWTS/BField.hpp

@@ -29,10 +29,10 @@
 
 namespace picongpu
 {
-/** Load pre-defined background field */
+/* Load pre-defined background field */
 namespace templates
 {
-/** Traveling-wave Thomson scattering laser pulse */
+/* Traveling-wave Thomson scattering laser pulse */
 namespace twts
 {
 
@@ -44,8 +44,9 @@ class BField
     enum PolarizationType
     {
         /* The linear polarization of the TWTS laser is defined
-         * relative to the plane of the pulse front tilt (reference plane). */
-        /* Polarisation is normal to the reference plane.
+         * relative to the plane of the pulse front tilt (reference plane).
+         *
+         * Polarisation is normal to the reference plane.
          * Use Ex-fields (and corresponding B-fields) in TWTS laser internal coordinate system.
          */
         LINEAR_X = 1u,
@@ -58,8 +59,9 @@ class BField
     /* Center of simulation volume in number of cells */
     PMACC_ALIGN(halfSimSize,DataSpace<simDim>);
     /* y-position of TWTS coordinate origin inside the simulation coordinates [meter]
-       The other origin coordinates (x and z) default to globally centered values
-       with respect to the simulation volume. */
+     * The other origin coordinates (x and z) default to globally centered values
+     * with respect to the simulation volume.
+     */
     const PMACC_ALIGN(focus_y_SI,float_64);
     /* Laser wavelength [meter] */
     const PMACC_ALIGN(wavelength_SI,float_64);
@@ -83,7 +85,8 @@ class BField
     /* TWTS laser time delay */
     PMACC_ALIGN(tdelay,float_64);
     /* Should the TWTS laser time delay be chosen automatically, such that
-    the laser gradually enters the simulation volume? [Default: TRUE] */
+     * the laser gradually enters the simulation volume? [Default: TRUE]
+     */
     const PMACC_ALIGN(auto_tdelay,bool);
     /* Polarization of TWTS laser */
     const PMACC_ALIGN(pol,PolarizationType);