plume shell

plume shell

The plume shell module creates the external faces of a volumetric subset of a 3D input. The resulting closed volume “shell” generally is used only as a visualization of a plume and would not be used as input for further subsetting or volumetric computations since it is hollow (empty). This module creates a superior visualization of a plume as compared with other modules such as plume passing to external faces and is quicker and more memory efficient.

Info

Ports

DirectionNameTypeDescription
InputInput FieldFieldA field containing nodal data.
InputInput IsolevelNumberThe value used for subsetting.
OutputOutput FieldFieldA field containing a new unstructured mesh which contains the surfaces which are the external faces of a subset of the input.
OutputStatusStringText containing the subsetting information.
OutputPlumeRenderableA renderable object displaying the subsetted plume data.
OutputOutput SequenceSequenceThe generated sequence of states.

Properties

PropertyTypeDescription
Allow RunBooleanThe Allow Run toggle will prevent the module from running when unselected.
ExecuteButtonForces the module to run.
Above Direction StringStringWhen the Subsetting Direction is set to Subset Above Level, the Direction String will use this string as its identifier.
Below Direction StringStringWhen the Subsetting Direction is set to Subset Below Level, the Direction String will use this string as its identifier.
Status ExpressionStringThe Status Expression sets the template which is used to generate the status string, and the title for each state of the sequence.
Use SequencingBooleanTurning this on allows the sequences to drive the module instead of the positions.
Include Varying SurfaceBooleanThe Include Varying Surface Toggle controls the visibility of the surface having varying data.

Data Processing

PropertyTypeDescription
Subsetting ComponentChoiceThe Subsetting Component is the nodal data value to use to subset the input by.
Subsetting LevelDoubleThe Subsetting Level is used to set the level for subsetting the input field.
Subsetting DirectionChoice: Subset Below level, Subset Above levelThe Subsetting Direction choice allows the user to select which range of values to include in the output.
Output Nodal DataMulti-selectThe Output Nodal Data choice allows the user to select the nodal data to include in the output.
Output Cell DataMulti-selectThe Output Cell Data choice allows the user to select the cell data to include in the output.

Sequence Settings

PropertyTypeDescription
Current StateChoiceThe current state to be passed to the script.
State ControlChoice: Slider, Combo Box, List BoxThe State Control determines how the user will interact with the created sequence of states.
Allow CyclesBooleanAllows the state control to be cycled in CTWS files.
Sequence Generation PropertiesValue generatorGenerates 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).

External Faces

PropertyTypeDescription
Split EdgesBooleanSplit surfaces when the edge between two neighboring cells is sharp. This improves rendering in most cases.
Constant Surfaces Are Not SplitBooleanWhen on, the constant surfaces in the resulting plume are not split. This gives them a smoother appearance in some cases.
Split Edge AngleDoubleThe Split Edge Angle is the maximum angle allowed between two adjacent faces before they are disconnected to create visually sharp edges.