dpm_histogram#

class ansys.fluent.core.solver.tui_231.main_menu.results.report.dpm_histogram(path, service)#

Bases: TUIMenu

Enter the DPM histogram menu.

Methods:

compute_sample(*args, **kwargs)

Compute minimum/maximum of a sample variable.

delete_sample(*args, **kwargs)

Delete a sample from loaded sample list.

list_samples(*args, **kwargs)

Show all samples in loaded sample list.

pick_sample_to_reduce(*args, **kwargs)

Pick a sample for which to first set-up and then perform the data reduction.

plot_sample(*args, **kwargs)

Plot 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)

Read a sample file and add it to the sample list.

reduce_picked_sample(*args, **kwargs)

Reduce a sample after first picking it and setting up all data-reduction options and parameters.

write_sample(*args, **kwargs)

Write a histogram of a loaded sample into a file.

Classes:

set(path, service)

Enter the settings menu for the histogram.

setup_reduction(path, service)

Set up the sample data reduction by specifying all relevant options and setting parameters as desired.
compute_sample(*args, **kwargs)#

Compute minimum/maximum of a sample variable.

delete_sample(*args, **kwargs)#

Delete a sample from loaded sample list.

list_samples(*args, **kwargs)#

Show all samples in loaded sample list.

pick_sample_to_reduce(*args, **kwargs)#

Pick a sample for which to first set-up and then perform the data reduction.

plot_sample(*args, **kwargs)#

Plot 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)#

Read a sample file and add it to the sample list.

reduce_picked_sample(*args, **kwargs)#

Reduce a sample after first picking it and setting up all data-reduction options and parameters.

class set(path, service)#

Bases: TUIMenu

Enter the settings menu for the histogram.

Methods:

auto_range(*args, **kwargs)

Automatically compute range of sampling variable for histogram plots.

correlation(*args, **kwargs)

Compute correlation of sampling variable with other variable.

cumulation_curve(*args, **kwargs)

Compute a cumulative curve for sampling variable or correlation variable when correlation? was specified.

diameter_statistics(*args, **kwargs)

Compute Rosin Rammler parameters, Sauter and other mean diameters.

histogram_mode(*args, **kwargs)

Use bars for histogram plot or xy-style.

logarithmic(*args, **kwargs)

Use logarithmic scaling on the abscissa (variable axis)? -- Will not work unless all values are positive.

maximum(*args, **kwargs)

Specify maximum value of x-axis variable for histogram plots.

minimum(*args, **kwargs)

Specify mimimum value of x-axis variable for histogram plots.

number_of_bins(*args, **kwargs)

Specify the number of bins.

percentage(*args, **kwargs)

Use 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)

Use weighting with additional variable when sorting data into samples.
auto_range(*args, **kwargs)#

Automatically compute range of sampling variable for histogram plots.

correlation(*args, **kwargs)#

Compute correlation of sampling variable with other variable.

cumulation_curve(*args, **kwargs)#

Compute a cumulative curve for sampling variable or correlation variable when correlation? was specified.

diameter_statistics(*args, **kwargs)#

Compute Rosin Rammler parameters, Sauter and other mean diameters. Requires specification of diameter as sampling variable.

histogram_mode(*args, **kwargs)#

Use bars for histogram plot or xy-style.

logarithmic(*args, **kwargs)#

Use logarithmic scaling on the abscissa (variable axis)? – Will not work unless all values are positive.

maximum(*args, **kwargs)#

Specify maximum value of x-axis variable for histogram plots.

minimum(*args, **kwargs)#

Specify mimimum value of x-axis variable for histogram plots.

number_of_bins(*args, **kwargs)#

Specify the number of bins.

percentage(*args, **kwargs)#

Use 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)#

Use weighting with additional variable when sorting data into samples.

class setup_reduction(path, service)#

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.