|
| def | __init__ (self, a, c, orientation, source_pos, n_points, start_time) |
| |
| def | update (self, t=0.0) |
| |
|
| string | LABEL = 'spheroid' |
| |
Plume model to generate a static plume with spheroid form.
Definition at line 20 of file spheroid.py.
| def uuv_plume_model.spheroid.PlumeSpheroid.__init__ |
( |
|
self, |
|
|
|
a, |
|
|
|
c, |
|
|
|
orientation, |
|
|
|
source_pos, |
|
|
|
n_points, |
|
|
|
start_time |
|
) |
| |
Spheroid plume class constructor.
> **Parameters**
* `a` and `c` (*type:* `float`): length of the ellipsoid's principal
semi-axes
* `orientation` (*type:* `list`): quaternion describing the orientation
of the ellipsoid
* `n_points` (*type:* `int`): maximum number of plume particles
* `start_time` (*type:* `float`): time stamp for the creation of
the plume model
Definition at line 25 of file spheroid.py.
| def uuv_plume_model.spheroid.PlumeSpheroid.update |
( |
|
self, |
|
|
|
t = 0.0 |
|
) |
| |
Update the position of all particles and create/remove particles from
the plume according to the bounding box limit constraints and the
maximum number of particles allowed.
> **Parameters**
* `t` (*type: `float`): current time stamp in seconds
> **Returns**
`True` if update was succesful, `False` if computed time step is invalid.
Definition at line 50 of file spheroid.py.
| uuv_plume_model.spheroid.PlumeSpheroid._a |
|
private |
| uuv_plume_model.spheroid.PlumeSpheroid._c |
|
private |
| uuv_plume_model.spheroid.PlumeSpheroid._pnts |
|
private |
| uuv_plume_model.spheroid.PlumeSpheroid._rot |
|
private |
| uuv_plume_model.spheroid.PlumeSpheroid._t |
|
private |
| uuv_plume_model.spheroid.PlumeSpheroid._time_creation |
|
private |
| string uuv_plume_model.spheroid.PlumeSpheroid.LABEL = 'spheroid' |
|
static |
The documentation for this class was generated from the following file:
