aboutsummaryrefslogtreecommitdiff
path: root/Python/pywarpx/timestepper.py
diff options
context:
space:
mode:
Diffstat (limited to 'Python/pywarpx/timestepper.py')
-rw-r--r--Python/pywarpx/timestepper.py10
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):