Skip to content

Commit

Permalink
minor spelling corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
acse-ej321 committed Jan 20, 2025
1 parent 6ed32cc commit 3d732b7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions thetis/solver2d.py
Original file line number Diff line number Diff line change
Expand Up @@ -964,7 +964,7 @@ def iterate(self, update_forcings=None, export_func=None):
def create_iterator(self, update_forcings=None, export_func=None):
"""
Creates a generator to iterate through the simulation and return access
to time advancing function when time control is handled eternally.
to time advancing function when time control is handled externally.
Iterates over the time loop until time ``options.simulation_end_time`` is reached.
Exports fields to disk on ``options.simulation_export_time`` intervals.
Expand All @@ -973,7 +973,7 @@ def create_iterator(self, update_forcings=None, export_func=None):
.. code-block:: python
for t in solver_obj.generator():
for t in solver_obj.create_iterator():
# user code
or, to get per time-step control:
Expand All @@ -982,7 +982,7 @@ def create_iterator(self, update_forcings=None, export_func=None):
thetis_timestepper = solver_obj.create_iterator()
while t_Thetis<t_end-timestep and .... :
while t_Thetis<t_end - timestep and .... :
t_Thetis = next(thetis_timestepper)
:kwarg update_forcings: User-defined function that takes simulation
Expand Down

0 comments on commit 3d732b7

Please sign in to comment.