report#
Bases:
TUIMenu
Enter the report menu.
Methods:
aero_optical_distortions
(*args, **kwargs)Optics report menu.
dpm_extended_summary
(*args, **kwargs)Print extended discrete phase summary report of particle fates, with options.
dpm_sample
(*args, **kwargs)Sample trajectories at boundaries and lines/planes.
dpm_sample_output_udf
(*args, **kwargs)Set the DPM sampling output UDF.
dpm_sample_sort_file
(*args, **kwargs)Enable writing of sorted DPM sample files.
dpm_summary
(*args, **kwargs)Print discrete phase summary report of particle fates.
dpm_zone_summaries_per_injection
(*args, **kwargs)Enable per-injection zone DPM summaries.
element_mass_flow
(*args, **kwargs)Print list of element mass flow rates at boundaries.
mphase_summary
(*args, **kwargs)Multiphase Summary and Recommendations.
particle_summary
(*args, **kwargs)Print summary report for all current particles.
path_line_summary
(*args, **kwargs)Print path-line-summary report.
print_histogram
(*args, **kwargs)Print a histogram of a scalar quantity.
projected_surface_area
(*args, **kwargs)Print total area of the projection of a group of surfaces to a plane.
species_mass_flow
(*args, **kwargs)Print list of species mass flow rates at boundaries.
summary
(*args, **kwargs)Print report summary.
surface_integrals
(*args, **kwargs)Surface Integral menu.
uds_flow
(*args, **kwargs)Print list of UDS flow rate at boundaries.
volume_integrals
(*args, **kwargs)Volume Integral menu.
write_histogram
(*args, **kwargs)Write a histogram of a scalar quantity to a file.
Classes:
dpm_histogram
(path, service)Enter the DPM histogram menu.
fluxes
(path, service)Flux report menu.
forces
(path, service)Force report menu.
heat_exchanger
(path, service)Enter the heat exchanger menu.
icing
(path, service)Icing reports menu.
modified_setting
(path, service)Enter the menu for setting up the Modified Settings Summary table.
population_balance
(path, service)Population Balance menu.
reference_values
(path, service)Reference value menu.
simulation_reports
(path, service)Enter the simulation reports menu.
system
(path, service)Sytem menu.
Optics report menu.
Print extended discrete phase summary report of particle fates, with options.
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 minimum/maximum of a sample variable.
Delete a sample from loaded sample list.
Show all samples in loaded sample list.
Pick a sample for which to first set-up and then perform the data reduction.
Plot a histogram of a loaded sample.
Prepare named expressions from data in a DPM sample file (collected at a cut plane surface) for contour plotting.
Read a sample file and add it to the sample list.
Reduce a sample after first picking it and setting up all data-reduction options and parameters.
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.
Automatically compute range of sampling variable for histogram plots.
Compute correlation of sampling variable with other variable.
Compute a cumulative curve for sampling variable or correlation variable when correlation? was specified.
Compute Rosin Rammler parameters, Sauter and other mean diameters. Requires specification of diameter as sampling variable.
Use bars for histogram plot or xy-style.
Use logarithmic scaling on the abscissa (variable axis)? – Will not work unless all values are positive.
Specify maximum value of x-axis variable for histogram plots.
Specify mimimum value of x-axis variable for histogram plots.
Specify the number of bins.
Use percentages of bins to be computed.
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.
Use weighting with additional variable when sorting data into samples.
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.
Set the number of bins to be used for ALL variables in the data reduction.
List all user inputs for the sample picked for data reduction.
Switch on or off logarithmic scaling to be used for a specific variable in the data reduction.
Specify whether the unsteady sample is to be reduced into a steady-state injection file.
Set the maximum value of the range to be considered for a specific variable in the data reduction.
Set the minimum value of the range to be considered for a specific variable in the data reduction.
Set the number of bins to be used for a specific variable in the data reduction.
Reset the min and max values of the range to be considered for a specific variable in the data reduction.
Specify whether to use any weighting in the averaging that is done in each bin in the data reduction.
Choose the weighting variable for the averaging in each bin in the data reduction.
Write a histogram of a loaded sample into a file.
Sample trajectories at boundaries and lines/planes.
Set the DPM sampling output UDF.
Enable writing of sorted DPM sample files.
Print discrete phase summary report of particle fates.
Enable per-injection zone DPM summaries.
Print list of element mass flow rates at boundaries.
Bases:
TUIMenu
Flux report menu.
Methods:
film_heat_transfer
(*args, **kwargs)Print film heat transfer rate at boundaries.
film_mass_flow
(*args, **kwargs)Print film mass flow rate at boundaries.
heat_transfer
(*args, **kwargs)Print heat transfer rate at boundaries.
heat_transfer_sensible
(*args, **kwargs)Print sensible heat transfer rate at boundaries.
mass_flow
(*args, **kwargs)Print mass flow rate at inlets and outlets.
pressure_work
(*args, **kwargs)Print pressure work rate at moving boundaries.
rad_heat_trans
(*args, **kwargs)Print radiation heat transfer rate at boundaries.
viscous_work
(*args, **kwargs)Print viscous work rate at boundaries.
Print film heat transfer rate at boundaries.
Print film mass flow rate at boundaries.
Print heat transfer rate at boundaries.
Print sensible heat transfer rate at boundaries.
Print mass flow rate at inlets and outlets.
Print pressure work rate at moving boundaries.
Print radiation heat transfer rate at boundaries.
Print viscous work rate at boundaries.
Bases:
TUIMenu
Force report menu.
Methods:
pressure_center
(*args, **kwargs)Print center of pressure on wall zones.
wall_forces
(*args, **kwargs)Print integrated pressure and viscous forces on wall zones.
wall_moments
(*args, **kwargs)Print integrated pressure and viscous moments on wall zones.
Print center of pressure on wall zones.
Print integrated pressure and viscous forces on wall zones.
Print integrated pressure and viscous moments on wall zones.
Bases:
TUIMenu
Enter the heat exchanger menu.
Methods:
computed_heat_rejection
(*args, **kwargs)Print total heat rejection.
inlet_temperature
(*args, **kwargs)Print inlet temperature.
mass_flow_rate
(*args, **kwargs)Print mass flow rate.
outlet_temperature
(*args, **kwargs)Print outlet temperature.
specific_heat
(*args, **kwargs)Print fluid's specific heat.
Print total heat rejection.
Print inlet temperature.
Print mass flow rate.
Print outlet temperature.
Print fluid’s specific heat.
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.
Print Energy of Ice Formation.
Print Energy of Water Impingement.
Print Energy of Conduction.
Print Mass of Ice Accretion.
Print Mass of Water Impingement.
Print Crystals Collection Efficiency.
Print Droplets Collection Efficiency.
Bases:
TUIMenu
Enter the menu for setting up the Modified Settings Summary table.
Methods:
modified_setting
(*args, **kwargs).
write_user_setting
(*args, **kwargs).
.
.
Multiphase Summary and Recommendations.
Print summary report for all current particles.
Print path-line-summary report.
Bases:
TUIMenu
Population Balance menu.
Methods:
moments
(*args, **kwargs)Set moments for population balance.
number_density
(*args, **kwargs)Set number density functions.
Set moments for population balance.
Set number density functions.
Print a histogram of a scalar quantity.
Print total area of the projection of a group of surfaces to a plane.
Bases:
TUIMenu
Reference value menu.
Methods:
area
(*args, **kwargs)Set reference area for normalization.
density
(*args, **kwargs)Set reference density for normalization.
depth
(*args, **kwargs)Set reference depth for volume calculation.
enthalpy
(*args, **kwargs)Set reference enthalpy for enthalpy damping and normalization.
length
(*args, **kwargs)Set reference length for normalization.
list
(*args, **kwargs)List current reference values.
pressure
(*args, **kwargs)Set reference pressure for normalization.
temperature
(*args, **kwargs)Set reference temperature for normalization.
velocity
(*args, **kwargs)Set reference velocity for normalization.
viscosity
(*args, **kwargs)Set reference viscosity for normalization.
yplus
(*args, **kwargs)Set reference yplus for normalization.
zone
(*args, **kwargs)Set reference zone.
Classes:
compute
(path, service)Enter the compute menu.
Set reference area for normalization.
Bases:
TUIMenu
Enter the compute menu.
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.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Compute reference values from a zone of this type.
Set reference density for normalization.
Set reference depth for volume calculation.
Set reference enthalpy for enthalpy damping and normalization.
Set reference length for normalization.
List current reference values.
Set reference pressure for normalization.
Set reference temperature for normalization.
Set reference velocity for normalization.
Set reference viscosity for normalization.
Set reference yplus for normalization.
Set reference zone.
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 the provided simulation report.
Duplicate a report and all of its settings to a new report.
Export the provided simulation report as HTML.
Export the provided simulation report as a PDF file.
Export the provided simulation report as a PPT file.
Generate a new simulation report or regenerate an existing simulation report with the provided name.
List all report names.
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 a simulation report for an updated design point.
Generate a parametric report for your study.
Read a JSON template file with existing Simulation Report settings.
Rename a report which has already been generated.
Reset all report settings to default for the provided simulation report.
View a simulation report that has already been generated. In batch mode this will print the report’s URL.
Write the list of currently generated report names to a txt file.
Write a JSON template file with this case’s Simulation Report settings.
Print list of species mass flow rates at boundaries.
Print report summary.
Surface Integral menu.
Bases:
TUIMenu
Sytem menu.
Methods:
gpgpu_stats
(*args, **kwargs)GPGPU information.
proc_stats
(*args, **kwargs)Fluent process information.
sys_stats
(*args, **kwargs)System information.
time_stats
(*args, **kwargs)Time usage information.
GPGPU information.
Fluent process information.
System information.
Time usage information.
Print list of UDS flow rate at boundaries.
Volume Integral menu.
Write a histogram of a scalar quantity to a file.