Lamb_Oseen

class sunkit_image.asda.Lamb_Oseen(vmax=2.0, rmax=5, ratio_vradial=0, gamma=None, rcore=None, r=3, factor=1)

Bases: Asda

Creates an Lamb Oseen vortex.

References

• https://en.wikipedia.org/wiki/Lamb%E2%80%93Oseen_vortex

Methods Summary

get_grid(x_range, y_range)	Returns a meshgrid of the coordinates of the vortex.
get_vradial([r])	Calculate radial (expanding or shrinking) speed at radius of r.
get_vtheta([r])	Calculate rotation speed at radius of r.
get_vxvy(x_range, y_range[, x, y])	Calculates the velocity field in a meshgrid generated with x_range and y_range.

Methods Documentation

get_grid(x_range, y_range)

Returns a meshgrid of the coordinates of the vortex.

Parameters:

• x_range (list) – Range of the x coordinates of the meshgrid.

• y_range (list) – Range of the y coordinates of the meshgrid.

Returns:

tuple – Contains the meshgrids generated.

get_vradial(r=0)

Calculate radial (expanding or shrinking) speed at radius of r.

Parameters:

r (float, optional) – Radius which defaults to 0.

Returns:

float – Radial speed at the radius of r.

get_vtheta(r=0)

Calculate rotation speed at radius of r.

Parameters:

r (float, optional) – Radius which defaults to 0.

Returns:

float – Rotating speed at radius of r.

get_vxvy(x_range, y_range, x=None, y=None)

Calculates the velocity field in a meshgrid generated with x_range and y_range.

Parameters:

• x_range (list) – Range of the x coordinates of the meshgrid.

• y_range (list) – range of the y coordinates of the meshgrid.

• x (numpy.meshgrid, optional) – If both are given, x_range and y_range will be ignored. Defaults to None``.

• y (numpy.meshgrid, optional) – If both are given, x_range and y_range will be ignored. Defaults to None``.

Returns:

tuple – The generated velocity field (vx, vy).