From SCIRun Documentation Wiki
Jump to navigation Jump to search



Package: SCIRun
Catagory: ChangeFieldData
Author(s): Jeroen Stinstra
Status: Supported in latest version
Version: 3.0



This module calculates a new value for each value in the field data based on a user defined function. This function is based on a series of variables that is available for each data location. Once the function is defined, the module will walk through each data value and apply the function.

Detailed Description


This module allows the computation of a new scalar, vector or tensor value for each data location in the field. The user define function can depend on a number of variables that are defined for each location:

Input variables

DATA: This is the current value stored in the field (either on the element or the node location).

X,Y,Z: Cartesian coordinates of the node or element (center of the element)

POS: Vector with Cartesian coordinates of the node or element

A,B,C,...: Input from additional matrix ports. The input matrix can have either 1 row or the same number of rows as there are values in the field. In case the matrix has one value this value is the same for each data location, in case it has multiple values the module iterates of the values in the same way it iterates over the data values of the field. The matrix input can have either 1 column, 3 columns, 6 or 9 columns. In case the matrix has 1 column values are assumed to be scalar values, in case the matrix has 3 columns it is assumed to contain vector values and in case it has either 6 or 9 columns it is assumed to be a tensor value (A 6 valued tensor is defined as xx, xy, xz, yy, yz, and zz).

INDEX: The index number of the element or node.

SIZE: The number of elements or nodes in the field. (Depending on the input field type)

ELEMENT: Special access variable to access properties of the element. Currently only length, area, and volume are available to be called on this entity. In case one is iterating over the nodes, the node point is assumed to be the element, in case one is iterating of the elements, this variable is referring to the full element.

Output variable

RESULT: The output needs to be stored in the variable RESULT.

Available functions

A list of available functions is available in the GUI of the module. Press on the button available functions to obtain a full overview of the current available functions to do Scalar/Vector/Tensor algebra and to view the functions that can be applied to the ELEMENT variable.


The user defined function is currently being translated in a chunk of code that is compiled using the dynamic compiler, however the current plan is to replace the dynamic compiler with a simple parser. In the latter case not every C++ functionality will be available, and hence it is recommended to stay within the functions defined in the help of the module.

Input ports

The first input is the field whose data needs to be recalculated using a function. The second port is an optional port that allows the user to script the module with a user defined input function. This function will override the function given in the GUI of the module. The third and next ports are used to import a matrix. The first port corresponds to matrix A, the next to matrix B and so on. These ports can be used to do algebra with values stored as a matrix or can be used to enter scriptable scalar/vector/tensor values that can be defined elsewhere.

Output port

The module has one output port that has the newly defined values.

Example functions

Suppose one wants to set the data values to a certain value:


This will set every data value inside the field equal to the value 2. Similarly one can set the data value to a value specified inside the first matrix on the input ports:


If the matrix contains only one value each data point is set to that value, if it contains the same number of values as datalocations, it will map each value in the matrix to one value in the field.

One can as well query the positions of the data point, for example:


This will store X+Y in each data location.

This same module can be used as well to generate vector or tensor data, e.g:

RESULT = Vector(X,Y,cos(A));

This will take the X, Y, position and the cos applied to the values in the matrix A to create a new vector.

One can reuse the value that are there as well, e.g.:


Output data type

As the function is parsed using the compiler, the output type cannot be guessed by the module, hence it needs to be set by the user to the correct data type.

Frequently Asked Questions

The module shows up an error dialog with code, what now?
This normally happens when the code in the module cannot be parsed by the compiler. Check whether the algebra makes sense and whether the output type is correct. As the module does not parse the expressions, it does not know whether the output needs to be scalar, vector, or tensor. The user has to specify the correct output format currently. A second cause of the compiler not being able to compile the code is a typo in the expression or a missing semicolon at the end of the expression.

Known Bugs

Recent Changes

Go back to Documentation:SCIRun:Reference:SCIRun