Skip to content
This repository was archived by the owner on Aug 28, 2024. It is now read-only.

Commit

Permalink
Fixed typo
Browse files Browse the repository at this point in the history
  • Loading branch information
daminton committed Feb 25, 2023
1 parent 89305ee commit 75f936b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions python/swiftest/swiftest/simulation_class.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,15 +109,15 @@ def __init__(self,read_param: bool = False,
The step size of the simulation. `dt` must be less than or equal to `tstop-tstart`.
Parameter input file equivalent: `DT`
istep_out : int, optional
The number of time steps between output saves to file. *Note*: only `istep_out` or `toutput` can be set.
The number of time steps between output saves to file. *Note*: only `istep_out` or `tstep_out` can be set.
Parameter input file equivalent: `ISTEP_OUT`
dump_cadence : int, optional
The number of output steps (given by `istep_out`) between when the saved data is dumped to a file. Setting it to 0
is equivalent to only dumping data to file at the end of the simulation. Default value is 10.
Parameter input file equivalent: `DUMP_CADENCE`
tstep_out : float, optional
The approximate time between when outputs are written to file. Passing this computes
`istep_out = floor(tstep_out/dt)`. *Note*: only `istep_out` or `toutput` can be set.
`istep_out = floor(tstep_out/dt)`. *Note*: only `istep_out` or `tstep_out` can be set.
Parameter input file equivalent: None
init_cond_file_type : {"NETCDF_DOUBLE", "NETCDF_FLOAT", "ASCII"}, default "NETCDF_DOUBLE"
The file type containing initial conditions for the simulation:
Expand Down Expand Up @@ -588,10 +588,10 @@ def set_simulation_time(self,
dt : float, optional
The step size of the simulation. `dt` must be less than or equal to `tstop-dstart`.
istep_out : int, optional
The number of time steps between outputs to file. *Note*: only `istep_out` or `toutput` can be set.
The number of time steps between outputs to file. *Note*: only `istep_out` or `tstep_out` can be set.
tstep_out : float, optional
The approximate time between when outputs are written to file. Passing this computes
`istep_out = floor(tstep_out/dt)`. *Note*: only `istep_out` or `toutput` can be set.
`istep_out = floor(tstep_out/dt)`. *Note*: only `istep_out` or `tstep_out` can be set.
dump_cadence : int, optional
The number of output steps (given by `istep_out`) between when the saved data is dumped to a file. Setting it to 0
is equivalent to only dumping data to file at the end of the simulation. Default value is 10.
Expand Down

0 comments on commit 75f936b

Please sign in to comment.