Skip to content

Commit dc97b3d

Browse files
authored
docs: add units to seconds based timesteps (#649)
1 parent ee00684 commit dc97b3d

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/NumericalSolver.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_NumericalSolver(pyb
101101
Args:
102102
log_type (NumericalSolver.LogType): The type of logging.
103103
stepper_type (NumericalSolver.StepperType): The type of stepper.
104-
time_step (float): The time step.
104+
time_step (float): The time step (in seconds).
105105
relative_tolerance (float): The relative tolerance.
106106
absolute_tolerance (float): The absolute tolerance.
107107
root_solver (RootSolver, optional): The root solver. Defaults to RootSolver.Default().
@@ -292,7 +292,7 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_NumericalSolver(pyb
292292
293293
Args:
294294
stepper_type (NumericalSolver.StepperType): The type of stepper.
295-
time_step (float): The time step.
295+
time_step (float): The time step (in seconds).
296296
297297
Returns:
298298
NumericalSolver: The numerical solver.
@@ -321,7 +321,7 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_NumericalSolver(pyb
321321
Return a conditional numerical solver.
322322
323323
Args:
324-
time_step (float): The time step.
324+
time_step (float): The time step (in seconds).
325325
relative_tolerance (float): The relative tolerance.
326326
absolute_tolerance (float): The absolute tolerance.
327327
state_logger (StateLogger, optional): The state logger. Defaults to None.

include/OpenSpaceToolkit/Astrodynamics/Trajectory/State/NumericalSolver.hpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ class NumericalSolver : public MathNumericalSolver
5656
/// numerical integration
5757
/// @param aStepperType An enum indicating the type of numerical stepper used to perform
5858
/// integration
59-
/// @param aTimeStep A number indicating the initial guess time step the numerical solver will
59+
/// @param aTimeStep A number indicating the initial guess time step (in seconds) the numerical solver will
6060
/// take
6161
/// @param aRelativeTolerance A number indicating the relative integration tolerance
6262
/// @param anAbsoluteTolerance A number indicating the absolute integration tolerance
@@ -144,7 +144,7 @@ class NumericalSolver : public MathNumericalSolver
144144

145145
/// @brief Create a fixed step size numerical solver.
146146
///
147-
/// @param aTimeStep The time step to use for integration.
147+
/// @param aTimeStep The time step (in seconds) to use for integration.
148148
/// @param aSystemOfEquations System of equations to integrate.
149149
///
150150
/// @return A fixed step size numerical solver.
@@ -158,7 +158,7 @@ class NumericalSolver : public MathNumericalSolver
158158

159159
/// @brief Create a conditional numerical solver.
160160
///
161-
/// @param aTimeStep The initial time step to use.
161+
/// @param aTimeStep The initial time step (in seconds) to use.
162162
/// @param aRelativeTolerance The relative tolerance to use.
163163
/// @param anAbsoluteTolerance The absolute tolerance to use.
164164
/// @param stateLogger A function that takes a `State` object and logs.
@@ -218,7 +218,7 @@ class NumericalSolver : public MathNumericalSolver
218218
/// numerical integration
219219
/// @param aStepperType An enum indicating the type of numerical stepper used to perform
220220
/// integration
221-
/// @param aTimeStep A number indicating the initial guess time step the numerical solver will
221+
/// @param aTimeStep A number indicating the initial guess time step (in seconds) the numerical solver will
222222
/// take
223223
/// @param aRelativeTolerance A number indicating the relative integration tolerance
224224
/// @param anAbsoluteTolerance A number indicating the absolute integration tolerance

0 commit comments

Comments
 (0)