https://github.com/c42f/vortutils
Utilities for finding vortices in complex fields
https://github.com/c42f/vortutils
Last synced: 5 months ago
JSON representation
Utilities for finding vortices in complex fields
- Host: GitHub
- URL: https://github.com/c42f/vortutils
- Owner: c42f
- License: other
- Created: 2013-11-20T11:13:39.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2013-11-24T07:11:53.000Z (over 12 years ago)
- Last Synced: 2025-01-22T07:43:35.874Z (over 1 year ago)
- Language: Matlab
- Size: 121 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Utilities for tracing vortex lines
==================================
This repo contains some utilities for finding vortices in a complex-valued
field sampled on a regular grid in 2D or 3D. This is quite straightforward over
a 2D grid, but tracing vortex lines in 3D is a bit more involved.
The functions have resonably complete documentation comments, but here's an
overview of the more interesting functions to get you started:
3D functions
------------
* `vortex_lines_example.m` is an example script showing how to compute a 3D
visualization of the vortex lines passing through a 3D complex field. Running
this and examining the code should give you an idea of where to start.
* `vortex_trace_all()` traces all vortex lines through a 3D vorticity field
produced using `vortex_detct3d()`.
2D functions
------------
For a 2D grid, there are two functions of interest:
* `phase_winding2d()` takes a 2D grid containing complex phase and detects grid
plaquetts where that phase "winds" around by 2 pi.
* `vortex_detect2d()` takes a 2D complex field, and interpolates more exact
estimates of vortex position within the grid plaquetts. Using this method as
part of the 3D vortex tracing gives much better results.
License
-------
vortutils is licensed under the 2-clause BSD license: this basically means you
can do what you want with it, provided you keep the original attribution intact
(see LICENSE.txt for details)
The code was originally written at The University of Queensland during Chris
Foster's PhD (thesis resting in peace here: http://arxiv.org/abs/1302.0470).