Skip to content

WaterlooFieldHandle

WaterlooFieldHandle

Opaque handle to a fitted velocity field.

Returned by both fit_waterloo() and fit_sspa(). Pass this handle to run_simulation() to perform particle tracking.

is_loaded

is_loaded() -> bool

Return True if the fitted field data is resident in memory.

method_name

method_name() -> str

Return the name of the fitting method used (e.g. "waterloo" or "sspa").

n_cells

n_cells() -> int

Return the number of cells in the underlying grid.