magnitude
Synopsis
calculate the magnitude of a vector field
Input Port
in_field
|
Mesh + Node_Data
|
ui_parent
|
user interface parent object
|
Parameters
data component
|
UIradioBoxLabel
|
component to calculate magnitude
|
Output Port
out_fld
|
Mesh + Node_Data
|
out_obj
|
output renderable object
|
Description
magnitude calculates the magnitude of a vector field.
Input
in_field
The input is any mesh with Node_Data.
ui_parent
A port to connect to a user interface object that contains the macro's widgets. By default, it is connected to the default user interface object in the application in which the macro is instanced. (This default connection is not drawn.)
Parameters
data component
UIradioBoxLabel. Radio buttons to pick which component to use to calculate the magnitude. This component can contain one-, two-, or three-vector subcomponents. The default is the first (0th) component. If node data labels are present, they are displayed.
Output Port
out_fld
The output field is a reference to a new object that is the merge of the new Node_Data, plus a reference to the original input mesh. This new Node_Data is a scalar representing the magnitude.
out_obj
This is a renderable version of the output field.
Algorithm
The equation used to compute the magni
tude is:
where a1, a2, and so on are the individual vector subcomponents within the selected component.
Example
Not available
File
v/modules.v
See also related modules
