report#

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

Bases: TUIMenu

Enter the report menu.

Methods:

aero_optical_distortions(*args, **kwargs)

Optics report menu.

dpm_extended_summary(*args, **kwargs)

Create an extended discrete phase summary report of the discrete phase injection(s).

dpm_sample(*args, **kwargs)

Samples trajectories at boundaries and lines/planes.

dpm_sample_output_udf(*args, **kwargs)

Allows you to hook a previously loaded DEFINE_DPM_OUTPUT UDF for file format specification for sampling of trajectories and VOF-to-DPM lump conversion transcripts.

dpm_sample_sort_file(*args, **kwargs)

Enables/disables writing of sorted DPM sample files.

dpm_summary(*args, **kwargs)

Prints discrete phase summary report.

dpm_zone_summaries_per_injection(*args, **kwargs)

Enables/disables calculation of the escaped mass per injection.

element_mass_flow(*args, **kwargs)

Prints list of element flow rate at inlets and outlets.

mphase_summary(*args, **kwargs)

Prints summary report for a multiphase case setup.

particle_summary(*args, **kwargs)

Prints summary report for all current particles.

path_line_summary(*args, **kwargs)

Prints pathline summary report.

print_histogram(*args, **kwargs)

Prints a histogram of a scalar quantity.

projected_surface_area(*args, **kwargs)

Computes the area of the projection of selected surfaces along the , , or axis.

species_mass_flow(*args, **kwargs)

Prints list of species mass flow rate at inlets and outlets.

summary(*args, **kwargs)

Prints the current settings for physical models, boundary conditions, material properties, and solution parameters.

surface_integrals(*args, **kwargs)

Enters the surface integral menu.

uds_flow(*args, **kwargs)

Prints list of user-defined scalar flow rate at boundaries.

volume_integrals(*args, **kwargs)

Enters the volume integral menu.

write_histogram(*args, **kwargs)

Write a histogram of a scalar quantity to a file.

Classes:

dpm_histogram(path, service)

Enters the DPM histogram menu.

fluxes(path, service)

Enters the fluxes menu.

forces(path, service)

Enters the forces menu.

heat_exchanger(path, service)

Enters the heat exchanger menu.

icing(path, service)

Icing reports menu.

modified_setting(path, service)

Enter the modified settings menu.

population_balance(path, service)

Population Balance menu.

reference_values(path, service)

Enters the reference value menu.

simulation_reports(path, service)

Enter the simulation reports menu.

system(path, service)

Enters the system menu.
aero_optical_distortions(*args, **kwargs)#

Optics report menu.

dpm_extended_summary(*args, **kwargs)#

Create an extended discrete phase summary report of the discrete phase injection(s). You can choose whether you want to save the extended report to a file or print it in the console window. For unsteady tracking, you will be asked whether you want to include in-domain particle/tracks in the report. You will be also prompted whether you want to select a single injection for the summary report. By default, all injections are included. The output depends on whether you have enabled the report/dpm-zone-summaries-per-injection? text command, in which case additional information is printed for escaped particles, such as per-injection data. Note that, for unsteady particle tracking, it is necessary to enable the report/dpm-zone-summaries-per-injection? text command before any particle parcels are injected into the domain.

class dpm_histogram(path, service)#

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(path, service)

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

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(path, service)#

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(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.

dpm_sample(*args, **kwargs)#

Samples trajectories at boundaries and lines/planes.

dpm_sample_output_udf(*args, **kwargs)#

Allows you to hook a previously loaded DEFINE_DPM_OUTPUT UDF for file format specification for sampling of trajectories and VOF-to-DPM lump conversion transcripts.

dpm_sample_sort_file(*args, **kwargs)#

Enables/disables writing of sorted DPM sample files.

dpm_summary(*args, **kwargs)#

Prints discrete phase summary report.

dpm_zone_summaries_per_injection(*args, **kwargs)#

Enables/disables calculation of the escaped mass per injection. Note that for unsteady particle tracking, if you want to report the mass of escaped particles per injection, this text command must be enabled before any particles are injected into the domain.

element_mass_flow(*args, **kwargs)#

Prints list of element flow rate at inlets and outlets. This reports the mass flow rates of all chemical elements (in kg/s) flowing through the simulation boundaries.

class fluxes(path, service)#

Bases: TUIMenu

Enters the fluxes menu.

Methods:

film_heat_transfer(*args, **kwargs)

Prints wall film heat transfer rate at boundaries.

film_mass_flow(*args, **kwargs)

Prints wall film mass flow rate at boundaries.

heat_transfer(*args, **kwargs)

Prints heat transfer rate at boundaries.

heat_transfer_sensible(*args, **kwargs)

Prints the sensible heat transfer rate at the boundaries.

mass_flow(*args, **kwargs)

Prints mass flow rate at inlets and outlets.

pressure_work(*args, **kwargs)

Prints the pressure work rate at the boundaries.

rad_heat_trans(*args, **kwargs)

Prints radiation heat transfer rate at boundaries.

viscous_work(*args, **kwargs)

Prints the viscous work rate at the boundaries.
film_heat_transfer(*args, **kwargs)#

Prints wall film heat transfer rate at boundaries. This text command is only available when you enable the Eulerian wall film model.

film_mass_flow(*args, **kwargs)#

Prints wall film mass flow rate at boundaries. This text command is only available when you enable the Eulerian wall film model.

heat_transfer(*args, **kwargs)#

Prints heat transfer rate at boundaries.

heat_transfer_sensible(*args, **kwargs)#

Prints the sensible heat transfer rate at the boundaries.

mass_flow(*args, **kwargs)#

Prints mass flow rate at inlets and outlets.

pressure_work(*args, **kwargs)#

Prints the pressure work rate at the boundaries. This text command is only available when the energy equation is enabled, the absolute velocity formulation is selected, and zone motion is enabled for a fluid cell zone.

rad_heat_trans(*args, **kwargs)#

Prints radiation heat transfer rate at boundaries.

viscous_work(*args, **kwargs)#

Prints the viscous work rate at the boundaries. This text command is only available when the energy equation is enabled and the pressure-based solver is selected.

class forces(path, service)#

Bases: TUIMenu

Enters the forces menu.

Methods:

pressure_center(*args, **kwargs)

Prints the center of pressure on wall zones.

wall_forces(*args, **kwargs)

Computes the forces along the specified force vector for all wall zones.

wall_moments(*args, **kwargs)

Computes the moments about the specified moment center for all wall zones.
pressure_center(*args, **kwargs)#

Prints the center of pressure on wall zones.

wall_forces(*args, **kwargs)#

Computes the forces along the specified force vector for all wall zones.

wall_moments(*args, **kwargs)#

Computes the moments about the specified moment center for all wall zones.

class heat_exchanger(path, service)#

Bases: TUIMenu

Enters the heat exchanger menu.

Methods:

computed_heat_rejection(*args, **kwargs)

Prints total heat rejection.

inlet_temperature(*args, **kwargs)

Prints inlet temperature.

mass_flow_rate(*args, **kwargs)

Prints mass flow rate.

outlet_temperature(*args, **kwargs)

Prints outlet temperature.

specific_heat(*args, **kwargs)

Prints fluid’s specific heat.
computed_heat_rejection(*args, **kwargs)#

Prints total heat rejection.

inlet_temperature(*args, **kwargs)#

Prints inlet temperature.

mass_flow_rate(*args, **kwargs)#

Prints mass flow rate.

outlet_temperature(*args, **kwargs)#

Prints outlet temperature.

specific_heat(*args, **kwargs)#

Prints fluid’s specific heat.

class icing(path, service)#

Bases: TUIMenu

Icing reports menu.

Methods:

energy_of_ice_formation(*args, **kwargs)

Print Energy of Ice Formation.

energy_of_water_impinged(*args, **kwargs)

Print Energy of Water Impingement.

icing_energy_of_conduction(*args, **kwargs)

Print Energy of Conduction.

mass_of_ice(*args, **kwargs)

Print Mass of Ice Accretion.

mass_of_water_impinged(*args, **kwargs)

Print Mass of Water Impingement.

particles_crystals_collection_eff(*args, ...)

Print Crystals Collection Efficiency.

particles_droplets_collection_eff(*args, ...)

Print Droplets Collection Efficiency.
energy_of_ice_formation(*args, **kwargs)#

Print Energy of Ice Formation.

energy_of_water_impinged(*args, **kwargs)#

Print Energy of Water Impingement.

icing_energy_of_conduction(*args, **kwargs)#

Print Energy of Conduction.

mass_of_ice(*args, **kwargs)#

Print Mass of Ice Accretion.

mass_of_water_impinged(*args, **kwargs)#

Print Mass of Water Impingement.

particles_crystals_collection_eff(*args, **kwargs)#

Print Crystals Collection Efficiency.

particles_droplets_collection_eff(*args, **kwargs)#

Print Droplets Collection Efficiency.

class modified_setting(path, service)#

Bases: TUIMenu

Enter the modified settings menu.

Methods:

modified_setting(*args, **kwargs)

Specify which areas of setup will be checked for non-default settings for generating the Modified Settings Summary table.

write_user_setting(*args, **kwargs)

Write the contents of the Modified Settings Summary table to a file.
modified_setting(*args, **kwargs)#

Specify which areas of setup will be checked for non-default settings for generating the Modified Settings Summary table. The table is displayed tabbed with the graphics window.

write_user_setting(*args, **kwargs)#

Write the contents of the Modified Settings Summary table to a file.

mphase_summary(*args, **kwargs)#

Prints summary report for a multiphase case setup.

particle_summary(*args, **kwargs)#

Prints summary report for all current particles.

path_line_summary(*args, **kwargs)#

Prints pathline summary report.

class population_balance(path, service)#

Bases: TUIMenu

Population Balance menu.

Methods:

moments(*args, **kwargs)

Set moments for population balance.

number_density(*args, **kwargs)

Set number density functions.
moments(*args, **kwargs)#

Set moments for population balance.

number_density(*args, **kwargs)#

Set number density functions.

print_histogram(*args, **kwargs)#

Prints a histogram of a scalar quantity.

projected_surface_area(*args, **kwargs)#

Computes the area of the projection of selected surfaces along the , , or axis.

class reference_values(path, service)#

Bases: TUIMenu

Enters the reference value menu.

Methods:

area(*args, **kwargs)

Sets reference area for normalization.

density(*args, **kwargs)

Sets reference density for normalization.

depth(*args, **kwargs)

Sets reference depth for volume calculation.

enthalpy(*args, **kwargs)

Sets reference enthalpy for enthalpy damping and normalization.

length(*args, **kwargs)

Sets reference length for normalization.

list(*args, **kwargs)

Lists current reference values.

pressure(*args, **kwargs)

Sets reference pressure for normalization.

temperature(*args, **kwargs)

Sets reference temperature for normalization.

velocity(*args, **kwargs)

Sets reference velocity for normalization.

viscosity(*args, **kwargs)

Sets reference viscosity for normalization.

yplus(*args, **kwargs)

Sets reference yplus for calculation of Yplus Based Heat Transfer Coefficient.

zone(*args, **kwargs)

Sets reference zone.

Classes:

compute(path, service)

Computes reference values from zone boundary conditions.
area(*args, **kwargs)#

Sets reference area for normalization.

class compute(path, service)#

Bases: TUIMenu

Computes reference values from zone boundary conditions.

Methods:

axis(*args, **kwargs)

Compute reference values from a zone of this type.

degassing(*args, **kwargs)

Compute reference values from a zone of this type.

dummy_entry(*args, **kwargs)

.

exhaust_fan(*args, **kwargs)

Compute reference values from a zone of this type.

fan(*args, **kwargs)

Compute reference values from a zone of this type.

fluid(*args, **kwargs)

Compute reference values from a zone of this type.

geometry(*args, **kwargs)

Compute reference values from a zone of this type.

inlet_vent(*args, **kwargs)

Compute reference values from a zone of this type.

intake_fan(*args, **kwargs)

Compute reference values from a zone of this type.

interface(*args, **kwargs)

Compute reference values from a zone of this type.

interior(*args, **kwargs)

Compute reference values from a zone of this type.

mass_flow_inlet(*args, **kwargs)

Compute reference values from a zone of this type.

mass_flow_outlet(*args, **kwargs)

Compute reference values from a zone of this type.

network(*args, **kwargs)

Compute reference values from a zone of this type.

network_end(*args, **kwargs)

Compute reference values from a zone of this type.

outflow(*args, **kwargs)

Compute reference values from a zone of this type.

outlet_vent(*args, **kwargs)

Compute reference values from a zone of this type.

overset(*args, **kwargs)

Compute reference values from a zone of this type.

periodic(*args, **kwargs)

Compute reference values from a zone of this type.

porous_jump(*args, **kwargs)

Compute reference values from a zone of this type.

pressure_far_field(*args, **kwargs)

Compute reference values from a zone of this type.

pressure_inlet(*args, **kwargs)

Compute reference values from a zone of this type.

pressure_outlet(*args, **kwargs)

Compute reference values from a zone of this type.

radiator(*args, **kwargs)

Compute reference values from a zone of this type.

rans_les_interface(*args, **kwargs)

Compute reference values from a zone of this type.

recirculation_inlet(*args, **kwargs)

Compute reference values from a zone of this type.

recirculation_outlet(*args, **kwargs)

Compute reference values from a zone of this type.

shadow(*args, **kwargs)

Compute reference values from a zone of this type.

solid(*args, **kwargs)

Compute reference values from a zone of this type.

symmetry(*args, **kwargs)

Compute reference values from a zone of this type.

velocity_inlet(*args, **kwargs)

Compute reference values from a zone of this type.

wall(*args, **kwargs)

Compute reference values from a zone of this type.
axis(*args, **kwargs)#

Compute reference values from a zone of this type.

degassing(*args, **kwargs)#

Compute reference values from a zone of this type.

dummy_entry(*args, **kwargs)#

.

exhaust_fan(*args, **kwargs)#

Compute reference values from a zone of this type.

fan(*args, **kwargs)#

Compute reference values from a zone of this type.

fluid(*args, **kwargs)#

Compute reference values from a zone of this type.

geometry(*args, **kwargs)#

Compute reference values from a zone of this type.

inlet_vent(*args, **kwargs)#

Compute reference values from a zone of this type.

intake_fan(*args, **kwargs)#

Compute reference values from a zone of this type.

interface(*args, **kwargs)#

Compute reference values from a zone of this type.

interior(*args, **kwargs)#

Compute reference values from a zone of this type.

mass_flow_inlet(*args, **kwargs)#

Compute reference values from a zone of this type.

mass_flow_outlet(*args, **kwargs)#

Compute reference values from a zone of this type.

network(*args, **kwargs)#

Compute reference values from a zone of this type.

network_end(*args, **kwargs)#

Compute reference values from a zone of this type.

outflow(*args, **kwargs)#

Compute reference values from a zone of this type.

outlet_vent(*args, **kwargs)#

Compute reference values from a zone of this type.

overset(*args, **kwargs)#

Compute reference values from a zone of this type.

periodic(*args, **kwargs)#

Compute reference values from a zone of this type.

porous_jump(*args, **kwargs)#

Compute reference values from a zone of this type.

pressure_far_field(*args, **kwargs)#

Compute reference values from a zone of this type.

pressure_inlet(*args, **kwargs)#

Compute reference values from a zone of this type.

pressure_outlet(*args, **kwargs)#

Compute reference values from a zone of this type.

radiator(*args, **kwargs)#

Compute reference values from a zone of this type.

rans_les_interface(*args, **kwargs)#

Compute reference values from a zone of this type.

recirculation_inlet(*args, **kwargs)#

Compute reference values from a zone of this type.

recirculation_outlet(*args, **kwargs)#

Compute reference values from a zone of this type.

shadow(*args, **kwargs)#

Compute reference values from a zone of this type.

solid(*args, **kwargs)#

Compute reference values from a zone of this type.

symmetry(*args, **kwargs)#

Compute reference values from a zone of this type.

velocity_inlet(*args, **kwargs)#

Compute reference values from a zone of this type.

wall(*args, **kwargs)#

Compute reference values from a zone of this type.

density(*args, **kwargs)#

Sets reference density for normalization.

depth(*args, **kwargs)#

Sets reference depth for volume calculation.

enthalpy(*args, **kwargs)#

Sets reference enthalpy for enthalpy damping and normalization.

length(*args, **kwargs)#

Sets reference length for normalization.

list(*args, **kwargs)#

Lists current reference values.

pressure(*args, **kwargs)#

Sets reference pressure for normalization.

temperature(*args, **kwargs)#

Sets reference temperature for normalization.

velocity(*args, **kwargs)#

Sets reference velocity for normalization.

viscosity(*args, **kwargs)#

Sets reference viscosity for normalization.

yplus(*args, **kwargs)#

Sets reference yplus for calculation of Yplus Based Heat Transfer Coefficient.

zone(*args, **kwargs)#

Sets reference zone.

class simulation_reports(path, service)#

Bases: TUIMenu

Enter the simulation reports menu.

Methods:

delete_simulation_report(*args, **kwargs)

Delete the provided simulation report.

duplicate_simulation_report(*args, **kwargs)

Duplicate a report and all of its settings to a new report.

export_simulation_report_as_html(*args, **kwargs)

Export the provided simulation report as HTML.

export_simulation_report_as_pdf(*args, **kwargs)

Export the provided simulation report as a PDF file.

export_simulation_report_as_pptx(*args, **kwargs)

Export the provided simulation report as a PPT file.

generate_simulation_report(*args, **kwargs)

Generate a new simulation report or regenerate an existing simulation report with the provided name.

list_simulation_reports(*args, **kwargs)

List all report names.

read_simulation_report_template_file(*args, ...)

Read a JSON template file with existing Simulation Report settings.

rename_simulation_report(*args, **kwargs)

Rename a report which has already been generated.

reset_report_to_defaults(*args, **kwargs)

Reset all report settings to default for the provided simulation report.

view_simulation_report(*args, **kwargs)

View a simulation report that has already been generated.

write_report_names_to_file(*args, **kwargs)

Write the list of currently generated report names to a txt file.

write_simulation_report_template_file(*args, ...)

Write a JSON template file with this case's Simulation Report settings.

Classes:

parametric_study(path, service)

Enter the parametric study menu.
delete_simulation_report(*args, **kwargs)#

Delete the provided simulation report.

duplicate_simulation_report(*args, **kwargs)#

Duplicate a report and all of its settings to a new report.

export_simulation_report_as_html(*args, **kwargs)#

Export the provided simulation report as HTML.

export_simulation_report_as_pdf(*args, **kwargs)#

Export the provided simulation report as a PDF file.

export_simulation_report_as_pptx(*args, **kwargs)#

Export the provided simulation report as a PPT file.

generate_simulation_report(*args, **kwargs)#

Generate a new simulation report or regenerate an existing simulation report with the provided name.

list_simulation_reports(*args, **kwargs)#

List all report names.

class parametric_study(path, service)#

Bases: TUIMenu

Enter the parametric study menu.

Methods:

generate_design_point_report(*args, **kwargs)

Generate a simulation report for an updated design point.

generate_parametric_report(*args, **kwargs)

Generate a parametric report for your study.
generate_design_point_report(*args, **kwargs)#

Generate a simulation report for an updated design point.

generate_parametric_report(*args, **kwargs)#

Generate a parametric report for your study.

read_simulation_report_template_file(*args, **kwargs)#

Read a JSON template file with existing Simulation Report settings.

rename_simulation_report(*args, **kwargs)#

Rename a report which has already been generated.

reset_report_to_defaults(*args, **kwargs)#

Reset all report settings to default for the provided simulation report.

view_simulation_report(*args, **kwargs)#

View a simulation report that has already been generated. In batch mode this will print the report’s URL.

write_report_names_to_file(*args, **kwargs)#

Write the list of currently generated report names to a txt file.

write_simulation_report_template_file(*args, **kwargs)#

Write a JSON template file with this case’s Simulation Report settings.

species_mass_flow(*args, **kwargs)#

Prints list of species mass flow rate at inlets and outlets. This reports the mass flow rates of all species (in kg/s) flowing through the simulation boundaries.

summary(*args, **kwargs)#

Prints the current settings for physical models, boundary conditions, material properties, and solution parameters.

surface_integrals(*args, **kwargs)#

Enters the surface integral menu.

class system(path, service)#

Bases: TUIMenu

Enters the system menu.

Methods:

gpgpu_stats(*args, **kwargs)

Prints information about installed general purpose graphical processing units.

proc_stats(*args, **kwargs)

Prints ANSYS Fluent process information.

sys_stats(*args, **kwargs)

System information.

time_stats(*args, **kwargs)

Timer information.
gpgpu_stats(*args, **kwargs)#

Prints information about installed general purpose graphical processing units.

proc_stats(*args, **kwargs)#

Prints ANSYS Fluent process information. This is used to report the memory usage of each of the ANSYS Fluent processes.

sys_stats(*args, **kwargs)#

System information. This is used to report the CPU configuration of the machines where ANSYS Fluent processes have been spawned.

time_stats(*args, **kwargs)#

Timer information. This is used to report CPU timings for user and kernel processes and detailed solver timings.

uds_flow(*args, **kwargs)#

Prints list of user-defined scalar flow rate at boundaries.

volume_integrals(*args, **kwargs)#

Enters the volume integral menu.

write_histogram(*args, **kwargs)#

Write a histogram of a scalar quantity to a file.