diff --git a/src/psimpy/simulator/mass_point_model.py b/src/psimpy/simulator/mass_point_model.py index a38d2442ac8dfc946575d1fcfd96c3cc6ef16b81..5d3e14e5a0236ea7f09d003c2a35b57b82ea5770 100644 --- a/src/psimpy/simulator/mass_point_model.py +++ b/src/psimpy/simulator/mass_point_model.py @@ -216,15 +216,16 @@ class MassPointModel: Returns ------- output: numpy array - Time history of the mass point's location and velocity. - :code`output.shape[1]` is :math:`6`. More specifically: - :code:`output[:,0]` contains the time steps, - :code:`output[:,1]` contains the `x` coordinates, - :code:`output[:,2]` contains the `y` coordinates, - :code:`output[:,3]` contains velocity values in `x` direction, - :code:`output[:,4]` contains velocity values in `y` direction, - :code:`output[:,5]` contains total velocity values. - + Time history of the mass point's location and velocity. + 2d :class:`numpy.ndarray`. Each row corresponds to a time step and + each column corresponds to a quantity. In total :math:`6` columns, + namely :code:`output.shape[1]=6`. More specifically: + :code:`output[:,0]` are the time steps, + :code:`output[:,1]` are the `x` coordinates, + :code:`output[:,2]` are the `y` coordinates, + :code:`output[:,3]` are velocity values in `x` direction, + :code:`output[:,4]` are velocity values in `y` direction, + :code:`output[:,5]` are total velocity values. """ fgrad_x, fgrad_y, fgrad_xx, fgrad_yy, fgrad_xy = \ self._preprocess(elevation, x0, y0)