uxarray.UxDataArray.scalardotgradient#
- UxDataArray.scalardotgradient(v, q)#
Compute the dot product between a vector field and the gradient of a scalar field. The formula is: scalar_dot_gradient = u * (dq/dx) + v * (dq/dy), where u, x correspond to the zonal direction; v, y the meridional direction; and q is the scalar field.
- Parameters:
self (UxDataArray) – The zonal (u) component of the vector field.
v (UxDataArray) – The meridional (v) component of the vector field.
q (UxDataArray) – Scalar field whose gradient is dotted with the vector field.
- Returns:
scalar_dot_gradient – The dot product (self,v) dot grad(q), as a UxDataArray.
- Return type: