swiftest.SwiftestDataArray.magnitude

swiftest.SwiftestDataArray.magnitude#

SwiftestDataArray.magnitude(name=None)[source]#

Computes the magnitude of a vector quantity. Note: The DataArray must have the “space” dimension.

Parameters:

name (str, optional) – Name of the new DataArray. By default, the string “_mag” is appended to the original name.

Returns:

mag (SwiftestDataArray) – DataArray containing the magnitude of the vector quantity