Update documentation

picmi-standard · Jun 9, 2021 · 2af701c · 2af701c
1 parent 0f120b3
commit 2af701c
Show file tree

Hide file tree

Showing 121 changed files with 3,709 additions and 21,552 deletions.
diff --git a/...83a2e77b8f6c8/laser_acceleration_PICMI.py → ...9ff5bf0746100/laser_acceleration_PICMI.py b/...83a2e77b8f6c8/laser_acceleration_PICMI.py → ...9ff5bf0746100/laser_acceleration_PICMI.py
@@ -39,14 +39,6 @@
 # Numerics parameters
 # -------------------
 
-# --- geometry and solver
-em_solver_method = 'CKC'
-geometry = '3D'
-# Note that code-specific changes can be introduced with `picmi.codename`
-if picmi.codename == 'fbpic':
-    em_solver_method = 'PSATD'
-    geometry = 'RZ'
-
 # --- Nb time steps
 max_steps = 1000
 
@@ -148,7 +140,7 @@
         lower_boundary_conditions = [ None, 'open'],
         upper_boundary_conditions = ['reflective', 'open'],
         n_azimuthal_modes         = 2,
-        moving_window_velocity    = moving_window_velocity,
+        moving_window_zvelocity   = moving_window_velocity[-1],
         warpx_max_grid_size       = 32)
 
 smoother = picmi.BinomialSmoother( n_pass       = 1,
@@ -160,14 +152,16 @@
 
 # Diagnostics
 # -----------
-field_diag = picmi.FieldDiagnostic(grid = grid,
-                                    period = 100,
-                                    warpx_plot_raw_fields = 1,
-                                    warpx_plot_raw_fields_guards = 1,
-                                    warpx_plot_finepatch = 1,
-                                    warpx_plot_crsepatch = 1)
-part_diag = picmi.ParticleDiagnostic(period = 100,
-                                      species = [beam])
+field_diag = picmi.FieldDiagnostic(name = 'diag1',
+                                   grid = grid,
+                                   period = 100,
+                                   warpx_plot_raw_fields = 1,
+                                   warpx_plot_raw_fields_guards = 1,
+                                   warpx_plot_finepatch = 1,
+                                   warpx_plot_crsepatch = 1)
+part_diag = picmi.ParticleDiagnostic(name = 'diag1',
+                                     period = 100,
+                                     species = [beam])
 
 # Simulation setup
 # -----------------
@@ -193,9 +187,9 @@
                 n_macroparticles = 10**5,
                 seed = 0)
 initialize_self_field = True
-if picmi.codename != 'warpx':
+if picmi.codename == 'warpx':
     initialize_self_field = False
-sim.add_species(species=beam, layout=beam_layout, 
+sim.add_species(species=beam, layout=beam_layout,
                 initialize_self_field=initialize_self_field)
 
 # Add the diagnostics

diff --git a/_modules/index.html b/_modules/index.html
@@ -21,11 +21,11 @@
 
 
       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
-        <script type="text/javascript" src="../_static/jquery.js"></script>
-        <script type="text/javascript" src="../_static/underscore.js"></script>
-        <script type="text/javascript" src="../_static/doctools.js"></script>
-        <script type="text/javascript" src="../_static/language_data.js"></script>
-        <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
+        <script src="../_static/jquery.js"></script>
+        <script src="../_static/underscore.js"></script>
+        <script src="../_static/doctools.js"></script>
+        <script src="../_static/language_data.js"></script>
+        <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
 
     <script type="text/javascript" src="../_static/js/theme.js"></script>
 
@@ -143,7 +143,9 @@
            <div itemprop="articleBody">
 
   <h1>All modules for which code is available</h1>
-<ul><li><a href="picmistandard/fields.html">picmistandard.fields</a></li>
+<ul><li><a href="picmistandard/applied_fields.html">picmistandard.applied_fields</a></li>
+<li><a href="picmistandard/diagnostics.html">picmistandard.diagnostics</a></li>
+<li><a href="picmistandard/fields.html">picmistandard.fields</a></li>
 <li><a href="picmistandard/lasers.html">picmistandard.lasers</a></li>
 <li><a href="picmistandard/particles.html">picmistandard.particles</a></li>
 <li><a href="picmistandard/simulation.html">picmistandard.simulation</a></li>

diff --git a/_modules/picmistandard/applied_fields.html b/_modules/picmistandard/applied_fields.html
diff --git a/_modules/picmistandard/diagnostics.html b/_modules/picmistandard/diagnostics.html
diff --git a/_modules/picmistandard/fields.html b/_modules/picmistandard/fields.html
diff --git a/_modules/picmistandard/lasers.html b/_modules/picmistandard/lasers.html
diff --git a/_modules/picmistandard/particles.html b/_modules/picmistandard/particles.html
diff --git a/_modules/picmistandard/simulation.html b/_modules/picmistandard/simulation.html
diff --git a/_sources/standard/applied_field.rst.txt b/_sources/standard/applied_field.rst.txt
@@ -0,0 +1,22 @@
+Applied Field descriptions
+=============
+
+.. warning::
+
+   This section is currently in development.
+
+Constant fields
+---------------
+
+.. autoclass:: picmistandard.PICMI_ConstantAppliedField
+
+Analytic fields
+---------------
+
+.. autoclass:: picmistandard.PICMI_AnalyticAppliedField
+
+Refecting mirrors
+-----------------
+
+.. autoclass:: picmistandard.PICMI_Mirror
+
diff --git a/_sources/standard/diagnostics.rst.txt b/_sources/standard/diagnostics.rst.txt
@@ -0,0 +1,24 @@
+Diagnostics
+===========
+
+.. warning::
+
+   This section is currently in development.
+
+Standard PIC diagnostics
+------------------------
+
+.. autoclass:: picmistandard.PICMI_ParticleDiagnostic
+
+.. autoclass:: picmistandard.PICMI_FieldDiagnostic
+
+.. autoclass:: picmistandard.PICMI_ElectrostaticFieldDiagnostic
+
+Lab-frame diagnostics
+---------------------
+
+These diagnostics are used when running boosted-frame simulations.
+
+.. autoclass:: picmistandard.PICMI_LabFrameParticleDiagnostic
+
+.. autoclass:: picmistandard.PICMI_LabFrameFieldDiagnostic
diff --git a/_sources/standard/laser_profiles.rst.txt b/_sources/standard/laser_profiles.rst.txt
@@ -6,3 +6,5 @@ Laser profiles
    This section is currently in development.
 
 .. autoclass:: picmistandard.PICMI_GaussianLaser
+
+.. autoclass:: picmistandard.PICMI_AnalyticLaser
diff --git a/_sources/standard/standard.rst.txt b/_sources/standard/standard.rst.txt
@@ -17,6 +17,8 @@ Simulation and grid setup
    field
    grid
    constants
+   applied_field
+   diagnostics
 
 Particles
 ---------
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,3 +6,5 @@ Laser profiles
		This section is currently in development.

		.. autoclass:: picmistandard.PICMI_GaussianLaser

		.. autoclass:: picmistandard.PICMI_AnalyticLaser