plume_area

General Module Function

The plume_area module creates a 2D subset of a 2D input. In other words, the input should be a surface and the output will be a subset of that surface. The resulting output can be used as input for further subsetting or output to the Viewer.

Module Input Ports

plume_area has two input ports.

The leftmost (blue-black) port accepts unstructured mesh data which should represent a surface or surfaces..
The second (maroon) port provides a means to share the subsetting level with other modules.

Module Output Ports

plume_area has four output ports.

The first output port (leftmost) provides an "info" string which can be connected to the Titles module for a quick simple title associated with the settings of this module. For the settings shown below, the Title displayed would be: "TOTHC above 11 mg/kg". This is constructed using the "Subsetting Component" name followed by "above" or "below", a rounded representation of the subsetting level and the units (if specified in the input).
The second (maroon) port provides a means to share the subsetting level with other modules.
The third (blue-black) port outputs a new surface which contains the subset of the surface input. Nodal data sent to this output port consists of the nodal data in output.
The fourth (red) port outputs a rendered geometry directly to the Viewer. However, normally plume_area would not be connected to the Viewer.

Module Control Panel

The control panel for plume_area is shown in the figure above.

The SubsettingLevel type-in 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 used. Similarly, if a value less then 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. If your input data has been kriged with log processing, the values here will be exponentiated already (provided that the Automatic toggle is on). You will not enter the Log of your desired subsetting value. Also, when the data is log processed, the default value is the geometric mean (vs. arithmetic mean) of your data extremes.

The Run toggle when not ON will prevent the module from running.

The Automatic toggle when ON determines "automatically" if the subsetting level values will be exponentiated for you vs. having to input value which are the LOG of your desired level. When this is on the Exponentiated toggle is inactive.

The Exponentiated toggle is inactive if the Automatic toggle is ON. Otherwise, it determines whether to real units to logarithmic units..

The Data Above (on) or Below (off) Subsetting Level check box (Above Box) is used to display data above the subsetting level or below the subsetting level. For example, to display a volumetric subset of all concentrations greater than or equal to 1 ppm, set subsetting level to 1 (assuming concentration units are in ppm) and set the Above Box to on (check in the box). To see the plume_area of 1 ppm and below, simply turn the Above Box off (no check in box).

Subsetting Component refers to the nodal data component used to create the subset of the original input field. When an component is selected, the min and max values of the variable are displayed in the upper center of the dialog box. The default component is the first (0th) component in the column.

Nodal Data in Output determines which nodal data components will be included in the output. The first one in the list will determine the data used for coloring in the (red) output to the Viewer. For example, choosing subsetting component concentration and uncertainty for the nodal data in the output will create a volumetric SHELL subset of concentration colored by uncertainty. Initially, only the first map component is selected.

The CellData in Output option box selector lets you map cell data (if any) to the surfaces output by plume_area. The cell data will only be visible if all nodal data is unselected (under nodal data in output).

The Remove Normals Generation toggle is equivalent to setting Normals Generation (in Object.Modes) to None. This changes the rendering of surfaces and is sometimes preferable.

The Culling Mode Back (on) or Normal (off) toggle is equivalent to setting the object surface property to cull back facing surfaces. This is recommended whenever Opacity is less than 1.00

The Transparency slider changes the transparency of the output to the red port to the Viewer.

The Export button adds additional output ports to the module to facilitate passing text and numeric data to other modules. The result is shown above. Once this button is pushed, plume_area will have has seven output ports.

The info string
The subsetting level
The string representing the selected subsetting component
The string representing "above" or "below"
The units as a string
The (blue-black) output
The (red) output to the Viewer.

Module Status: Interruptible

This module's computational processes can be terminated (interrupted) using the "C Tech" icon in the Windows Notification Area (aka System Tray) in the lower right corner of your desktop. If you hover over the icon, it will tell you the status of the module and expected completion time. Double-Right-Clicking will terminate the process. Note that if you do stop any process, the output of the module is corrupted and any downstream module's results are not usable. You will need to re-run the module.

Related Modules

-> plume_shell

-> plume_volume