Zonal Analysis¶
Introduction¶
The zonal analysis feature allows the user to define interrogation volumes by specifying the number of zones in the x, y, and z directions. The solver will then calculate the aggregate data for each zone and report it at each statistic time step. Examples of uses include mean property value (e.g., scalar, velocity magnitude, energy dissipation rate), standard deviation of a given property, number of particles, and mean particle size.
See also Zonal Analysis tutorial.
Property Grid¶
General¶
- Analysis Type
TBA
- Particle Size Histogram
Each defined volume in the analysis reports the number of particles categorized into a user-defined number of size bins.
- Nx
User-defined number of zones in the X-direction.
- Ny
User-defined number of zones in the Y-direction.
- Nz
User-defined number of zones in the Z-direction.
- Nbins
Number of bins in each zone.
- Histogram Maximum Value
The maximum value of the histogram bins. Any particle larger than this value will be included in this bin.
- Data Source Particle Name
The user-selected particle source. Many times there will only be one available selection because there is only one defined particle source, but there are times where there may be more (e.g., bubbles and particles).
- Custom
The property being analyzed is defined via a user-defined function.
- Nx
User-defined number of zones in the X-direction.
- Ny
User-defined number of zones in the Y-direction.
- Nz
User-defined number of zones in the Z-direction.
- Components
TBA
- Single Value
This option should be used when a single value is expected for each volume (e.g., count, mean).
- Array Values
This value is used when multiple values are expected for each volume (i.e., Histogram).
- Data Source
TBA
- Fluid
This will allow fluid-specific options available for analysis.
- Particle
This will allow particle-specific options available for analysis.
- Data Source Particle Name
User-selected particle source. Many times there will only be one available selection because there is only one defined particle source, but there are times where there may be more (e.g., bubbles and particles).
- Reduction
TBA
- Minimum
The maximum property value in the analysis zone.
- Maximum
The maximum property value in the analysis zone.
- Sum
The sum of the property values in the analysis zone.
- Mean
The mean property value in the analysis zone.
- Standard Deviation
The standard deviation of the property value in the analysis zone.
- RSD %
The relative standard deviation percentage. Property Standard Deviation / Mean.
- Data Type
The type of value used in the reductions.
- Floating Point
Single precision floating point number.
- Integer
32-bit integer. The integer option is a better choice for accuracy where high counts are expected.
- Zonal Analysis UDF
user-defined units | This UDF defines the local value that will be reduced as part of the zonal analysis reduction. When the Component Type is Single Value, the UDF must define one floating-point output variable named
value. When the Component Type is Array, the UDF must define both an output integer variable namedbinand an output floating-point variable namedvalue. The bin variable defines which element of the array to populate with the data defined by the output value.This feature is useful for defining local histograms. The units on the output variable depend on the UDF expression. The bin variable is unitless. This can be either a voxel-based or a particle-based local UDF, depending on the Data Source.
Download Sample File:
Zonal Analysis
Zonal Analysis Toolbar¶
Context-Specific Toolbar Forms |
Description |
|---|---|
|
The Help command launches the M-Star reference documentation in your web browser. |
For a full description of each selection on the Context-Specific Toolbar, see Toolbar Selections.
Help