Heatmap Objects Reference

Specific nodes referenced here are:

Heatmap Style: See Heatmap Style.
Color: Uses the Color property to color data that is selected in the heatmap. See Defining Colors.
Color Bar: See Color Bar.
Weighting: This node appears when the Weighting property of the Heatmap Style node is set to User Specified. For each cell falling into a bin, Simcenter STAR-CCM+ reads the value of a field function that you specify in the Field Function property and adds the value to the bin.
Range: This node appears when the Range Mode property of the Heatmap Style node is set to Manual. To set the minimum and maximum bin values along each axis, use the X-Axis Range and Y-Axis Range properties.

Heatmap Style

A node that consists of properties and sub-nodes for controlling the heatmap in the plot. The sub-nodes control color, weighting, and data range.

Table 1. Heatmap Style Properties
Weighting	Determines how a cell falling into a bin influences the value of the bin.
	Default	The value of a bin is equal to the number of cells that fall into it.
	User Specified	For each cell falling into a bin, a value from a field function is read and added to the value of the bin. To specify this field function, use the Weighting sub-node. (Currently values stored in the field function must be positive.) A typical use case is selecting Volume as the field function. This field function ensures that small cells only contribute a small amount to the final bin value. Without volume weighting, the heatmap shows simply the distribution of functions in terms of number of cells. With volume weighting, the heatmap shows the distribution of the function values in terms of occupied volume. When cell sizes in the mesh differ substantially, volume weighting makes a significant difference.
Bins	The number of bins along the x- and y-axes.
Range Mode	Determines the bounds along the x- and y-axes. In Auto mode, x- and y-axis ranges are set to the min/max values of all data sets shown in the plot. In Manual mode you can specify both ranges using the Range sub-node.

Table 2. Heatmap Style Expert Properties
Clip Empty Bins	When this option is activated, bins into which no cell has fallen are not rendered.
Use Color Lookup Table	When this option is activated, a color lookup table is used to assign a color to the values that are stored in each bin. Settings for this lookup table can be changed using the Color Bar sub-node.
Normalize by Bin Size	When this option is activated, the bin values are divided by the size of the bin in data space (x-axis extent multiplied by y-axis extent).

This node replaces the Color node when the Use Color Lookup Table expert property of the Heatmap Style node is activated.

Table 3. Color Bar Properties
Color Map	Selects colors to indicate values from lowest to highest. This property lets you customize the use of colors in the heatmap plot. For a list of the pre-defined choices, see Pre-Defined Color Maps.
Levels	Sets the number of levels into which to divide the range of data. Higher numbers produce finer blends between values. The default setting is 32.
Reverse	Reverses the sequence of the selected color map. See Applying and Managing Color Maps.
	Activated	Color sequence is reversed (for example, red to blue rather than blue to red).
	Deactivated	Uses the default color sequence.
Scale Mode	Activates a logarithmic scale mode for the color bar. See Color Bar Node Properties.
	Linear	Uses linear scaling.
	Log10	Uses logarithmic scaling.

Table 4. Color Bar Expert Properties
Ramp Type	Sets the shape of the table ramp to either linear, S-curve, or square-root. If you use the Linear ramp, colors vary linearly to bin values. The other ramp modes distort this color mapping according to the corresponding functions.
	Linear	Specifies a linear ramp.
	S-curve	Uses the S-curve, which tails off gradually at each end: $y = \frac{\sin ((x - 1 / 2) π) + 1}{2}$
	Sqrt	Uses the square root, $y = \sqrt{x}$ .