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/timestepper.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/timestepper.py')
| -rw-r--r-- | Python/pywarpx/timestepper.py | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/Python/pywarpx/timestepper.py b/Python/pywarpx/timestepper.py index fb8151d43..180bd845e 100644 --- a/Python/pywarpx/timestepper.py +++ b/Python/pywarpx/timestepper.py @@ -1,13 +1,21 @@ -# Copyright 2017-2018 Andrew Myers, David Grote, Weiqun Zhang +# Copyright 2017-2021 Andrew Myers, David Grote, Weiqun Zhang # # # This file is part of WarpX. # # License: BSD-3-Clause-LBNL +# This is intended to be a Python level example of how one might write a customized +# time stepping loop. This would replace the functionality of the WarpX::Evolve routine. +# Wrappers are available for the major pieces of a time step and they would be called +# here in the appropriate order. +# Note that this is intended to be an example only and may not be functional. The +# onestep routine as written here is out of date and is not consistent with WarpX::Evolve. + from ._libwarpx import libwarpx from . import callbacks + class TimeStepper(object): def step(self, nsteps=1): |