Change to the use of UpperCamelCase for class names

Author: kargapolov

lcode2dPy/diagnostics/diagnostics_3d.py

@@ -52,7 +52,7 @@ def dt(self, *parameters):
                 print(f'{diag} type of diagnostics is not supported.')
 
 
-class Diagnostics_f_xi:
+class DiagnosticsFXi:
     __allowed_f_xi = ['Ex', 'Ey', 'Ez', 'Bx', 'By', 'Bz', 'ne', 'nb',
                       'Ez2', 'Bz2', 'nb2', 'Phi']
                     # 'ni']
@@ -170,7 +170,7 @@ def dt(self, *params):
             self.__data[name] = []
 
 
-class Diagnostics_colormaps:
+class DiagnosticsColormaps:
     __allowed_colormaps = ['Ex', 'Ey', 'Ez', 'Bx', 'By', 'Bz', 'ne', 'nb',
                            'px', 'py', 'pz', 'Phi']
                         # 'ni']
@@ -311,7 +311,7 @@ def dt(self, *params):
             self.__data[name] = []
 
 
-class Save_run_state:
+class SaveRunState:
     def __init__(self, saving_period=1000., save_beam=False, save_plasma=False):
         self.__saving_period = saving_period
         self.__save_beam = bool(save_beam)

lcode2dPy/simulation/three_dimensional.py

@@ -15,12 +15,12 @@
 from lcode2dPy.alt_beam_generator.beam_shape import BeamShape, BeamSegmentShape
 
 # Imports for 3d simulation
-from lcode2dPy.push_solvers.push_solver_3d import PushAndSolver3d as PushAndSolver3d_cpu
+from lcode2dPy.push_solvers.push_solver_3d import PushAndSolver3d as PushAndSolver3dCPU
 from lcode2dPy.beam3d import beam as beam3d_cpu
 from lcode2dPy.plasma3d.initialization import init_plasma as init_plasma_cpu
 from lcode2dPy.plasma3d.initialization import load_plasma as load_plasma_cpu
 
-from lcode2dPy.push_solvers.push_solver_3d_gpu import PushAndSolver3d as PushAndSolver3d_gpu
+from lcode2dPy.push_solvers.push_solver_3d_gpu import PushAndSolver3d as PushAndSolver3dGPU
 from lcode2dPy.beam3d_gpu import beam as beam3d_gpu
 from lcode2dPy.plasma3d_gpu.initialization import init_plasma as init_plasma_gpu
 from lcode2dPy.plasma3d_gpu.initialization import load_plasma as load_plasma_gpu
@@ -60,6 +60,7 @@ def __init__(self, config=default_config_values, beam_parameters={},
     def __pull_config(self):
         # 0. We set __config__ as a Config class instance:
         self.__config = Config(self.config)
+        self.full_config = self.__config.config_values
 
         # Firstly, we check that the geomtry was set right:
         geometry = self.__config.get('geometry').lower()
@@ -81,12 +82,12 @@ def __pull_config(self):
         pu_type = self.__config.get('processing-unit-type').lower()
 
         if pu_type == 'cpu':
-            self.__push_solver = PushAndSolver3d_cpu(self.__config)
+            self.__push_solver = PushAndSolver3dCPU(self.__config)
             self.__init_plasma = init_plasma_cpu
             self.__load_plasma = load_plasma_cpu
             self.__beam_module = beam3d_cpu
         elif pu_type == 'gpu':
-            self.__push_solver = PushAndSolver3d_gpu(self.__config)
+            self.__push_solver = PushAndSolver3dGPU(self.__config)
             self.__init_plasma = init_plasma_gpu
             self.__load_plasma = load_plasma_gpu
             self.__beam_module = beam3d_gpu

t-step-test1-3d-gpu.ipynb

@@ -23,9 +23,9 @@
    "source": [
     "# Import required modules\n",
     "from lcode2dPy.simulation.three_dimensional import Cartesian3dSimulation\n",
-    "from lcode2dPy.diagnostics.diagnostics_3d import (Diagnostics_f_xi,\n",
-    "                                                  Diagnostics_colormaps,\n",
-    "                                                  Save_run_state)\n",
+    "from lcode2dPy.diagnostics.diagnostics_3d import (DiagnosticsFXi,\n",
+    "                                                  DiagnosticsColormaps,\n",
+    "                                                  SaveRunState)\n",
     "\n",
     "# Set some parameters of the config:\n",
     "config = {\n",
@@ -49,9 +49,9 @@
     "beam_parameters = {'current': 0.01 * (2*pi), 'particles_in_layer': 2000}\n",
     "\n",
     "# Set diagnostics\n",
-    "diag = [Diagnostics_f_xi(f_xi='Ez', output_period=0),\n",
-    "        Diagnostics_colormaps(output_period=0, colormaps='Ez'),\n",
-    "        Save_run_state(saving_period=0, save_beam=True, save_plasma=True)]"
+    "diag = [DiagnosticsFXi(f_xi='Ez', output_period=0),\n",
+    "        DiagnosticsColormaps(output_period=0, colormaps='Ez'),\n",
+    "        SaveRunState(saving_period=0, save_beam=True, save_plasma=True)]"
    ],
    "outputs": [],
    "metadata": {}

t-step-test1-3d.ipynb

@@ -2,25 +2,23 @@
  "cells": [
   {
    "cell_type": "markdown",
-   "metadata": {},
    "source": [
     "### Test 1 for lcode 3d with a single time step and an alternative beam generator."
-   ]
+   ],
+   "metadata": {}
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
-   "outputs": [],
    "source": [
     "# Import required modules\n",
     "from math import pi, inf\n",
     "\n",
     "from lcode2dPy.alt_beam_generator.beam_generator import generate_beam\n",
     "from lcode2dPy.simulation.three_dimensional import Cartesian3dSimulation\n",
-    "from lcode2dPy.diagnostics.diagnostics_3d import (Diagnostics_f_xi,\n",
-    "                                                  Diagnostics_colormaps,\n",
-    "                                                  Save_run_state)\n",
+    "from lcode2dPy.diagnostics.diagnostics_3d import (DiagnosticsFXi,\n",
+    "                                                  DiagnosticsColormaps,\n",
+    "                                                  SaveRunState)\n",
     "\n",
     "# Set some parameters of the config:\n",
     "config = {\n",
@@ -39,50 +37,50 @@
     "}\n",
     "\n",
     "# Set diagnostics\n",
-    "diag = [Diagnostics_f_xi(f_xi='Ez, Ex', output_period=0),\n",
-    "        Diagnostics_colormaps(output_period=0, colormaps='Ez'),\n",
-    "        Save_run_state(saving_period=0, save_beam=True)]"
-   ]
+    "diag = [DiagnosticsFXi(f_xi='Ez, Ex', output_period=0),\n",
+    "        DiagnosticsColormaps(output_period=0, colormaps='Ez'),\n",
+    "        SaveRunState(saving_period=0, save_beam=True)]"
+   ],
+   "outputs": [],
+   "metadata": {}
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
-   "outputs": [],
    "source": [
     "# Create a beam\n",
     "\n",
     "beam_parameters = {'current': 0.01 * (2*pi), 'particles_in_layer': 2000}\n",
     "\n",
     "beam_particles = generate_beam(config=config, beam_parameters=beam_parameters)\n",
     "beam_particles.save('beamfile_1')"
-   ]
+   ],
+   "outputs": [],
+   "metadata": {}
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
-   "outputs": [],
    "source": [
     "sim = Cartesian3dSimulation(config=config, diagnostics=diag)\n",
     "sim.load_beamfile('beamfile_1.npz')\n",
     "# sim.load_plasmastate('plasmastate.npz')"
-   ]
+   ],
+   "outputs": [],
+   "metadata": {}
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
-   "outputs": [],
    "source": [
     "sim.step()"
-   ]
+   ],
+   "outputs": [],
+   "metadata": {}
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
-   "outputs": [],
    "source": [
     "# Should work correctly. Compare results with the test 1 result with a rigid beam:\n",
     "# xi         Ez_00\n",
@@ -112,14 +110,16 @@
     "# xi=+0.4600 -6.0912e-04\n",
     "# xi=+0.4800 -6.8855e-04\n",
     "# xi=+0.5000 -7.7437e-04"
-   ]
+   ],
+   "outputs": [],
+   "metadata": {}
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "source": [],
    "outputs": [],
-   "source": []
+   "metadata": {}
   }
  ],
  "metadata": {
@@ -148,4 +148,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}