dpm#

class ansys.fluent.core.solver.tui_231.main_menu.setup.models.dpm(path, service)#

Bases: TUIMenu

Enter the dispersed phase model menu.

Methods:

clear_particles_from_domain(*args, **kwargs)

Remove/keep all particles currently in the domain.

fill_injection_material_sources(*args, **kwargs)

Initialize the DPM sources corresponding to each material.

injections(*args, **kwargs)

Enter the injections menu.

spray_model(*args, **kwargs)

Enter the spray model menu.

unsteady_tracking(*args, **kwargs)

Enable/disable unsteady particle tracking.

user_defined(*args, **kwargs)

Set DPM user-defined functions.

Classes:

collisions(path, service)

Enter the DEM collisions menu.

erosion_dynamic_mesh(path, service)

Enter the erosion-dynamic mesh interactions menu.

interaction(path, service)

Enter the interaction menu to set parameters for coupled discrete phase calculations.

numerics(path, service)

Enter the numerics menu to set numerical solution parameters.

options(path, service)

Enter the options menu to set optional DPM models.

parallel(path, service)

Enter the parallel menu.

splash_options(path, service)

Enter the splash options menu to set optional parameters.

stripping_options(path, service)

Enter the stripping options menu to set optional parameters.
clear_particles_from_domain(*args, **kwargs)#

Remove/keep all particles currently in the domain.

class collisions(path, service)#

Bases: TUIMenu

Enter the DEM collisions menu.

Methods:

collision_mesh(*args, **kwargs)

Input for the collision mesh.

collision_pair_settings(*args, **kwargs)

Supply settings for collisions to a pair of collision partners.

dem_collisions(*args, **kwargs)

Enable/disable the DEM collision model.

list_all_pair_settings(*args, **kwargs)

For each pair of collision partners, lists the collision laws and their parameters.

max_particle_velocity(*args, **kwargs)

Set the maximum particle velocity that may arise from collisions.

Classes:

collision_partners(path, service)

Manage collision partners.
collision_mesh(*args, **kwargs)#

Input for the collision mesh.

collision_pair_settings(*args, **kwargs)#

Supply settings for collisions to a pair of collision partners.

class collision_partners(path, service)#

Bases: TUIMenu

Manage collision partners.

Methods:

copy(*args, **kwargs)

Copy a collision partner.

create(*args, **kwargs)

Create a collision partner.

delete(*args, **kwargs)

Delete a collision partner.

list(*args, **kwargs)

Lists all known collision partners.

rename(*args, **kwargs)

Rename a collision partner.
copy(*args, **kwargs)#

Copy a collision partner.

create(*args, **kwargs)#

Create a collision partner.

delete(*args, **kwargs)#

Delete a collision partner.

list(*args, **kwargs)#

Lists all known collision partners.

rename(*args, **kwargs)#

Rename a collision partner.

dem_collisions(*args, **kwargs)#

Enable/disable the DEM collision model.

list_all_pair_settings(*args, **kwargs)#

For each pair of collision partners, lists the collision laws and their parameters.

max_particle_velocity(*args, **kwargs)#

Set the maximum particle velocity that may arise from collisions.

class erosion_dynamic_mesh(path, service)#

Bases: TUIMenu

Enter the erosion-dynamic mesh interactions menu.

Methods:

enable_erosion_dynamic_mesh_coupling(*args, ...)

Enable mesh deformation due to wall erosion.

run_simulation(*args, **kwargs)

Perform coupled erosion-dynamic mesh simulation.

Classes:

general_parameters(path, service)

Enter the erosion-dynamic mesh setup menu.

run_parameters(path, service)

Enter the erosion-dynamic mesh run menu.
enable_erosion_dynamic_mesh_coupling(*args, **kwargs)#

Enable mesh deformation due to wall erosion.

class general_parameters(path, service)#

Bases: TUIMenu

Enter the erosion-dynamic mesh setup menu.

Methods:

dynamic_mesh_settings(*args, **kwargs)

Perform dynamic mesh related setup.

erosion_settings(*args, **kwargs)

Set erosion modelling specific settings.

participating_walls(*args, **kwargs)

Specify all participating walls.
dynamic_mesh_settings(*args, **kwargs)#

Perform dynamic mesh related setup.

erosion_settings(*args, **kwargs)#

Set erosion modelling specific settings.

participating_walls(*args, **kwargs)#

Specify all participating walls.

class run_parameters(path, service)#

Bases: TUIMenu

Enter the erosion-dynamic mesh run menu.

Methods:

autosave_files(*args, **kwargs)

Set the iteration increment to save data files.

autosave_graphics(*args, **kwargs)

Set the iteration increment to save graphics files.

flow_simulation_control(*args, **kwargs)

Set number of iterations per flow simulation step.

mesh_motion_time_step(*args, **kwargs)

Set the mesh motion time stepping parameters and method.

simulation_termination(*args, **kwargs)

Set total time of erosion.
autosave_files(*args, **kwargs)#

Set the iteration increment to save data files.

autosave_graphics(*args, **kwargs)#

Set the iteration increment to save graphics files.

flow_simulation_control(*args, **kwargs)#

Set number of iterations per flow simulation step.

mesh_motion_time_step(*args, **kwargs)#

Set the mesh motion time stepping parameters and method.

simulation_termination(*args, **kwargs)#

Set total time of erosion.

run_simulation(*args, **kwargs)#

Perform coupled erosion-dynamic mesh simulation.

fill_injection_material_sources(*args, **kwargs)#

Initialize the DPM sources corresponding to each material.

injections(*args, **kwargs)#

Enter the injections menu.

class interaction(path, service)#

Bases: TUIMenu

Enter the interaction menu to set parameters for coupled discrete phase calculations.

Methods:

choice_of_eulerian_phase_for_interaction(...)

Enable/disable the option to choose for every injection the Eulerian phase for the DPM continuous phase interaction.

coupled_calculations(*args, **kwargs)

Enable/disable coupling of continuous and discrete phase calculations.

ddpm_energy_coupling_via_source_term(*args, ...)

Energy coupling in DDPM established via source term.

ddpm_enhanced_inter_phase_exchange(*args, ...)

Enhanced Eulerian inter-phase exchange.

ddpm_iad_particle(*args, **kwargs)

Enable/disable the non-default interfacial area method IA-particle.

dpm_iteration_interval(*args, **kwargs)

Set the number of continuous phase iterations per DPM iteration.

enable_drag_scaling_due_to_flow_blocking(...)

Enable/disable scaling of DPM drag coefficient due to inclusion of DPM volume fraction in continuous flow.

enable_flow_blocking_by_particles(*args, ...)

Enable/disable inclusion of DPM volume fraction in continuous flow.

enable_source_scaling_due_to_flow_blocking(...)

Enable/disable scaling of DPM source terms due to inclusion of DPM volume fraction in continuous flow.

implicit_momentum_coupling(*args, **kwargs)

Enable/disable implicit treatment for the DPM momentum source terms.

implicit_source_term_coupling(*args, **kwargs)

Enable/disable implicit treatment for all DPM source terms.

keep_linearized_dpm_source_terms_constant(...)

Keep linearized DPM source terms constant until the next DPM Update.

linear_growth_of_dpm_source_term(*args, **kwargs)

Enable/disable the linear growth of DPM source terms every DPM iteration.

linearized_dpm_mixture_fraction_source_terms(...)

Perform a linearization of mixture fraction source terms.

linearized_dpm_source_terms(*args, **kwargs)

Perform a linearization of all DPM source terms to increase numerical robustness.

linearized_dpm_source_terms_limiter(*args, ...)

Relative limit for DPM source linear coefficient with respect to fluid linear Ap coefficient.

linearized_dpm_species_source_terms(*args, ...)

Perform linearization of species source terms.

max_vf_allowed_for_blocking(*args, **kwargs)

Maximum DPM volume fraction used in continuous flow.

min_vf_threshold_for_dpm_src_scaling(*args, ...)

Minimum DPM volume fraction below which no DPM source scaling is applied.

replace_dpm_mass_source_by_mixture_fraction(...)

Recalculate the mixture fraction source terms as function of the primary mixture fraction?.

reset_sources_at_timestep(*args, **kwargs)

Enable/disable flush of DPM source terms at beginning of every time step.

underrelaxation_factor(*args, **kwargs)

Set the under-relaxation factor.

update_dpm_sources_every_flow_iteration(...)

Enable/disable the update of DPM source terms every flow iteration.
choice_of_eulerian_phase_for_interaction(*args, **kwargs)#

Enable/disable the option to choose for every injection the Eulerian phase for the DPM continuous phase interaction.

coupled_calculations(*args, **kwargs)#

Enable/disable coupling of continuous and discrete phase calculations.

ddpm_energy_coupling_via_source_term(*args, **kwargs)#

Energy coupling in DDPM established via source term.

ddpm_enhanced_inter_phase_exchange(*args, **kwargs)#

Enhanced Eulerian inter-phase exchange.

ddpm_iad_particle(*args, **kwargs)#

Enable/disable the non-default interfacial area method IA-particle.

dpm_iteration_interval(*args, **kwargs)#

Set the number of continuous phase iterations per DPM iteration.

enable_drag_scaling_due_to_flow_blocking(*args, **kwargs)#

Enable/disable scaling of DPM drag coefficient due to inclusion of DPM volume fraction in continuous flow.

enable_flow_blocking_by_particles(*args, **kwargs)#

Enable/disable inclusion of DPM volume fraction in continuous flow.

enable_source_scaling_due_to_flow_blocking(*args, **kwargs)#

Enable/disable scaling of DPM source terms due to inclusion of DPM volume fraction in continuous flow.

implicit_momentum_coupling(*args, **kwargs)#

Enable/disable implicit treatment for the DPM momentum source terms.

implicit_source_term_coupling(*args, **kwargs)#

Enable/disable implicit treatment for all DPM source terms.

keep_linearized_dpm_source_terms_constant(*args, **kwargs)#

Keep linearized DPM source terms constant until the next DPM Update.

linear_growth_of_dpm_source_term(*args, **kwargs)#

Enable/disable the linear growth of DPM source terms every DPM iteration. .

linearized_dpm_mixture_fraction_source_terms(*args, **kwargs)#

Perform a linearization of mixture fraction source terms.

linearized_dpm_source_terms(*args, **kwargs)#

Perform a linearization of all DPM source terms to increase numerical robustness.

linearized_dpm_source_terms_limiter(*args, **kwargs)#

Relative limit for DPM source linear coefficient with respect to fluid linear Ap coefficient.

linearized_dpm_species_source_terms(*args, **kwargs)#

Perform linearization of species source terms.

max_vf_allowed_for_blocking(*args, **kwargs)#

Maximum DPM volume fraction used in continuous flow.

min_vf_threshold_for_dpm_src_scaling(*args, **kwargs)#

Minimum DPM volume fraction below which no DPM source scaling is applied.

replace_dpm_mass_source_by_mixture_fraction(*args, **kwargs)#

Recalculate the mixture fraction source terms as function of the primary mixture fraction?.

reset_sources_at_timestep(*args, **kwargs)#

Enable/disable flush of DPM source terms at beginning of every time step.

underrelaxation_factor(*args, **kwargs)#

Set the under-relaxation factor.

update_dpm_sources_every_flow_iteration(*args, **kwargs)#

Enable/disable the update of DPM source terms every flow iteration. (if not, the terms will be updated every DPM iteration).

class numerics(path, service)#

Bases: TUIMenu

Enter the numerics menu to set numerical solution parameters.

Methods:

automated_scheme_selection(*args, **kwargs)

Enable/disable the adaptation of integration step length based on a maximum error.

average_DDPM_variables(*args, **kwargs)

Average DDPM specific variables like volume fractions and velocities on nodes.

average_each_step(*args, **kwargs)

Do the averaging after each integration step for higher accuracy at a higher cost.

average_kernel(*args, **kwargs)

Specify a kernel for the averaging.

average_source_terms(*args, **kwargs)

Average DPM source terms on nodes.

coupled_heat_mass_update(*args, **kwargs)

Enable/disable coupled heat and mass update.

drag_law(*args, **kwargs)

Set the drag law.

dynamic_interaction(*args, **kwargs)

Enable/disable dynamic interaction range.

enable_node_based_averaging(*args, **kwargs)

Enable node based averaging of DPM variables.

enhanced_packing_limit_numerics(*args, **kwargs)

Enable enhanced packing limit numerics to avoid exceeding of packing limit for granular phases.

error_control(*args, **kwargs)

Set the adapt integration step length based on a maximum error.

gaussian_factor(*args, **kwargs)

Set a factor for the gaussian kernel for node-based averaging.~%Large values give small size, small values give large size of kernel.

granular_stress_tensor(*args, **kwargs)

Enable granular stress tensor to be considered with solid pressure gradient as collision force.

minimum_liquid_fraction(*args, **kwargs)

Evaporate droplet completely when the remaining mass is below this fraction of initial mass.

mppic_settings(*args, **kwargs)

Enable PIC and MPPIC to compute DPM and DDPM source terms.

predictor_corrector(*args, **kwargs)

Enable predictor/corrector approach to track particles.

tracking_parameters(*args, **kwargs)

Set parameters for the (initial) tracking step length.

tracking_scheme(*args, **kwargs)

Specify a tracking scheme.

tracking_statistics(*args, **kwargs)

Control the format of the one-line tracking statistics printed after every DPM tracking pass.

underrelax_film_height(*args, **kwargs)

Define underrelaxation factor for film height.

vaporization_limiting_factors(*args, **kwargs)

Set Vaporization Fractional Change Limits.

verbosity(*args, **kwargs)

Adjust the DPM tracker's verbosity level.

Classes:

high_resolution_tracking(path, service)

Enter the high resolution tracking menu.
automated_scheme_selection(*args, **kwargs)#

Enable/disable the adaptation of integration step length based on a maximum error.

average_DDPM_variables(*args, **kwargs)#

Average DDPM specific variables like volume fractions and velocities on nodes.

average_each_step(*args, **kwargs)#

Do the averaging after each integration step for higher accuracy at a higher cost.

average_kernel(*args, **kwargs)#

Specify a kernel for the averaging.

average_source_terms(*args, **kwargs)#

Average DPM source terms on nodes.

coupled_heat_mass_update(*args, **kwargs)#

Enable/disable coupled heat and mass update.

drag_law(*args, **kwargs)#

Set the drag law.

dynamic_interaction(*args, **kwargs)#

Enable/disable dynamic interaction range.

enable_node_based_averaging(*args, **kwargs)#

Enable node based averaging of DPM variables.

enhanced_packing_limit_numerics(*args, **kwargs)#

Enable enhanced packing limit numerics to avoid exceeding of packing limit for granular phases.

error_control(*args, **kwargs)#

Set the adapt integration step length based on a maximum error.

gaussian_factor(*args, **kwargs)#

Set a factor for the gaussian kernel for node-based averaging.~%Large values give small size, small values give large size of kernel.

granular_stress_tensor(*args, **kwargs)#

Enable granular stress tensor to be considered with solid pressure gradient as collision force.

class high_resolution_tracking(path, service)#

Bases: TUIMenu

Enter the high resolution tracking menu.

Methods:

always_use_face_centroid_with_periodics(...)

Use quad face centroids when creating subtets if the case contains periodic boundaries.

boundary_layer_tracking(*args, **kwargs)

Adjust the particle timestep to account for high aspect ratio cells.

check_subtet_validity(*args, **kwargs)

Test for inverted subtets due to warped cells.

enable_automatic_intersection_tolerance(...)

Enable automatic scaling of subtet intersection tolerance.

enable_barycentric_intersections(*args, **kwargs)

Use barycentric coordinates for intersection calculations.

enable_high_resolution_tracking(*args, **kwargs)

Enable high resolution tracking.

project_wall_film_particles_to_film(*args, ...)

Project existing particles to film to track using high resolution tracking?.

remove_stuck_particles(*args, **kwargs)

Remove particles that are stuck at edges or faces.

set_film_spreading_parameter(*args, **kwargs)

Set the spreading parameter for Lagrangian wallfilm particles.

set_subtet_intersection_tolerance(*args, ...)

Set the tolerance for subtet intersection calculations.

sliding_interface_crossover_fraction(*args, ...)

Move the particle a fraction of the distance to the subtet center when crossing a sliding interface.

use_barycentric_sampling(*args, **kwargs)

Use barycentric coordinates when sampling at planes.

use_particle_timestep_for_intersection_tolerance(...)

Use the particle timestep for the axisymmetric subtet intersection tolerance.

use_quad_face_centroid(*args, **kwargs)

Use quad face centroids when creating subtets.

use_velocity_based_error_control(*args, **kwargs)

Use adaptive time stepping based upon the particle velocity.

Classes:

barycentric_interpolation(path, service)

Enter the barycentric interpolation menu.

particle_relocation(path, service)

Enter the particle relocation menu.
always_use_face_centroid_with_periodics(*args, **kwargs)#

Use quad face centroids when creating subtets if the case contains periodic boundaries.

class barycentric_interpolation(path, service)#

Bases: TUIMenu

Enter the barycentric interpolation menu.

Methods:

enable_transient_variable_interpolation(...)

Enable transient variable interpolation.

interpolate_flow_cp(*args, **kwargs)

Enable interpolation of flow specific heat to the particle position.

interpolate_flow_density(*args, **kwargs)

Enable interpolation of flow density to the particle position.

interpolate_flow_solution_gradients(*args, ...)

Enable interpolation of flow solution gradients.

interpolate_flow_viscosity(*args, **kwargs)

Enable interpolation of flow viscosity to the particle position.

interpolate_temperature(*args, **kwargs)

Enable interpolation of temperature to the particle position.

interpolate_wallfilm_properties(*args, **kwargs)

Enable interpolation of wallfilm properties to the particle position.

nodal_reconstruction_frequency(*args, **kwargs)

Update nodal reconstruction every N'th DPM iteration.

precompute_pdf_species(*args, **kwargs)

Precompute cell values of PDF species mass fractions prior to particle tracking.

user_interpolation_function(*args, **kwargs)

Enter user interpolation function.

zero_nodal_velocity_on_walls(*args, **kwargs)

Set the nodal velocity on all walls to zero.
enable_transient_variable_interpolation(*args, **kwargs)#

Enable transient variable interpolation.

interpolate_flow_cp(*args, **kwargs)#

Enable interpolation of flow specific heat to the particle position.

interpolate_flow_density(*args, **kwargs)#

Enable interpolation of flow density to the particle position.

interpolate_flow_solution_gradients(*args, **kwargs)#

Enable interpolation of flow solution gradients.

interpolate_flow_viscosity(*args, **kwargs)#

Enable interpolation of flow viscosity to the particle position.

interpolate_temperature(*args, **kwargs)#

Enable interpolation of temperature to the particle position.

interpolate_wallfilm_properties(*args, **kwargs)#

Enable interpolation of wallfilm properties to the particle position.

nodal_reconstruction_frequency(*args, **kwargs)#

Update nodal reconstruction every N’th DPM iteration.

precompute_pdf_species(*args, **kwargs)#

Precompute cell values of PDF species mass fractions prior to particle tracking.

user_interpolation_function(*args, **kwargs)#

Enter user interpolation function.

zero_nodal_velocity_on_walls(*args, **kwargs)#

Set the nodal velocity on all walls to zero.

boundary_layer_tracking(*args, **kwargs)#

Adjust the particle timestep to account for high aspect ratio cells.

check_subtet_validity(*args, **kwargs)#

Test for inverted subtets due to warped cells.

enable_automatic_intersection_tolerance(*args, **kwargs)#

Enable automatic scaling of subtet intersection tolerance.

enable_barycentric_intersections(*args, **kwargs)#

Use barycentric coordinates for intersection calculations.

enable_high_resolution_tracking(*args, **kwargs)#

Enable high resolution tracking.

class particle_relocation(path, service)#

Bases: TUIMenu

Enter the particle relocation menu.

Methods:

enhanced_cell_relocation_method(*args, **kwargs)

Enable enhanced method of locating particles in cells.

enhanced_wallfilm_location_method(*args, ...)

Enable enhanced method of locating film particles on faces.

load_legacy_particles(*args, **kwargs)

Load particles that were tracked without high-resolution tracking enabled.

overset_relocation_robustness_level(*args, ...)

Set the robustness level for particle relocation in overset meshes.

use_legacy_particle_location_method(*args, ...)

Enable legacy method of locating particles in cells.

wallfilm_relocation_tolerance_scale_factor(...)

Set the relocation tolerance scaling factor for wallfilm particles after remeshing.
enhanced_cell_relocation_method(*args, **kwargs)#

Enable enhanced method of locating particles in cells.

enhanced_wallfilm_location_method(*args, **kwargs)#

Enable enhanced method of locating film particles on faces.

load_legacy_particles(*args, **kwargs)#

Load particles that were tracked without high-resolution tracking enabled.

overset_relocation_robustness_level(*args, **kwargs)#

Set the robustness level for particle relocation in overset meshes.

use_legacy_particle_location_method(*args, **kwargs)#

Enable legacy method of locating particles in cells.

wallfilm_relocation_tolerance_scale_factor(*args, **kwargs)#

Set the relocation tolerance scaling factor for wallfilm particles after remeshing.

project_wall_film_particles_to_film(*args, **kwargs)#

Project existing particles to film to track using high resolution tracking?.

remove_stuck_particles(*args, **kwargs)#

Remove particles that are stuck at edges or faces.

set_film_spreading_parameter(*args, **kwargs)#

Set the spreading parameter for Lagrangian wallfilm particles.

set_subtet_intersection_tolerance(*args, **kwargs)#

Set the tolerance for subtet intersection calculations.

sliding_interface_crossover_fraction(*args, **kwargs)#

Move the particle a fraction of the distance to the subtet center when crossing a sliding interface.

use_barycentric_sampling(*args, **kwargs)#

Use barycentric coordinates when sampling at planes.

use_particle_timestep_for_intersection_tolerance(*args, **kwargs)#

Use the particle timestep for the axisymmetric subtet intersection tolerance.

use_quad_face_centroid(*args, **kwargs)#

Use quad face centroids when creating subtets.

use_velocity_based_error_control(*args, **kwargs)#

Use adaptive time stepping based upon the particle velocity.

minimum_liquid_fraction(*args, **kwargs)#

Evaporate droplet completely when the remaining mass is below this fraction of initial mass.

mppic_settings(*args, **kwargs)#

Enable PIC and MPPIC to compute DPM and DDPM source terms.

predictor_corrector(*args, **kwargs)#

Enable predictor/corrector approach to track particles.

tracking_parameters(*args, **kwargs)#

Set parameters for the (initial) tracking step length.

tracking_scheme(*args, **kwargs)#

Specify a tracking scheme.

tracking_statistics(*args, **kwargs)#

Control the format of the one-line tracking statistics printed after every DPM tracking pass.

underrelax_film_height(*args, **kwargs)#

Define underrelaxation factor for film height.

vaporization_limiting_factors(*args, **kwargs)#

Set Vaporization Fractional Change Limits.

verbosity(*args, **kwargs)#

Adjust the DPM tracker’s verbosity level.

class options(path, service)#

Bases: TUIMenu

Enter the options menu to set optional DPM models.

Methods:

allow_supercritical_pressure_vaporization(...)

Skip the pressure dependent boiling point calculation to allow supercritical pressure conditions for vaporization.

brownian_motion(*args, **kwargs)

Enable/disable Brownian motion of particles.

convective_film_heat_transfer(*args, **kwargs)

Enable/disable convection/conduction film to wall heat transfer model.

current_positions_in_sample_file_format(...)

Write the current positions (step-by-step history report for unsteady tracking) in the sampling file format.

enable_contour_plots(*args, **kwargs)

Enable contour and vector plots of particle data.

ensemble_average(*args, **kwargs)

Set ensemble average cloud properties.

erosion_accretion(*args, **kwargs)

Enable/disable erosion/accretion.

include_lwf_particles_in_dpm_concentration(...)

Include LWF particle mass in DPM Concentration.

init_erosion_accretion_rate(*args, **kwargs)

Initialize erosion/accretion rates with Zero.

lowest_volatiles_mass_fraction(*args, **kwargs)

Set the lowest volatiles mass fraction.

maximum_udf_species(*args, **kwargs)

Maximum number of species that can interact with particles in the DPM UDFs.

particle_radiation(*args, **kwargs)

Enable/disable particle radiation.

pressure_gradient_force(*args, **kwargs)

Enable/disable pressure gradient force.

remove_wall_film_temperature_limiter(*args, ...)

Remove the wall film temperature limiter.

saffman_lift_force(*args, **kwargs)

Enable/disable Saffman lift force.

scr_urea_deposition_risk_analysis(*args, ...)

Options to activate and configure the SCR urea deposition risk analysis.

set_minimum_particle_diameter(*args, **kwargs)

Set the minimum particle diameter.

set_thermolysis_limit(*args, **kwargs)

Set the thermolysis limit.

stagger_radius(*args, **kwargs)

Provide a stagger radius for non atomizer injections.

stagger_spatially_atomizer_injections(*args, ...)

Spatially stagger atomizer injections?.

stagger_spatially_standard_injections(*args, ...)

Spatially stagger non-atomizer injections?.

stagger_temporally(*args, **kwargs)

Stagger transient parcels for their first time step?.

staggering_factor(*args, **kwargs)

Set the staggering factor between 0 and 1 to control the amount of staggering.

step_report_sig_figures(*args, **kwargs)

Set significant figures in the step-by-step report.

thermophoretic_force(*args, **kwargs)

Enable/disable thermophoretic force.

track_in_absolute_frame(*args, **kwargs)

Enable/disable tracking in absolute frame.

treat_multicomponent_saturation_temperature_failure(...)

Dump multicomponent particle mass if the saturation temperature cannot be determined.

two_way_coupling(*args, **kwargs)

Enable/disable calculation of DPM sources in TKE equation.

uniform_mass_distribution_for_injections(...)

A uniform mass distribution will be enabled for all solid cone and atomizer injections.

use_absolute_pressure_for_vaporization(...)

Enable/disable using Absolute Pressure for Vaporization.

vaporization_heat_transfer_averaging(*args, ...)

Enable/disable correction for Vaporization heat transfer.

vaporization_options(*args, **kwargs)

Set Vaporization options.

virtual_mass_force(*args, **kwargs)

Enable/disable virtual mass force.
allow_supercritical_pressure_vaporization(*args, **kwargs)#

Skip the pressure dependent boiling point calculation to allow supercritical pressure conditions for vaporization.

brownian_motion(*args, **kwargs)#

Enable/disable Brownian motion of particles.

convective_film_heat_transfer(*args, **kwargs)#

Enable/disable convection/conduction film to wall heat transfer model.

current_positions_in_sample_file_format(*args, **kwargs)#

Write the current positions (step-by-step history report for unsteady tracking) in the sampling file format.

enable_contour_plots(*args, **kwargs)#

Enable contour and vector plots of particle data.

ensemble_average(*args, **kwargs)#

Set ensemble average cloud properties.

erosion_accretion(*args, **kwargs)#

Enable/disable erosion/accretion.

include_lwf_particles_in_dpm_concentration(*args, **kwargs)#

Include LWF particle mass in DPM Concentration.

init_erosion_accretion_rate(*args, **kwargs)#

Initialize erosion/accretion rates with Zero.

lowest_volatiles_mass_fraction(*args, **kwargs)#

Set the lowest volatiles mass fraction.

maximum_udf_species(*args, **kwargs)#

Maximum number of species that can interact with particles in the DPM UDFs.

particle_radiation(*args, **kwargs)#

Enable/disable particle radiation.

pressure_gradient_force(*args, **kwargs)#

Enable/disable pressure gradient force.

remove_wall_film_temperature_limiter(*args, **kwargs)#

Remove the wall film temperature limiter.

saffman_lift_force(*args, **kwargs)#

Enable/disable Saffman lift force.

scr_urea_deposition_risk_analysis(*args, **kwargs)#

Options to activate and configure the SCR urea deposition risk analysis.

set_minimum_particle_diameter(*args, **kwargs)#

Set the minimum particle diameter.

set_thermolysis_limit(*args, **kwargs)#

Set the thermolysis limit.

stagger_radius(*args, **kwargs)#

Provide a stagger radius for non atomizer injections.

stagger_spatially_atomizer_injections(*args, **kwargs)#

Spatially stagger atomizer injections?.

stagger_spatially_standard_injections(*args, **kwargs)#

Spatially stagger non-atomizer injections?.

stagger_temporally(*args, **kwargs)#

Stagger transient parcels for their first time step?.

staggering_factor(*args, **kwargs)#

Set the staggering factor between 0 and 1 to control the amount of staggering.

step_report_sig_figures(*args, **kwargs)#

Set significant figures in the step-by-step report.

thermophoretic_force(*args, **kwargs)#

Enable/disable thermophoretic force.

track_in_absolute_frame(*args, **kwargs)#

Enable/disable tracking in absolute frame.

treat_multicomponent_saturation_temperature_failure(*args, **kwargs)#

Dump multicomponent particle mass if the saturation temperature cannot be determined.

two_way_coupling(*args, **kwargs)#

Enable/disable calculation of DPM sources in TKE equation.

uniform_mass_distribution_for_injections(*args, **kwargs)#

A uniform mass distribution will be enabled for all solid cone and atomizer injections.

use_absolute_pressure_for_vaporization(*args, **kwargs)#

Enable/disable using Absolute Pressure for Vaporization.

vaporization_heat_transfer_averaging(*args, **kwargs)#

Enable/disable correction for Vaporization heat transfer.

vaporization_options(*args, **kwargs)#

Set Vaporization options.

virtual_mass_force(*args, **kwargs)#

Enable/disable virtual mass force.

class parallel(path, service)#

Bases: TUIMenu

Enter the parallel menu.

Methods:

enable_workpile(*args, **kwargs)

Enable/disable the particle workpile algorithm.

fix_source_term_accumulation_order(*args, ...)

Enforce deterministic order of source term accumulation.

hybrid_2domain(*args, **kwargs)

Use DPM domain to simulate particles.

hybrid_collision_model(*args, **kwargs)

An EXPERIMENTAL feature to allow 'hybrid' DPM parallel tracking with the collision / coalescence model.

hybrid_collision_unidirectional(*args, **kwargs)

A faster, yet potentially somewhat less accurate, modification to the beta feature that allows 'hybrid' DPM parallel tracking with the collision / coalescence model.

hybrid_collision_variant(*args, **kwargs)

Further reduce the residual risk of dead-locks in the experimental feature that allows 'hybrid' DPM parallel tracking with the collision / coalescence model.

hybrid_workpile(*args, **kwargs)

Optimize multi-thread load balancing within each partition in hybrid-parallel DPM tracking.

n_threads(*args, **kwargs)

Set the number of processors to use for DPM.

report(*args, **kwargs)

Print particle workpile statistics.

use_hybrid(*args, **kwargs)

Set DPM parallel-mode to hybrid.

use_message_passing(*args, **kwargs)

Set DPM parallel-mode to message passing.

use_shared_memory(*args, **kwargs)

Set DPM parallel-mode to shared memory.

Classes:

expert(path, service)

Enter the menu to set expert DPM parallel options.
enable_workpile(*args, **kwargs)#

Enable/disable the particle workpile algorithm.

class expert(path, service)#

Bases: TUIMenu

Enter the menu to set expert DPM parallel options.

Methods:

partition_method_hybrid_2domain(*args, **kwargs)

Set DPM Domain partition method.
partition_method_hybrid_2domain(*args, **kwargs)#

Set DPM Domain partition method.

fix_source_term_accumulation_order(*args, **kwargs)#

Enforce deterministic order of source term accumulation.

hybrid_2domain(*args, **kwargs)#

Use DPM domain to simulate particles.

hybrid_collision_model(*args, **kwargs)#

An EXPERIMENTAL feature to allow ‘hybrid’ DPM parallel tracking with the collision / coalescence model.

hybrid_collision_unidirectional(*args, **kwargs)#

A faster, yet potentially somewhat less accurate, modification to the beta feature that allows ‘hybrid’ DPM parallel tracking with the collision / coalescence model.

hybrid_collision_variant(*args, **kwargs)#

Further reduce the residual risk of dead-locks in the experimental feature that allows ‘hybrid’ DPM parallel tracking with the collision / coalescence model.

hybrid_workpile(*args, **kwargs)#

Optimize multi-thread load balancing within each partition in hybrid-parallel DPM tracking.

n_threads(*args, **kwargs)#

Set the number of processors to use for DPM.

report(*args, **kwargs)#

Print particle workpile statistics.

use_hybrid(*args, **kwargs)#

Set DPM parallel-mode to hybrid.

use_message_passing(*args, **kwargs)#

Set DPM parallel-mode to message passing.

use_shared_memory(*args, **kwargs)#

Set DPM parallel-mode to shared memory.

class splash_options(path, service)#

Bases: TUIMenu

Enter the splash options menu to set optional parameters.

Methods:

orourke_splash_fraction(*args, **kwargs)

Select splash fraction method.

splash_pdf_limiting(*args, **kwargs)

Select splash pdf limiting method.
orourke_splash_fraction(*args, **kwargs)#

Select splash fraction method.

splash_pdf_limiting(*args, **kwargs)#

Select splash pdf limiting method.

spray_model(*args, **kwargs)#

Enter the spray model menu.

class stripping_options(path, service)#

Bases: TUIMenu

Enter the stripping options menu to set optional parameters.

Methods:

diameter_coefficient(*args, **kwargs)

Set the stripping diameter coefficient.

mass_coefficient(*args, **kwargs)

Set the stripping mass coefficient.
diameter_coefficient(*args, **kwargs)#

Set the stripping diameter coefficient.

mass_coefficient(*args, **kwargs)#

Set the stripping mass coefficient.

unsteady_tracking(*args, **kwargs)#

Enable/disable unsteady particle tracking.

user_defined(*args, **kwargs)#

Set DPM user-defined functions.