dpm_histogram

class ansys.fluent.core.solver.tui_232.main_menu.report.dpm_histogram(service, version, mode, path)

Bases: TUIMenu

Enters the DPM histogram menu.

Methods:

compute_sample(*args, **kwargs)	Computes the minimum/maximum of a sample variable.
delete_sample(*args, **kwargs)	Deletes a sample from the loaded sample list.
list_samples(*args, **kwargs)	Shows all samples in a loaded sample list.
pick_sample_to_reduce(*args, **kwargs)	Select a sample to be reduced.
plot_sample(*args, **kwargs)	Plots a histogram of a loaded sample.
prep_dpm_sample_cont_plot_exprs(*args, **kwargs)	Prepare named expressions from data in a DPM sample file (collected at a cut plane surface) for contour plotting.
read_sample(*args, **kwargs)	Reads a sample file and adds it to the sample list.
reduce_picked_sample(*args, **kwargs)	Reduce a sample as specified by the data reduction parameters.
write_sample(*args, **kwargs)	Write a histogram of a loaded sample into a file.

Classes:

set(service, version, mode, path)	Enters the settings menu for the histogram.
setup_reduction(service, version, mode, path)	Set up the sample data reduction by specifying all relevant options and setting parameters as desired.

compute_sample(*args, **kwargs)

Computes the minimum/maximum of a sample variable.

delete_sample(*args, **kwargs)

Deletes a sample from the loaded sample list.

list_samples(*args, **kwargs)

Shows all samples in a loaded sample list.

pick_sample_to_reduce(*args, **kwargs)

Select a sample to be reduced.

plot_sample(*args, **kwargs)

Plots a histogram of a loaded sample.

prep_dpm_sample_cont_plot_exprs(*args, **kwargs)

Prepare named expressions from data in a DPM sample file (collected at a cut plane surface) for contour plotting.

read_sample(*args, **kwargs)

Reads a sample file and adds it to the sample list.

reduce_picked_sample(*args, **kwargs)

Reduce a sample as specified by the data reduction parameters. This command is available only after you selected the sample using the pick-sample-to-reduce text command.

class set(service, version, mode, path)

Bases: TUIMenu

Enters the settings menu for the histogram.

Methods:

auto_range(*args, **kwargs)	Automatically computes the range of the sampling variable for histogram plots.
correlation(*args, **kwargs)	Computes the correlation of the sampling variable with another variable.
cumulation_curve(*args, **kwargs)	Computes a cumulative curve for the sampling variable or correlation variable when correlation? is specified.
diameter_statistics(*args, **kwargs)	Computes the Rosin Rammler parameters, Sauter, and other mean diameters.
histogram_mode(*args, **kwargs)	Uses bars for the histogram plot or xy-style.
logarithmic(*args, **kwargs)	Enables/disables the use of logarithmic scaling on the abscissa of the histogram.
maximum(*args, **kwargs)	Specifies the maximum value of the x-axis variable for histogram plots.
minimum(*args, **kwargs)	Specifies the minimum value of the x-axis variable for histogram plots.
number_of_bins(*args, **kwargs)	Specifies the number of bins.
percentage(*args, **kwargs)	Uses percentages of bins to be computed.
variable_power_3(*args, **kwargs)	Use the cubic of the cumulation variable during computation of the cumulative curve.
weighting(*args, **kwargs)	Uses weighting with additional variables when sorting data into samples.

auto_range(*args, **kwargs)

Automatically computes the range of the sampling variable for histogram plots.

correlation(*args, **kwargs)

Computes the correlation of the sampling variable with another variable.

cumulation_curve(*args, **kwargs)

Computes a cumulative curve for the sampling variable or correlation variable when correlation? is specified.

diameter_statistics(*args, **kwargs)

Computes the Rosin Rammler parameters, Sauter, and other mean diameters.

histogram_mode(*args, **kwargs)

Uses bars for the histogram plot or xy-style.

logarithmic(*args, **kwargs)

Enables/disables the use of logarithmic scaling on the abscissa of the histogram.

maximum(*args, **kwargs)

Specifies the maximum value of the x-axis variable for histogram plots.

minimum(*args, **kwargs)

Specifies the minimum value of the x-axis variable for histogram plots.

number_of_bins(*args, **kwargs)

Specifies the number of bins.

percentage(*args, **kwargs)

Uses percentages of bins to be computed.

variable_power_3(*args, **kwargs)

Use the cubic of the cumulation variable during computation of the cumulative curve. When the particle mass was not sampled, the diameter can be used instead.

weighting(*args, **kwargs)

Uses weighting with additional variables when sorting data into samples.

class setup_reduction(service, version, mode, path)

Bases: TUIMenu

Set up the sample data reduction by specifying all relevant options and setting parameters as desired.

Methods:

all_variables_number_of_bins(*args, **kwargs)	Set the number of bins to be used for ALL variables in the data reduction.
list_settings(*args, **kwargs)	List all user inputs for the sample picked for data reduction.
logarithmic(*args, **kwargs)	Switch on or off logarithmic scaling to be used for a specific variable in the data reduction.
make_steady_from_unsteady_file(*args, **kwargs)	Specify whether the unsteady sample is to be reduced into a steady-state injection file.
maximum(*args, **kwargs)	Set the maximum value of the range to be considered for a specific variable in the data reduction.
minimum(*args, **kwargs)	Set the minimum value of the range to be considered for a specific variable in the data reduction.
number_of_bins(*args, **kwargs)	Set the number of bins to be used for a specific variable in the data reduction.
reset_min_and_max(*args, **kwargs)	Reset the min and max values of the range to be considered for a specific variable in the data reduction.
use_weighting(*args, **kwargs)	Specify whether to use any weighting in the averaging that is done in each bin in the data reduction.
weighting_variable(*args, **kwargs)	Choose the weighting variable for the averaging in each bin in the data reduction.

all_variables_number_of_bins(*args, **kwargs)

Set the number of bins to be used for ALL variables in the data reduction.

list_settings(*args, **kwargs)

List all user inputs for the sample picked for data reduction.

logarithmic(*args, **kwargs)

Switch on or off logarithmic scaling to be used for a specific variable in the data reduction.

make_steady_from_unsteady_file(*args, **kwargs)

Specify whether the unsteady sample is to be reduced into a steady-state injection file.

maximum(*args, **kwargs)

Set the maximum value of the range to be considered for a specific variable in the data reduction.

minimum(*args, **kwargs)

Set the minimum value of the range to be considered for a specific variable in the data reduction.

number_of_bins(*args, **kwargs)

Set the number of bins to be used for a specific variable in the data reduction.

reset_min_and_max(*args, **kwargs)

Reset the min and max values of the range to be considered for a specific variable in the data reduction.

use_weighting(*args, **kwargs)

Specify whether to use any weighting in the averaging that is done in each bin in the data reduction.

weighting_variable(*args, **kwargs)

Choose the weighting variable for the averaging in each bin in the data reduction.

write_sample(*args, **kwargs)

Write a histogram of a loaded sample into a file.