lagrangian.Position

class lagrangian.Position

Bases: pybind11_builtins.pybind11_object

Define the position of N points Mᵢ = (xᵢ, yᵢ)

__init__(*args, **kwargs)

Overloaded function.

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

Default constructor

Note

This constructor may lead to an error in diagnostic because start time is set to zero: if stencil has not been advected then delta_t is equal to minus advection starting time (- start_time_) which is not correct. (see FiniteLyapunovExponentsIntegration::ComputeExponents in integration.cpp)

  1. __init__(self: lagrangian.core.Position, start_time: lagrangian::DateTime, spherical_equatorial: bool = True) -> None

Constructor with start_time setting

Parameters

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

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

Methods

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

To move a particle with a velocity field.

Position.max_distance(self)

Compute the distance max

Position.strain_tensor(self)

Position.xi(self)

Returns the x-axis of the point

Position.yi(self)

Returns the y-axis of the point

Attributes

Position.is_completed

Test if the integration is over

Position.missing

True if the integration is complete.

Position.time

Returns the time at the end of the integration