diff options
| author |  David Grote <grote1@llnl.gov>
| 2021-07-12 09:08:16 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2021-07-12 09:08:16 -0700 |
| commit | 13bb45254d82cd6c945846f2d18b2fcbbc2ad008 (patch) | |
| tree | 53099127bcacbafd91f387b0ab0a19c9d0a79644 /Python/pywarpx/WarpInterface.py | |
| parent | f462adc324cf466b60d62bc8c06c035221b75861 (diff) | |
| download | WarpX-13bb45254d82cd6c945846f2d18b2fcbbc2ad008.tar.gz WarpX-13bb45254d82cd6c945846f2d18b2fcbbc2ad008.tar.zst WarpX-13bb45254d82cd6c945846f2d18b2fcbbc2ad008.zip | |
Update Python module comments (#2073)
* Added explanatory comments in timestepper.py
* Add comments to WarpInterface.py
* Added comments to WarpXPIC.py
Diffstat (limited to 'Python/pywarpx/WarpInterface.py')
| -rw-r--r-- | Python/pywarpx/WarpInterface.py | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/Python/pywarpx/WarpInterface.py b/Python/pywarpx/WarpInterface.py index 91217ef1e..46c38ffdc 100644 --- a/Python/pywarpx/WarpInterface.py +++ b/Python/pywarpx/WarpInterface.py @@ -4,6 +4,16 @@ # # License: BSD-3-Clause-LBNL +# This sets up an interface between Warp and WarpX, allowing access to WarpX data using +# classes from Warp. + +# The routine warp_species will return an instance of the Species class from Warp, +# giving nearly all of the capability of that class, including accessing the data +# using down selection and all of the plots. + +# The class WarpX_EM3D inherits from Warp's EM3D class. It primarily provides +# access to the field plotting routines. + import warp from . import fields from pywarpx import PGroup @@ -176,4 +186,3 @@ class WarpX_EM3D(warp.EM3D): self.nz = picmi_grid.number_of_cells[-1] self.zgrid = 0. # --- This should be obtained from WarpX - |