plume
The plume module creates a (same dimensionality) subset of the input, regardless of dimensionality. What this means, in other words, is that plume can receive a field (blue port) model with cells which are points, lines, surfaces and/or volumes and its output will be a subset of the same type of cells.
This module should not normally be used when you desire a visualization of a 3D volumetric plume but rather when you wish to do subsequent operations such as analysis, slices, etc.
Info
The plume module may be controlled with the driven sequence module.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Field | Field | A field containing nodal data. |
| Input | Input Isolevel | Number | The value used for subsetting. |
| Output | Status | String | Text containing the subsetting information. |
| Output | Output Isolevel | Number | The value used for subsetting. |
| Output | Output Field | Field | A field containing a new unstructured mesh which contains the surfaces which are the external faces of a subset of the input. |
| Output | Plume | Renderable | A renderable object displaying the subsetted plume data. |
| Output | Output Sequence | Sequence | The generated sequence of states. |
Properties
| Property | Type | Description |
|---|---|---|
| Allow Run | Boolean | The Allow Run toggle will prevent the module from running when unselected. |
| Execute | Button | The Run Once button will cause the module to run one time even if the Allow Run toggle has been turned off. |
| Above Direction String | String | When the Subsetting Direction is set to Subset Above Level, the Direction String will use this string as its identifier. |
| Below Direction String | String | When the Subsetting Direction is set to Subset Below Level, the Direction String will use this string as its identifier. |
| Status Expression | Expression | The Status Expression sets the template which is used to generate the status string, and the title for each state of the sequence. |
| Use Sequencing | Boolean | Turning this on allows the sequences to drive the module instead of the positions. |
Data Processing
| Property | Type | Description |
|---|---|---|
| Subsetting Component | Choice | The Subsetting Component is the nodal data value to use to subset the input by. |
| Subsetting Level | Double | The Subsetting Level is used to set the level for subsetting the input field. If a value is chosen larger than the max value, the max value is placed in the edit box. Similarly, if a value less than the minimum is input, the minimum value is placed in the box. The default level is the arithmetic average of the minimum and maximum values in the subsetting component. |
| Subsetting Direction | Choice: Subset Below level, Subset Above level | The Subsetting Direction choice allows the user to select which range of values to include in the output. Either the range of data from the subsetting level to the max can be selected, or the range of data from the subsetting level to the min of the data. |
| Output Nodal Data | Multi-select | The Output Nodal Data choice allows the user to select the nodal data to include in the output. |
| Output Cell Data | Multi-select | The Output Cell Data choice allows the user to select the cell data to include in the output. |
Sequence Settings
| Property | Type | Description |
|---|---|---|
| Current State | Sequence State | The current state to be passed to the script. |
| State Control | Choice: Slider, Combo Box, List Box | The State Control determines how the user will interact with the created sequence of states. |
| Allow Cycles | Boolean | Allows the state control to be cycled in CTWS files. |
| Sequence Generation Properties | Value generator | Generates the list of values for sequencing. Methods: Linear By Step (values from an anchor point at a fixed step size), Linear By Count (a fixed number of evenly-spaced values), User Entries (manually specified values), Per Log Decade (logarithmic spacing with a set number of values per decade). |