lagrangian.Triplet

class lagrangian.Triplet

Bases: lagrangian.core.Position

Define the position of 3 points

__init__(*args, **kwargs)

Overloaded function.

  1. __init__(self: lagrangian.core.Triplet) -> None

  2. __init__(self: lagrangian.core.Triplet, x: float, y: float, delta: float, start_time: lagrangian::DateTime, spherical_equatorial: bool = True) -> None

Construct a new object defining the position of the 3 points

Parameters

  • x (float) – Longitude of the initial point

  • y (float) – Latitude of the initial point

  • delta (float) – Initial separation in degrees of neighboring

  • start_time (datetime.datetime) – Advection starting time particles

  • spherical_equatorial (bool) – True if the coordinates system is Lon/lat otherwise false

Methods

Triplet.compute(self, rk4, it, cell)

To move a particle with a velocity field.

Triplet.max_distance(self)

Compute the distance max

Triplet.strain_tensor(self)

Triplet.xi(self)

Returns the x-axis of the point

Triplet.yi(self)

Returns the y-axis of the point

Attributes

Triplet.is_completed

Test if the integration is over

Triplet.missing

True if the integration is complete.

Triplet.time

Returns the time at the end of the integration