User Input

) for a feature or property becomes a data storage editable by the user for the corresponding instance in the Model Builder (see User Inputs for an overview).

To add a , first add a feature node or property node (for example, a Generic Feature, Domain Condition, or Device Model Feature), then:

•

Right-click the feature node (in this example, , , or ) and select it from the submenu.

The window of a user input contains the following sections:

In the section you specify the name of the parameter in the field. The description, symbol, physical quantity, and SI unit of the user input work identical to variable declaration; see Variable Declaration and Dependent Variable Declaration.

The dimension and default value of the user input is a bit different compared to variables. For scalars, vectors, and matrices you set the desired dimension in the list. Use the array type for the list, which also is the default. When you need user inputs that are vectors of vectors, or vector of matrices, choose in the list. You can then choose the outer dimension with the list and the inner dimension with the list. The list is identical to the list, but the list has fewer options. For all double-array user inputs, the default value refers to the inner dimension and fills up the outer dimension with identical defaults.

When the user input is a scalar, there is an option to define a set of allowed values. In the list, you can choose or . If you choose , a table shows up that you can fill the with allowed values. The list only contains the values entered in the list. If you choose in the list, you specify the default in the field.

User inputs of the type is a special case of a scalar with two allowed values, internally represented with 0 and 1. The obvious control type for this user input is a check box that either can be cleared (0) or selected (1). To make the check box selected by default, select the check box.

When you want vectors where each element must be in a set of allowed values or is a Boolean, you use a double-array user input. Set the outer dimension as desired, and choose or from the list. If you choose , you can set the allowed values as described above.

In the list you can define what space dimensions this particular user input can be used in. The option (the default option) means that the user input supports the same space dimensions as the parent feature or property. If you want to control the space dimensions manually, choose from the list. You can then select the allowed space dimensions from a list of all space dimensions.

	If the user input does not support a space dimension, it becomes completely removed from the feature or property, not just hidden from the user interface. If you then try to access it in a variable definition, for example, an error message appears.

Select the check box to omit that input from the Compact History. This means that any changes made to this input will not be recorded as an API statement when doing a reset of the model history. When select the check box, that also means that it is omitted in duplicate and paste operations, so the check box (see below) is selected and disabled. Note that this check box will be enabled and selected if the check box is cleared again, even if the check box was cleared before the check box was selected.

Select the check box if you want the settings to be reset to the default values when an entity is duplicated or pasted. This check box should typically be cleared.

Select the check box to make sure that the default values use unique values. From the list, choose one of the following methods to ensure unique values:

•

, to ensure uniqueness among a specific category of user inputs in all features, which you specify in the field.

•

, to ensure uniqueness among a specific category of user inputs in the same feature list, which you specify in the field.

The difference between the last two options is that the former searches for existing values among all features recursively (also subfeatures) and the latter only searches for values in the same list.

It is also possible to add a condition that includes a sibling feature in the search for existing values by selecting the check box. A condition, which you enter in the field, can then be evaluated for each sibling (or physics property settings). No values will be collected from sibling feature where this condition is false.

If you want the user input to disappear when it is inactive, select the check box. Select the check box to hide the text label containing the description above the GUI component of the user input. Similarly, you can hide the symbol from the GUI by selecting the check box. As a final option, it is possible to add a divider above the GUI component and any description text label. The divider is a horizontal line with an optional descriptive text. Select the check box to add the divider. When selected, you can enter the divider text in the field.