Skip to content
Snippets Groups Projects
Commit ae52fe67 authored by Hu Zhao's avatar Hu Zhao
Browse files

docs: update docstrings

parent bd4d18cd
No related branches found
No related tags found
No related merge requests found
...@@ -217,14 +217,15 @@ class MassPointModel: ...@@ -217,14 +217,15 @@ class MassPointModel:
------- -------
output: numpy array output: numpy array
Time history of the mass point's location and velocity. Time history of the mass point's location and velocity.
:code`output.shape[1]` is :math:`6`. More specifically: 2d :class:`numpy.ndarray`. Each row corresponds to a time step and
:code:`output[:,0]` contains the time steps, each column corresponds to a quantity. In total :math:`6` columns,
:code:`output[:,1]` contains the `x` coordinates, namely :code:`output.shape[1]=6`. More specifically:
:code:`output[:,2]` contains the `y` coordinates, :code:`output[:,0]` are the time steps,
:code:`output[:,3]` contains velocity values in `x` direction, :code:`output[:,1]` are the `x` coordinates,
:code:`output[:,4]` contains velocity values in `y` direction, :code:`output[:,2]` are the `y` coordinates,
:code:`output[:,5]` contains total velocity values. :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 = \ fgrad_x, fgrad_y, fgrad_xx, fgrad_yy, fgrad_xy = \
self._preprocess(elevation, x0, y0) self._preprocess(elevation, x0, y0)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment