cell volumetrics
The cell volumetrics module provides cell-by-cell volumetrics data. It produces an output field with volume, mass, cell-center, and contaminant data attached to every cell in the grid. The user selects the analyte, basis, units, and soil properties, and the module computes volumetric data on a per-cell basis. Aggregate values across all selected cells are also reported in the Information window, and results can optionally be written to a tab-delimited file suitable for import into programs like Excel.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Field | Field | The field to use for calculations. |
| Input | String For Output | String | String to be added at the beginning of the Output Results file. |
| Output | Output Field | Field | The main output field with cell volumetric data. |
| Output | Numeric Output 1 | Number | A numeric value computed from the expression. |
| Output | Numeric Output 2 | Number | A numeric value computed from the expression. |
| Output | Numeric Output 3 | Number | A numeric value computed from the expression. |
| Output | String Output 1 | String | A string value computed from the expression. |
| Output | String Output 2 | String | A string value computed from the expression. |
Properties
| Property | Type | Description |
|---|---|---|
| Allow Run | Boolean | When the Allow Run toggle is set to on the module will run every time a setting is changed. |
| Execute | Button | This button will force the module to run even if the Allow Run toggle has been turned off. This allows the user to make a number of changes before updating. |
| Z Scale | Double | The Z exaggeration factor applied to the input field. |
| Explode | Double | The Explode factor applied to the input field. |
| Update Information Window | Boolean | When on, the module sends a structured aggregate report to the Information window every time it runs. |
Input Settings
| Property | Type | Description |
|---|---|---|
| Nodal Data Component | Choice | The Nodal Data Component used to subset the input. Options are populated from the input field. |
| Nodal Units | Linked Analyte Unit | The Nodal Units are set based on the input data and the selected Nodal Data Component. The Multiplier is the ratio of the user’s input units to grams/grams (for example, 1e-6 for mg/kg/ppm). The Calculation Type determines what type of units to process the Nodal Data Component in. |
| Coordinate Units | Linked Coordinate Unit | The Coordinate Units are set based on the coordinate units of the input model. The Multiplier is the ratio of the user’s input units to liters (for example, 1000 for cubic meters). |
Output Settings
| Property | Type | Description |
|---|---|---|
| Volume Units | Choice: Cubic Feet, Cubic Yards, Cubic Meters, Liters, Acre Feet, Barrels, Specify | Volume Units is used to select which units the volume should be calculated in. |
| Volume Units Ratio | Double | If the Volume Units is set to Specify, the user must set the Volume Units Ratio. The ratio should be the factor needed to convert between the user-specified units and liters. For example, for cubic meters the ratio would be 1000. |
| Volume Specified Units | String | If the Volume Units is set to Specify, the user must set the Volume Specified Units label. This label will be used in the output. |
| Mass Units | Choice: Kilograms, Metric Tons, Pounds, U.S. Short Tons, Ounces (Troy), Specify | Mass Units is used to select which units the mass should be calculated in. |
| Mass Unit Ratio | Double | If the Mass Units is set to Specify, the user must set the Mass Unit Ratio. The ratio should be the factor needed to convert between the user-specified units and kilograms. |
| Mass Specified Units | String | If the Mass Units is set to Specify, the user must set the Mass Specified Units label. This label will be used in the output. |
| Output Field Data | Multi-select: Current Cell, Cell Center X, Cell Center Y, Cell Center Z, Soil Volume, Soil Mass, Chem Volume, Chem Mass, Average Concentration, Water Volume, Water Mass, Air Volume, Air Mass, Total Activity | The Output Field Data selection determines which cell data components are included in the Output Field. |
| Output Results To File | Boolean | The Output Results To File toggle causes cell volumetrics to write a file, specified by the Filename, that contains all volumetrics information in a format suitable for input to programs like Excel (tab delimited .txt file). The file is opened in append mode and will grow as cell volumetrics is run. Delete or move the file when finished with it. |
| Overwrite File | Boolean | The Overwrite File toggle creates a new file when on, or appends to an existing file when off. |
| Filename | String | The filename for output. |
Output Port Settings
| Property | Type | Description |
|---|---|---|
| Numeric Expression 1 | String | Python expression for the first numeric output port. Use variable names like SoilVolume, ChemicalMass, AverageConcentration, CenterOfMassX, etc. to reference cell volumetrics aggregate values. |
| Numeric Expression 2 | String | Python expression for the second numeric output port. |
| Numeric Expression 3 | String | Python expression for the third numeric output port. |
| String Expression 1 | String | Python f-string expression for the first string output port. Use {VariableName} placeholders such as {VolumeUnits}, {MassUnits}, {AnalyteName}, etc. to reference cell volumetrics values. |
| String Expression 2 | String | Python f-string expression for the second string output port. |