models#

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

Bases: TUIMenu

Enters the models menu to configure the solver.

Methods:

ablation(*args, **kwargs)

Enables/disables the ablation model.

addon_module(*args, **kwargs)

Loads addon module.

axisymmetric(*args, **kwargs)

Specifies whether or not the domain is axisymmetric.

battery_model(*args, **kwargs)

Enables the dual potential MSMD battery model.

crevice_model(*args, **kwargs)

Enables/disables the crevice model.

crevice_model_controls(*args, **kwargs)

Enters the crevice model controls menu.

energy(*args, **kwargs)

Enable/disable the energy model.

frozen_flux(*args, **kwargs)

Enables/disables frozen flux formulation for transient flows.

noniterative_time_advance(*args, **kwargs)

Enables/disables noniterative time advancement scheme.

nox(*args, **kwargs)

Enables/disables the NOx model.

potential_and_li_ion_battery(*args, **kwargs)

Enables/disables the electric-potential model.

solidification_melting(*args, **kwargs)

Enables/disables the solidification and melting model.

soot(*args, **kwargs)

Enables/disables the soot model.

steady(*args, **kwargs)

Enables/disables the steady solution model.

swirl(*args, **kwargs)

Enables/disables axisymmetric swirl velocity.

unsteady_1st_order(*args, **kwargs)

Selects the first-order implicit formulation for transient simulations.

unsteady_2nd_order(*args, **kwargs)

Selects the second-order implicit formulation for transient simulations.

unsteady_2nd_order_bounded(*args, **kwargs)

Selects the bounded second-order implicit formulation for transient simulations.

unsteady_global_time(*args, **kwargs)

Selects the explicit transient formulation.

unsteady_structure_euler(*args, **kwargs)

Selects the backward Euler method for the direct time integration of the finite element semi-discrete equation of motion.

unsteady_structure_newmark(*args, **kwargs)

Selects the Newmark method for the direct time integration of the finite element semi-discrete equation of motion.

vbm(*args, **kwargs)

Enable/disable Virtual Blade Model.

virtual_blade_model(*args, **kwargs)

Enter VBM model menu.

Classes:

acoustics(path, service)

Enters the acoustics menu.

cht(path, service)

Enters the cht (conjugate heat transfer) menu.

dpm(path, service)

Enters the dispersed phase model menu.

electrolysis(path, service)

Enter the electrolysis model setup menu.

eulerian_wallfilm(path, service)

Enters the Eulerian wall film model menu.

heat_exchanger(path, service)

Enters the heat exchanger menu.

multiphase(path, service)

Enters the multiphase model menu.

nox_parameters(path, service)

Enters the NOx parameters menu.

optics(path, service)

Enter the optics model menu.

radiation(path, service)

Enters the radiation models menu.

shell_conduction(path, service)

Enters the shell conduction models menu.

solver(path, service)

Enters the menu to select the solver.

soot_parameters(path, service)

Enters the soot parameters menu.

species(path, service)

Enters the species models menu.

structure(path, service)

Enters the structure model menu.

system_coupling_settings(path, service)

Enters the system coupling menu.

two_temperature(path, service)

Enters the Two-Temperature model menu.

viscous(path, service)

Enters the viscous model menu.
ablation(*args, **kwargs)#

Enables/disables the ablation model.

class acoustics(path, service)#

Bases: TUIMenu

Enters the acoustics menu.

Methods:

acoustic_modal_analysis(*args, **kwargs)

Iterate linear acoustic solver to compute the resonance frequencies and the acoustic modes.

auto_prune(*args, **kwargs)

Enables/disables auto prune of the receiver signal(s) during read-and-compute.

broad_band_noise(*args, **kwargs)

Enables/disables the broadband noise model.

compute_write(*args, **kwargs)

Computes sound pressure.

convective_effects(*args, **kwargs)

Enables/disables the convective effects option.

cylindrical_export(*args, **kwargs)

Enables/disables the export of data in cylindrical coordinates.

display_flow_time(*args, **kwargs)

Enables/disables the display of flow time during read-and-compute.

display_frequencies(*args, **kwargs)

Display resonance frequencies.

export_source_data(*args, **kwargs)

Enables/disables the export of acoustic source data in ASD format during the wave equation model run.

export_source_data_cgns(*args, **kwargs)

Enables/disables the export of acoustic source data in CGNS format.

export_volumetric_sources(*args, **kwargs)

Enables/disables the export of fluid zones.

export_volumetric_sources_cgns(*args, **kwargs)

Enables/disables the export of fluid zones.

ffowcs_williams(*args, **kwargs)

Enables/disables the Ffowcs-Williams-and-Hawkings model.

modal_analysis(*args, **kwargs)

Enable/disable the modal analysis model.

moving_receiver(*args, **kwargs)

Enables/disables the moving receiver option.

off(*args, **kwargs)

Enables/disables the acoustics model.

read_compute_write(*args, **kwargs)

Reads acoustic source data files and computes sound pressure.

receivers(*args, **kwargs)

Sets acoustic receivers.

sources(*args, **kwargs)

Sets acoustic sources.

wave_equation(*args, **kwargs)

Enables/disables the wave equation model.

write_acoustic_signals(*args, **kwargs)

Writes on-the-fly sound pressure.

write_centroid_info(*args, **kwargs)

Writes centroid info.

Classes:

far_field_parameters(path, service)

Enters the menu to specify the far-field density and speed of sound.

sources_fft(path, service)

Enters the acoustic sources fast Fourier transform (FFT) menu, to compute Fourier spectra from acoustic source data (ASD) files, create postprocessing variables for the pressure signals, and write CGNS files of the spectrum data.

sponge_layers(path, service)

Manage sponge layers where density is blended to eliminate reflections from boundary zones.

wave_equation_options(path, service)

Enters the menu to define the acoustics wave equation model options.
acoustic_modal_analysis(*args, **kwargs)#

Iterate linear acoustic solver to compute the resonance frequencies and the acoustic modes.

auto_prune(*args, **kwargs)#

Enables/disables auto prune of the receiver signal(s) during read-and-compute.

broad_band_noise(*args, **kwargs)#

Enables/disables the broadband noise model.

compute_write(*args, **kwargs)#

Computes sound pressure.

convective_effects(*args, **kwargs)#

Enables/disables the convective effects option.

cylindrical_export(*args, **kwargs)#

Enables/disables the export of data in cylindrical coordinates.

display_flow_time(*args, **kwargs)#

Enables/disables the display of flow time during read-and-compute.

display_frequencies(*args, **kwargs)#

Display resonance frequencies.

export_source_data(*args, **kwargs)#

Enables/disables the export of acoustic source data in ASD format during the wave equation model run.

export_source_data_cgns(*args, **kwargs)#

Enables/disables the export of acoustic source data in CGNS format.

export_volumetric_sources(*args, **kwargs)#

Enables/disables the export of fluid zones.

export_volumetric_sources_cgns(*args, **kwargs)#

Enables/disables the export of fluid zones.

class far_field_parameters(path, service)#

Bases: TUIMenu

Enters the menu to specify the far-field density and speed of sound. Note that this menu is currently available only with the acoustics wave equation model.

Methods:

far_field_density(*args, **kwargs)

Specifies the far-field density value for the acoustics wave equation model.

far_field_sound_speed(*args, **kwargs)

Specifies the far-field speed of sound value for the acoustics wave equation model.
far_field_density(*args, **kwargs)#

Specifies the far-field density value for the acoustics wave equation model.

far_field_sound_speed(*args, **kwargs)#

Specifies the far-field speed of sound value for the acoustics wave equation model.

ffowcs_williams(*args, **kwargs)#

Enables/disables the Ffowcs-Williams-and-Hawkings model.

modal_analysis(*args, **kwargs)#

Enable/disable the modal analysis model.

moving_receiver(*args, **kwargs)#

Enables/disables the moving receiver option.

off(*args, **kwargs)#

Enables/disables the acoustics model.

read_compute_write(*args, **kwargs)#

Reads acoustic source data files and computes sound pressure.

receivers(*args, **kwargs)#

Sets acoustic receivers.

sources(*args, **kwargs)#

Sets acoustic sources.

class sources_fft(path, service)#

Bases: TUIMenu

Enters the acoustic sources fast Fourier transform (FFT) menu, to compute Fourier spectra from acoustic source data (ASD) files, create postprocessing variables for the pressure signals, and write CGNS files of the spectrum data.

Methods:

clean_up_storage_area(*args, **kwargs)

De-allocates memory used to store the pressure histories and their Fourier spectra, as well as any created surface variables for the visualization.

compute_fft_fields(*args, **kwargs)

Computes FFT of the read pressure histories.

read_asd_files(*args, **kwargs)

Reads ASD files to perform FFT of the pressure history field.

write_cgns_files(*args, **kwargs)

Writes surface pressure spectra in CGNS format, which can be used for one-way coupling with Ansys Mechanical in the frequency domain.

Classes:

fft_surface_variables(path, service)

Enters the menu to create surface variables from the computed Fourier spectra for visualization.
clean_up_storage_area(*args, **kwargs)#

De-allocates memory used to store the pressure histories and their Fourier spectra, as well as any created surface variables for the visualization.

compute_fft_fields(*args, **kwargs)#

Computes FFT of the read pressure histories. The computed spectra replace the pressure histories in memory.

class fft_surface_variables(path, service)#

Bases: TUIMenu

Enters the menu to create surface variables from the computed Fourier spectra for visualization.

Methods:

create_constant_width_bands(*args, **kwargs)

Selects up to 20 constant width bands and creates either the surface pressures level (SPL) variables or the PSD of dp/dt variables for them.

create_octave_bands(*args, **kwargs)

Creates either the surface pressure level (SPL) variables or the PSD of dp/dt variables for 17 technical octaves.

create_set_of_modes(*args, **kwargs)

Selects up to 20 individual Fourier modes and create variable pairs for them, containing the real and the imaginary parts of the complex Fourier amplitudes.

create_third_bands(*args, **kwargs)

Creates either the surface pressure level (SPL) variables or the PSD of dp/dt variables for 54 technical thirds.

remove_variables(*args, **kwargs)

Removes all variables created in this menu.
create_constant_width_bands(*args, **kwargs)#

Selects up to 20 constant width bands and creates either the surface pressures level (SPL) variables or the PSD of dp/dt variables for them.

create_octave_bands(*args, **kwargs)#

Creates either the surface pressure level (SPL) variables or the PSD of dp/dt variables for 17 technical octaves.

create_set_of_modes(*args, **kwargs)#

Selects up to 20 individual Fourier modes and create variable pairs for them, containing the real and the imaginary parts of the complex Fourier amplitudes.

create_third_bands(*args, **kwargs)#

Creates either the surface pressure level (SPL) variables or the PSD of dp/dt variables for 54 technical thirds.

remove_variables(*args, **kwargs)#

Removes all variables created in this menu.

read_asd_files(*args, **kwargs)#

Reads ASD files to perform FFT of the pressure history field.

write_cgns_files(*args, **kwargs)#

Writes surface pressure spectra in CGNS format, which can be used for one-way coupling with Ansys Mechanical in the frequency domain.

class sponge_layers(path, service)#

Bases: TUIMenu

Manage sponge layers where density is blended to eliminate reflections from boundary zones.

Methods:

activate(*args, **kwargs)

Activate a sponge object.

add(*args, **kwargs)

Add a new sponge layer definition.

deactivate(*args, **kwargs)

Deactivate a sponge layer definition.

delete(*args, **kwargs)

Deletes an existing sponge layer definition.

edit(*args, **kwargs)

Edits an existing sponge layer.

list(*args, **kwargs)

Prints a list of the existing sponge layers in the console.

list_active(*args, **kwargs)

List the names of the active sponge layer definitions.

list_properties(*args, **kwargs)

Prints the properties of an existing sponge layer of your choice in the console.
activate(*args, **kwargs)#

Activate a sponge object.

add(*args, **kwargs)#

Add a new sponge layer definition.

deactivate(*args, **kwargs)#

Deactivate a sponge layer definition.

delete(*args, **kwargs)#

Deletes an existing sponge layer definition.

edit(*args, **kwargs)#

Edits an existing sponge layer. You can revise the fields listed previously for the define/models/acoustics/sponge-layers/add text command.

list(*args, **kwargs)#

Prints a list of the existing sponge layers in the console.

list_active(*args, **kwargs)#

List the names of the active sponge layer definitions.

list_properties(*args, **kwargs)#

Prints the properties of an existing sponge layer of your choice in the console.

wave_equation(*args, **kwargs)#

Enables/disables the wave equation model.

class wave_equation_options(path, service)#

Bases: TUIMenu

Enters the menu to define the acoustics wave equation model options.

Classes:

basic_shapes(path, service)

Enters the menu to define the geometry of the source mask and sponge layer using the basic shapes, represented by the cell registers of the type "Region".

remote_receivers_options(path, service)

Enters the menu to define remote receivers for the Kirchhoff integral model.

Methods:

remote_receivers(*args, **kwargs)

Enables/disables the Kirchhoff integral model.

source_mask_udf(*args, **kwargs)

Specifies the name of a user-defined function, which defines geometry of the source mask.

sponge_layer_base_level(*args, **kwargs)

Specify artificial viscosity base level applied everywhere.

sponge_layer_factor(*args, **kwargs)

Specifies the factor of the artificial viscosity coefficient.

sponge_layer_udf(*args, **kwargs)

Specifies the name of a user-defined function, which defines geometry of the sponge layer.

time_filter_source(*args, **kwargs)

Enables/disables a time filter for the sound source.
class basic_shapes(path, service)#

Bases: TUIMenu

Enters the menu to define the geometry of the source mask and sponge layer using the basic shapes, represented by the cell registers of the type “Region”.

Methods:

add_source_mask_shape(*args, **kwargs)

Adds a basic shape to the definition of the source mask geometry.

add_sponge_layer_shape(*args, **kwargs)

Adds a basic shape to the definition of the sponge layer geometry.

list_region_registers(*args, **kwargs)

List all available cell registers of the type "Region".

list_source_mask_shapes(*args, **kwargs)

List basic shapes, which are currently used in the definition of the source mask geometry.

list_sponge_layer_shapes(*args, **kwargs)

List basic shapes, which are currently used in the definition of the sponge layer geometry.

remove_source_mask_shape(*args, **kwargs)

Remove a basic shape from the definition of the source mask geometry.

remove_sponge_layer_shape(*args, **kwargs)

Remove a basic shape from the definition of the sponge layer geometry.
add_source_mask_shape(*args, **kwargs)#

Adds a basic shape to the definition of the source mask geometry.

add_sponge_layer_shape(*args, **kwargs)#

Adds a basic shape to the definition of the sponge layer geometry.

list_region_registers(*args, **kwargs)#

List all available cell registers of the type “Region”.

list_source_mask_shapes(*args, **kwargs)#

List basic shapes, which are currently used in the definition of the source mask geometry.

list_sponge_layer_shapes(*args, **kwargs)#

List basic shapes, which are currently used in the definition of the sponge layer geometry.

remove_source_mask_shape(*args, **kwargs)#

Remove a basic shape from the definition of the source mask geometry.

remove_sponge_layer_shape(*args, **kwargs)#

Remove a basic shape from the definition of the sponge layer geometry.

remote_receivers(*args, **kwargs)#

Enables/disables the Kirchhoff integral model.

class remote_receivers_options(path, service)#

Bases: TUIMenu

Enters the menu to define remote receivers for the Kirchhoff integral model.

Methods:

integration_surface(*args, **kwargs)

Selects the integration surface for the Kirchhoff model.

write_signals(*args, **kwargs)

Writes the computed receiver signals to the ASCII files.
integration_surface(*args, **kwargs)#

Selects the integration surface for the Kirchhoff model.

write_signals(*args, **kwargs)#

Writes the computed receiver signals to the ASCII files.

source_mask_udf(*args, **kwargs)#

Specifies the name of a user-defined function, which defines geometry of the source mask.

sponge_layer_base_level(*args, **kwargs)#

Specify artificial viscosity base level applied everywhere.

sponge_layer_factor(*args, **kwargs)#

Specifies the factor of the artificial viscosity coefficient.

sponge_layer_udf(*args, **kwargs)#

Specifies the name of a user-defined function, which defines geometry of the sponge layer.

time_filter_source(*args, **kwargs)#

Enables/disables a time filter for the sound source.

write_acoustic_signals(*args, **kwargs)#

Writes on-the-fly sound pressure.

write_centroid_info(*args, **kwargs)#

Writes centroid info.

addon_module(*args, **kwargs)#

Loads addon module.

axisymmetric(*args, **kwargs)#

Specifies whether or not the domain is axisymmetric.

battery_model(*args, **kwargs)#

Enables the dual potential MSMD battery model. For text commands that become available when the battery model is enabled, refer to Battery Model Text Commands.

class cht(path, service)#

Bases: TUIMenu

Enters the cht (conjugate heat transfer) menu.

Classes:

explicit_time_averaged_coupling(path, service)

Enters the explicit time averaged thermal coupling menu.

Methods:

implicit_coupling(*args, **kwargs)

Enables the implicit mapping scheme for any fluid-solid pair with a mapped mesh interface (only required for cases set up in version 19.2 or earlier).

read_mi_type_wall(*args, **kwargs)

Read mapped interface data settings from a csv file.

write_mi_type_wall(*args, **kwargs)

Write mapped interface settings to a scv file.
class explicit_time_averaged_coupling(path, service)#

Bases: TUIMenu

Enters the explicit time averaged thermal coupling menu.

Methods:

conformal_coupled_walls(*args, **kwargs)

Select fluid-solid coupled walls (without shell) for explicit coupling using time averaged thermal variables.

coupling_controls(*args, **kwargs)

Specify explcit coupling controls.

fuse_explicit_cht_zones(*args, **kwargs)

Fuse slitted conformal coupled walls marked for transient explicit thermal coupling.

mapped_interfaces(*args, **kwargs)

Select fluid-solid mapped interfaces for explicit coupling using time averaged thermal variables.
conformal_coupled_walls(*args, **kwargs)#

Select fluid-solid coupled walls (without shell) for explicit coupling using time averaged thermal variables.

coupling_controls(*args, **kwargs)#

Specify explcit coupling controls.

fuse_explicit_cht_zones(*args, **kwargs)#

Fuse slitted conformal coupled walls marked for transient explicit thermal coupling.

mapped_interfaces(*args, **kwargs)#

Select fluid-solid mapped interfaces for explicit coupling using time averaged thermal variables.

implicit_coupling(*args, **kwargs)#

Enables the implicit mapping scheme for any fluid-solid pair with a mapped mesh interface (only required for cases set up in version 19.2 or earlier).

read_mi_type_wall(*args, **kwargs)#

Read mapped interface data settings from a csv file.

write_mi_type_wall(*args, **kwargs)#

Write mapped interface settings to a scv file.

crevice_model(*args, **kwargs)#

Enables/disables the crevice model.

crevice_model_controls(*args, **kwargs)#

Enters the crevice model controls menu.

class dpm(path, service)#

Bases: TUIMenu

Enters the dispersed phase model menu.

Methods:

clear_particles_from_domain(*args, **kwargs)

Removes/keeps all particles currently in the domain.

fill_injection_material_sources(*args, **kwargs)

Initialize the DPM sources corresponding to each material.

injections(*args, **kwargs)

Enters the injections menu.

spray_model(*args, **kwargs)

Enters the spray model menu.

unsteady_tracking(*args, **kwargs)

Enables/disables unsteady particle tracking.

user_defined(*args, **kwargs)

Sets DPM user-defined functions.

Classes:

collisions(path, service)

Enters the DEM collisions menu.

erosion_dynamic_mesh(path, service)

Enters the menu to enable/configure/run the erosion-dynamic mesh interaction.

interaction(path, service)

Sets parameters for coupled discrete phase calculations.

numerics(path, service)

Enters the numerics menu to set numerical solution parameters.

options(path, service)

Enters the options menu to set optional models.

parallel(path, service)

Enters the parallel menu to set parameters for parallel DPM calculations.

splash_options(path, service)

Enters the splash option menu.

stripping_options(path, service)

Enters the stripping options menu.
clear_particles_from_domain(*args, **kwargs)#

Removes/keeps all particles currently in the domain.

class collisions(path, service)#

Bases: TUIMenu

Enters the DEM collisions menu.

Methods:

collision_mesh(*args, **kwargs)

Input for the collision mesh.

collision_pair_settings(*args, **kwargs)

Supplies settings for collisions to a pair of collision partners.

dem_collisions(*args, **kwargs)

Enables/disables 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)

Sets the maximum particle velocity that may arise from collisions.

Classes:

collision_partners(path, service)

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

Input for the collision mesh.

collision_pair_settings(*args, **kwargs)#

Supplies settings for collisions to a pair of collision partners. You will be prompted to specify theImpact collision partner and the Target collision partner.

class collision_partners(path, service)#

Bases: TUIMenu

Manages collision partners.

Methods:

copy(*args, **kwargs)

Copies a collision partner.

create(*args, **kwargs)

Creates a collision partner.

delete(*args, **kwargs)

Deletes a collision partner.

list(*args, **kwargs)

Lists all known collision partners.

rename(*args, **kwargs)

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

Copies a collision partner.

create(*args, **kwargs)#

Creates a collision partner.

delete(*args, **kwargs)#

Deletes a collision partner.

list(*args, **kwargs)#

Lists all known collision partners.

rename(*args, **kwargs)#

Renames a collision partner.

dem_collisions(*args, **kwargs)#

Enables/disables 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)#

Sets the maximum particle velocity that may arise from collisions.

class erosion_dynamic_mesh(path, service)#

Bases: TUIMenu

Enters the menu to enable/configure/run the erosion-dynamic mesh interaction.

Methods:

enable_erosion_dynamic_mesh_coupling(*args, ...)

Enables mesh deformation due to wall erosion.

run_simulation(*args, **kwargs)

Performs a coupled erosion-dynamic mesh simulation.

Classes:

general_parameters(path, service)

Enters the menu for setting erosion coupling with dynamic mesh.

run_parameters(path, service)

Manages erosion-dynamic mesh run settings.
enable_erosion_dynamic_mesh_coupling(*args, **kwargs)#

Enables mesh deformation due to wall erosion.

class general_parameters(path, service)#

Bases: TUIMenu

Enters the menu for setting erosion coupling with dynamic mesh.

Methods:

dynamic_mesh_settings(*args, **kwargs)

Sets parameters for dynamic mesh calculations.

erosion_settings(*args, **kwargs)

Sets parameters for erosion calculations.

participating_walls(*args, **kwargs)

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

Sets parameters for dynamic mesh calculations.

erosion_settings(*args, **kwargs)#

Sets parameters for erosion calculations.

participating_walls(*args, **kwargs)#

Specifies all participating walls.

class run_parameters(path, service)#

Bases: TUIMenu

Manages erosion-dynamic mesh run settings.

Methods:

autosave_files(*args, **kwargs)

Sets the iteration increment and filename to save data files.

autosave_graphics(*args, **kwargs)

Sets the iteration increment to save graphics files.

flow_simulation_control(*args, **kwargs)

Sets the number of iterations per flow simulation step.

mesh_motion_time_step(*args, **kwargs)

Sets the mesh motion time stepping parameters and method.

simulation_termination(*args, **kwargs)

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

Sets the iteration increment and filename to save data files.

autosave_graphics(*args, **kwargs)#

Sets the iteration increment to save graphics files.

flow_simulation_control(*args, **kwargs)#

Sets the number of iterations per flow simulation step.

mesh_motion_time_step(*args, **kwargs)#

Sets the mesh motion time stepping parameters and method.

simulation_termination(*args, **kwargs)#

Sets the total time of erosion.

run_simulation(*args, **kwargs)#

Performs a coupled erosion-dynamic mesh simulation.

fill_injection_material_sources(*args, **kwargs)#

Initialize the DPM sources corresponding to each material.

injections(*args, **kwargs)#

Enters the injections menu.

class interaction(path, service)#

Bases: TUIMenu

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

Selects whether or not to couple 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)

Sets the frequency with which the particle trajectory calculations are introduced.

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)

Enables/disables implicit treatment for the DPM momentum source terms.

implicit_source_term_coupling(*args, **kwargs)

Enables/disables 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)

Enables/disables the linear ramping up of the DPM source terms at every DPM iteration.

linearized_dpm_mixture_fraction_source_terms(...)

Enables/disables linearization of mixture fraction source terms.

linearized_dpm_source_terms(*args, **kwargs)

Enables/disables linearization of source terms for the discrete phase.

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

When enabled, recalculates the mixture fraction source terms as a function of the primary mixture fraction.

reset_sources_at_timestep(*args, **kwargs)

Enables/disables flush of DPM source terms at beginning of every time step.

underrelaxation_factor(*args, **kwargs)

Sets the under-relaxation factor for the discrete phase sources.

update_dpm_sources_every_flow_iteration(...)

Enables/disables the update of DPM source terms every flow iteration (if this option is not enabled, the terms will be updated every DPM 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)#

Selects whether or not to couple 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)#

Sets the frequency with which the particle trajectory calculations are introduced.

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

Enables/disables implicit treatment for the DPM momentum source terms.

implicit_source_term_coupling(*args, **kwargs)#

Enables/disables 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)#

Enables/disables the linear ramping up of the DPM source terms at every DPM iteration.

linearized_dpm_mixture_fraction_source_terms(*args, **kwargs)#

Enables/disables linearization of mixture fraction source terms. This command is available only for non- or partially-premixed combustion cases.

linearized_dpm_source_terms(*args, **kwargs)#

Enables/disables linearization of source terms for the discrete phase.

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

When enabled, recalculates the mixture fraction source terms as a function of the primary mixture fraction. This command is available for non- or partially-premixed combustion cases only.

reset_sources_at_timestep(*args, **kwargs)#

Enables/disables flush of DPM source terms at beginning of every time step.

underrelaxation_factor(*args, **kwargs)#

Sets the under-relaxation factor for the discrete phase sources.

update_dpm_sources_every_flow_iteration(*args, **kwargs)#

Enables/disables the update of DPM source terms every flow iteration (if this option is not enabled, the terms will be updated every DPM iteration).

class numerics(path, service)#

Bases: TUIMenu

Enters the numerics menu to set numerical solution parameters.

Methods:

automated_scheme_selection(*args, **kwargs)

Enables/disables the adaptation of integration step length based on a maximum error.

average_DDPM_variables(*args, **kwargs)

Enables/disables mesh node averaging of DDPM quantities.

average_each_step(*args, **kwargs)

Enables/disables mesh node averaging during integration time step.

average_kernel(*args, **kwargs)

Specifies the averaging kernel to use for mesh node averaging.

average_source_terms(*args, **kwargs)

Enables/disables mesh node averaging of DPM source terms.

coupled_heat_mass_update(*args, **kwargs)

Enables/disables coupled heat and mass update.

drag_law(*args, **kwargs)

Sets the drag law.

dynamic_interaction(*args, **kwargs)

Enable/disable dynamic interaction range.

enable_node_based_averaging(*args, **kwargs)

Enables/disables mesh node averaging of DPM quantities.

enhanced_packing_limit_numerics(*args, **kwargs)

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

error_control(*args, **kwargs)

Adapts integration step length based on a maximum error.

gaussian_factor(*args, **kwargs)

Specifies the Gaussian constant when using thegaussian kernel for mesh node averaging.

granular_stress_tensor(*args, **kwargs)

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

minimum_liquid_fraction(*args, **kwargs)

A droplet evaporates completely when the remaining mass is below this fraction of the initial droplet 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)

Sets parameters for the (initial) tracking step length.

tracking_scheme(*args, **kwargs)

Specifies a tracking scheme.

tracking_statistics(*args, **kwargs)

Controls the format of the one-line tracking statistics to be printed after every DPM tracking pass.

underrelax_film_height(*args, **kwargs)

Sets the under-relaxation factor for the film height calculation.

vaporization_limiting_factors(*args, **kwargs)

Sets the Vaporization Fractional Change Limits.

verbosity(*args, **kwargs)

Adjust the DPM tracker's verbosity level.

Classes:

high_resolution_tracking(path, service)

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

Enables/disables the adaptation of integration step length based on a maximum error.

average_DDPM_variables(*args, **kwargs)#

Enables/disables mesh node averaging of DDPM quantities.

average_each_step(*args, **kwargs)#

Enables/disables mesh node averaging during integration time step.

average_kernel(*args, **kwargs)#

Specifies the averaging kernel to use for mesh node averaging.

average_source_terms(*args, **kwargs)#

Enables/disables mesh node averaging of DPM source terms.

coupled_heat_mass_update(*args, **kwargs)#

Enables/disables coupled heat and mass update.

drag_law(*args, **kwargs)#

Sets the drag law.

dynamic_interaction(*args, **kwargs)#

Enable/disable dynamic interaction range.

enable_node_based_averaging(*args, **kwargs)#

Enables/disables mesh node averaging of DPM quantities.

enhanced_packing_limit_numerics(*args, **kwargs)#

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

error_control(*args, **kwargs)#

Adapts integration step length based on a maximum error.

gaussian_factor(*args, **kwargs)#

Specifies the Gaussian constant when using thegaussian kernel for mesh node averaging.

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

Enters the high resolution tracking menu. See for more information about these options.

Methods:

always_use_face_centroid_with_periodics(...)

When enabled, ANSYS Fluent uses quad face centroids when creating subtets in cases with periodic boundaries.

boundary_layer_tracking(*args, **kwargs)

Enables/disables the calculation of the particle time step that considers both the cell aspect ratio and the particle trajectory.

check_subtet_validity(*args, **kwargs)

When enabled, checks the validity of a subtet when the particle first enters it.

enable_automatic_intersection_tolerance(...)

Enables/disables the automatic calculation of intersection tolerance.

enable_barycentric_intersections(*args, **kwargs)

Enables/disables an alternative method of calculating intersections with cell boundaries.

enable_high_resolution_tracking(*args, **kwargs)

Enables/disables high resolution tracking.

project_wall_film_particles_to_film(*args, ...)

Enables/disables projecting existing particles to Lagrangian wall 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, ...)

Specifies the tolerance used in intersection calculations.

sliding_interface_crossover_fraction(*args, ...)

Specifies the fraction of the distance to the subtet center to move the particle.

use_barycentric_sampling(*args, **kwargs)

When enabled, this option provides improved accuracy and parallel consistency when sampling particles at planes.

use_particle_timestep_for_intersection_tolerance(...)

Enables/disables the use of the particle timestep for the subtet intersection tolerance with axisymmetric grids (default: enabled).

use_quad_face_centroid(*args, **kwargs)

Enables/disables using quad face centroids when creating subtets.

use_velocity_based_error_control(*args, **kwargs)

Enables/disables an alternative method of timestep adaption.

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

When enabled, ANSYS Fluent uses quad face centroids when creating subtets in cases with 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)

Enables/disables the barycentric interpolation of specific heat to the particle position.

interpolate_flow_density(*args, **kwargs)

Enables/disables the barycentric interpolation of the flow density.

interpolate_flow_solution_gradients(*args, ...)

When enabled, flow solution gradients are interpolated to the particle position.

interpolate_flow_viscosity(*args, **kwargs)

Enables/disables the barycentric interpolation of flow viscosity to the particle position.

interpolate_temperature(*args, **kwargs)

Enables/disables the barycentric interpolation of temperature to the particle position.

interpolate_wallfilm_properties(*args, **kwargs)

When enabled, the wall film properties (film height, film mass, and wall shear) are interpolated to the particle position.

nodal_reconstruction_frequency(*args, **kwargs)

Update nodal reconstruction every N'th DPM iteration.

precompute_pdf_species(*args, **kwargs)

When this option is enabled for premixed or non-premixed combustion simulations, the species composition in each cell is precomputed prior to tracking particles.

user_interpolation_function(*args, **kwargs)

Enter user interpolation function.

zero_nodal_velocity_on_walls(*args, **kwargs)

When enabled, sets the velocity at wall nodes to zero.
enable_transient_variable_interpolation(*args, **kwargs)#

Enable transient variable interpolation.

interpolate_flow_cp(*args, **kwargs)#

Enables/disables the barycentric interpolation of specific heat to the particle position. This option is recommended when the specific heat varies with position to avoid discontinuities in the interpolated variable at cell boundaries. For flows with constant specific heat, this option is unnecessary.

interpolate_flow_density(*args, **kwargs)#

Enables/disables the barycentric interpolation of the flow density. This option is recommended when the density varies with position to avoid discontinuities in the interpolated variable at cell boundaries. For constant density flows, this option is unnecessary.

interpolate_flow_solution_gradients(*args, **kwargs)#

When enabled, flow solution gradients are interpolated to the particle position. This can be useful when using physical models that depend on these gradients (for example, the thermophoretic force, pressure-gradient force, or virtual mass force). Interpolating the gradients also improves the accuracy and robustness of the trapezoidal numerics scheme, which is the default method for pathlines.

interpolate_flow_viscosity(*args, **kwargs)#

Enables/disables the barycentric interpolation of flow viscosity to the particle position. This option is recommended when the flow viscosity varies with position to avoid discontinuities in the interpolated variable at cell boundaries. For flows with constant viscosity, this option is unnecessary.

interpolate_temperature(*args, **kwargs)#

Enables/disables the barycentric interpolation of temperature to the particle position. The cell temperature is used by default in calculations of heat transfer to/from the particle.

interpolate_wallfilm_properties(*args, **kwargs)#

When enabled, the wall film properties (film height, film mass, and wall shear) are interpolated to the particle position.

nodal_reconstruction_frequency(*args, **kwargs)#

Update nodal reconstruction every N’th DPM iteration.

precompute_pdf_species(*args, **kwargs)#

When this option is enabled for premixed or non-premixed combustion simulations, the species composition in each cell is precomputed prior to tracking particles. This approach may improve performance for cases with many particles and relatively few cells. By default, this option is set to no, and ANSYS Fluent calculates the species composition during particle tracking. The solution results will be identical for both methods.

user_interpolation_function(*args, **kwargs)#

Enter user interpolation function.

zero_nodal_velocity_on_walls(*args, **kwargs)#

When enabled, sets the velocity at wall nodes to zero. (By default, the nodal velocities on walls are first reconstructed from cell and face values and then corrected to ensure that there are no velocity components directed towards the walls). This may be useful if you want to consider particle impingement on the walls. Note that enabling this option will more likely produce incomplete particles as some particles may settle on the walls.

boundary_layer_tracking(*args, **kwargs)#

Enables/disables the calculation of the particle time step that considers both the cell aspect ratio and the particle trajectory. This method improves the accuracy of the predictions in boundary layer cells, particularly in layers where flow gradients are large.

check_subtet_validity(*args, **kwargs)#

When enabled, checks the validity of a subtet when the particle first enters it. If the subtet is found to be degenerate, the tracking algorithm modifies to accommodate it.

enable_automatic_intersection_tolerance(*args, **kwargs)#

Enables/disables the automatic calculation of intersection tolerance. By default, the tolerance used in intersection calculations is scaled by the residence time of the particle in the cell to improve robustness. For most cases, the scaled tolerance is sufficient to identify all intersections of the particle trajectory and the subtet faces. You can set the intersection tolerance manually using the set-subtet-intersection-tolerance text command.

enable_barycentric_intersections(*args, **kwargs)#

Enables/disables an alternative method of calculating intersections with cell boundaries. Barycentric intersections are linear calculations and are faster than the default intersection algorithm. The default intersection algorithm is second-order for stationary meshes; therefore, using the barycentric intersection may sacrifice accuracy. You must verify that the barycentric intersections provide comparable results to the default intersection method. This option is available only for 3D stationary meshes and the double precision solver.

enable_high_resolution_tracking(*args, **kwargs)#

Enables/disables 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)#

Enables/disables projecting existing particles to Lagrangian wall film to track using high-resolution tracking. When reading in a data file that contains wall film particles previously tracked with the existing ANSYS Fluent tracking method, you need to either clear the particles from the domain or project their positions to the wall film surface using the project-wall-film-particles-to-film? text command prior to using the high-resolution tracking method. After tracking the particles for one timestep, this option can be disabled to improve performance.

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

Specifies the tolerance used in intersection calculations. This tolerance will be scaled by the characteristic cell crossing time of the particle if the enable-automatic-intersection-tolerance? text command is enabled. If that option is disabled, the specified tolerance will be used without scaling. The default intersection tolerance is 10-5.

sliding_interface_crossover_fraction(*args, **kwargs)#

Specifies the fraction of the distance to the subtet center to move the particle. At non-conformal interfaces, the nodes used for the barycentric interpolation are different on either side of the interface. This may result in incomplete particles due to discontinuities in the variable interpolation. The number of incomplete particles may be reduced by moving the particles slightly off of the sliding interface. Recommended values range between 0 and 0.5.

use_barycentric_sampling(*args, **kwargs)#

When enabled, this option provides improved accuracy and parallel consistency when sampling particles at planes. This item is available only with the 3D solver. Using the double-precision solver and bounded planes is recommended.

use_particle_timestep_for_intersection_tolerance(*args, **kwargs)#

Enables/disables the use of the particle timestep for the subtet intersection tolerance with axisymmetric grids (default: enabled). If disabled, the tolerance will be calculated in the same manner as non-axisymmetric meshes (a scaled value of the tolerance which is set using the define/models/dpm/numerics/high-resolution-tracking/set-subtet-intersection-tolerance text command).

use_quad_face_centroid(*args, **kwargs)#

Enables/disables using quad face centroids when creating subtets. This option changes the way hexahedral cells are decomposed to avoid creating degenerate subtets.

use_velocity_based_error_control(*args, **kwargs)#

Enables/disables an alternative method of timestep adaption. By default, ANSYS Fluent uses the half-step method of timestep adaption with particle integration. This alternative method of controlling the integration timestep based upon velocity changes is faster; however, you need to ensure that the accuracy is comparable for your specific application.

minimum_liquid_fraction(*args, **kwargs)#

A droplet evaporates completely when the remaining mass is below this fraction of the initial droplet 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)#

Sets parameters for the (initial) tracking step length.

tracking_scheme(*args, **kwargs)#

Specifies a tracking scheme.

tracking_statistics(*args, **kwargs)#

Controls the format of the one-line tracking statistics to be printed after every DPM tracking pass. A value of 0 (the default) prints only fates with non-zero values. A value of 1 prints all fates, including fates with zero values.

underrelax_film_height(*args, **kwargs)#

Sets the under-relaxation factor for the film height calculation. The recommended values range between 0.5 (default) and 0.9.

vaporization_limiting_factors(*args, **kwargs)#

Sets the Vaporization Fractional Change Limits.

verbosity(*args, **kwargs)#

Adjust the DPM tracker’s verbosity level.

class options(path, service)#

Bases: TUIMenu

Enters the options menu to set optional models.

Methods:

allow_supercritical_pressure_vaporization(...)

Enforces the switching from vaporization to boiling even if the boiling point is not calculated from the vapor pressure data.

brownian_motion(*args, **kwargs)

Enables/disables 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(...)

When enabled, generates a file containing particle current positions (step-by-step history report for unsteady tracking) in the sampling file format.

enable_contour_plots(*args, **kwargs)

Enables computation of mean and/or RMS values of additional discrete phase variables for postprocessing.

ensemble_average(*args, **kwargs)

Ensembles average cloud properties.

erosion_accretion(*args, **kwargs)

Enables/disables erosion/accretion.

include_lwf_particles_in_dpm_concentration(...)

Include LWF particle mass in DPM Concentration.

init_erosion_accretion_rate(*args, **kwargs)

Initializes the erosion/accretion rates with zero.

lowest_volatiles_mass_fraction(*args, **kwargs)

Set the lowest volatiles mass fraction.

maximum_udf_species(*args, **kwargs)

Specifies the maximum number of species that will be accessible from discrete phase model UDFs.

particle_radiation(*args, **kwargs)

Enables/disables particle radiation.

pressure_gradient_force(*args, **kwargs)

Enables/disables inclusion of pressure gradient effects in the particle force balance.

remove_wall_film_temperature_limiter(*args, ...)

Answering yes at the prompt removes the wall temperature limiter for Lagrangian wall-film walls.

saffman_lift_force(*args, **kwargs)

Enables/disables Saffman lift force.

scr_urea_deposition_risk_analysis(*args, ...)

Enters the menu for setting up the risk for solids deposit formation for the Selective Catalytic Reduction (SCR) process.

set_minimum_particle_diameter(*args, **kwargs)

Set the minimum particle diameter.

set_thermolysis_limit(*args, **kwargs)

Sets the limit for the thermolysis model.

stagger_radius(*args, **kwargs)

Specifies the region over which to spatially stagger particles when particle-staggering is enabled for non-atomizer injections.

stagger_spatially_atomizer_injections(*args, ...)

Enables/disables spatial staggering for atomizer and solid-cone injections.

stagger_spatially_standard_injections(*args, ...)

Enables/disables spatial staggering for standard (non-atomizer and non-solid-cone) injections.

stagger_temporally(*args, **kwargs)

Enables/disables temporal staggering.

staggering_factor(*args, **kwargs)

step_report_sig_figures(*args, **kwargs)

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

thermophoretic_force(*args, **kwargs)

Enables/disables thermophoretic force.

track_in_absolute_frame(*args, **kwargs)

Enables/disables tracking in absolute frame.

treat_multicomponent_saturation_temperature_failure(...)

Enables/disables dumping multicomponent particle mass into the continuous phase if the saturation temperature calculation fails.

two_way_coupling(*args, **kwargs)

Enables/disables calculation of DPM sources in TKE equation.

uniform_mass_distribution_for_injections(...)

Specifies a uniform distribution of mass over the cross-section of solid cone and atomizer injections.

use_absolute_pressure_for_vaporization(...)

Determines whether the absolute pressure or constant operating pressure (specified in define/operating-conditions/operating-pressure) will be used in vaporization rates calculations.

vaporization_heat_transfer_averaging(*args, ...)

Enables averaging of the Spalding heat transfer term for the convection/diffusion-controlled model.

vaporization_options(*args, **kwargs)

Sets Vaporization options.

virtual_mass_force(*args, **kwargs)

Enables/disables inclusion of the virtual mass force in the particle force balance.
allow_supercritical_pressure_vaporization(*args, **kwargs)#

Enforces the switching from vaporization to boiling even if the boiling point is not calculated from the vapor pressure data. If the pressure in your model is above critical you must retain the default setting (yes). This options is available only if whenPressure Dependent Boiling is enabled in the Physical Models tab of the Discrete Phase Models dialog box. For more details, see .

brownian_motion(*args, **kwargs)#

Enables/disables 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)#

When enabled, generates a file containing particle current positions (step-by-step history report for unsteady tracking) in the sampling file format.

enable_contour_plots(*args, **kwargs)#

Enables computation of mean and/or RMS values of additional discrete phase variables for postprocessing.

ensemble_average(*args, **kwargs)#

Ensembles average cloud properties.

erosion_accretion(*args, **kwargs)#

Enables/disables erosion/accretion.

include_lwf_particles_in_dpm_concentration(*args, **kwargs)#

Include LWF particle mass in DPM Concentration.

init_erosion_accretion_rate(*args, **kwargs)#

Initializes the erosion/accretion rates with zero.

lowest_volatiles_mass_fraction(*args, **kwargs)#

Set the lowest volatiles mass fraction.

maximum_udf_species(*args, **kwargs)#

Specifies the maximum number of species that will be accessible from discrete phase model UDFs. Only species with indices up to this value are accessible in discrete phase model UDFs.

particle_radiation(*args, **kwargs)#

Enables/disables particle radiation.

pressure_gradient_force(*args, **kwargs)#

Enables/disables inclusion of pressure gradient effects in the particle force balance.

remove_wall_film_temperature_limiter(*args, **kwargs)#

Answering yes at the prompt removes the wall temperature limiter for Lagrangian wall-film walls. If you enter no (default), two additional prompts will appear in the console allowing you to define the temperature difference above the boiling point and to enable/disable the reporting of the Leidenfrost temperature on the wall faces.

saffman_lift_force(*args, **kwargs)#

Enables/disables Saffman lift force.

scr_urea_deposition_risk_analysis(*args, **kwargs)#

Enters the menu for setting up the risk for solids deposit formation for the Selective Catalytic Reduction (SCR) process. For more information, see .

set_minimum_particle_diameter(*args, **kwargs)#

Set the minimum particle diameter.

set_thermolysis_limit(*args, **kwargs)#

Sets the limit for the thermolysis model.

stagger_radius(*args, **kwargs)#

Specifies the region over which to spatially stagger particles when particle-staggering is enabled for non-atomizer injections.

stagger_spatially_atomizer_injections(*args, **kwargs)#

Enables/disables spatial staggering for atomizer and solid-cone injections.

stagger_spatially_standard_injections(*args, **kwargs)#

Enables/disables spatial staggering for standard (non-atomizer and non-solid-cone) injections.

stagger_temporally(*args, **kwargs)#

Enables/disables temporal staggering.

staggering_factor(*args, **kwargs)#
step_report_sig_figures(*args, **kwargs)#

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

thermophoretic_force(*args, **kwargs)#

Enables/disables thermophoretic force.

track_in_absolute_frame(*args, **kwargs)#

Enables/disables tracking in absolute frame.

treat_multicomponent_saturation_temperature_failure(*args, **kwargs)#

Enables/disables dumping multicomponent particle mass into the continuous phase if the saturation temperature calculation fails.

two_way_coupling(*args, **kwargs)#

Enables/disables calculation of DPM sources in TKE equation.

uniform_mass_distribution_for_injections(*args, **kwargs)#

Specifies a uniform distribution of mass over the cross-section of solid cone and atomizer injections. This can become important when the mesh is smaller than the diameter (or another characteristic size) of the injection.

use_absolute_pressure_for_vaporization(*args, **kwargs)#

Determines whether the absolute pressure or constant operating pressure (specified in define/operating-conditions/operating-pressure) will be used in vaporization rates calculations.

vaporization_heat_transfer_averaging(*args, **kwargs)#

Enables averaging of the Spalding heat transfer term for the convection/diffusion-controlled model.

vaporization_options(*args, **kwargs)#

Sets Vaporization options.

virtual_mass_force(*args, **kwargs)#

Enables/disables inclusion of the virtual mass force in the particle force balance.

class parallel(path, service)#

Bases: TUIMenu

Enters the parallel menu to set parameters for parallel DPM calculations.

Methods:

enable_workpile(*args, **kwargs)

Turns on/off particle workpile algorithm.

fix_source_term_accumulation_order(*args, ...)

Enforce deterministic order of source term accumulation.

hybrid_2domain(*args, **kwargs)

Enables/disables the use of a second domain for DPM particle tracking.

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)

Sets the number of processors to use for DPM.

report(*args, **kwargs)

Prints particle workpile statistics.

use_hybrid(*args, **kwargs)

Specifies that the calculations are performed using multicore cluster computing or shared-memory machines.

use_message_passing(*args, **kwargs)

Specifies that the calculations are performed using cluster computing or shared-memory machines.

use_shared_memory(*args, **kwargs)

Specifies that the calculations are performed on shared-memory multiprocessor machines.

Classes:

expert(path, service)

Enters the menu for expert DPM parallel text commands.
enable_workpile(*args, **kwargs)#

Turns on/off particle workpile algorithm. This option is only available when the define/models/dpm/parallel/use-shared-memory option is selected.

class expert(path, service)#

Bases: TUIMenu

Enters the menu for expert DPM parallel text commands.

Methods:

partition_method_hybrid_2domain(*args, **kwargs)

Enables/disables a partitioning method that is more granular and can yield faster calculations (especially for cases that are running on a low to moderate number of processors).
partition_method_hybrid_2domain(*args, **kwargs)#

Enables/disables a partitioning method that is more granular and can yield faster calculations (especially for cases that are running on a low to moderate number of processors). This partitioning method is only applied when you use the DPM domain for the hybrid parallel DPM tracking mode (that is, when you have enabled the define/models/dpm/parallel/hybrid-2domain? text command).

fix_source_term_accumulation_order(*args, **kwargs)#

Enforce deterministic order of source term accumulation.

hybrid_2domain(*args, **kwargs)#

Enables/disables the use of a second domain for DPM particle tracking.

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

Sets the number of processors to use for DPM. This option is only available when the define/models/dpm/parallel/enable-workpile? option is enabled.

report(*args, **kwargs)#

Prints particle workpile statistics. This option is only available when the define/models/dpm/parallel/enable-workpile? option is enabled.

use_hybrid(*args, **kwargs)#

Specifies that the calculations are performed using multicore cluster computing or shared-memory machines. This option works in conjunction withopenmpi for a dynamic load balancing without migration of cells.

use_message_passing(*args, **kwargs)#

Specifies that the calculations are performed using cluster computing or shared-memory machines. With this option, the compute node processes themselves perform the particle work on their local partitions and particle migration to other compute nodes is implemented using message passing primitives.

use_shared_memory(*args, **kwargs)#

Specifies that the calculations are performed on shared-memory multiprocessor machines.

class splash_options(path, service)#

Bases: TUIMenu

Enters the splash option menu.

Methods:

orourke_splash_fraction(*args, **kwargs)

Enables/disables the O’Rourke formulation (default for the Lagrangian Wall Film (LWF) model).

splash_pdf_limiting(*args, **kwargs)

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

Enables/disables the O’Rourke formulation (default for the Lagrangian Wall Film (LWF) model). If the O’Rourke formulation is disabled, the Stanton formulation (default for the Eulerian Wall Film (EWF) model) is used in a simulation.

splash_pdf_limiting(*args, **kwargs)#

Sets the splash pdf limiting method. Available methods are: the splash pdf tail limiting (default for the LWF model) and the splash pdf peak limiting (default for the EWF model). For the splash pdf peak limiting, you will be prompted to specify the peak limiting value.

spray_model(*args, **kwargs)#

Enters the spray model menu. This command is available only if the breakup model enabled globally.

class stripping_options(path, service)#

Bases: TUIMenu

Enters the stripping options menu.

Methods:

diameter_coefficient(*args, **kwargs)

Sets the diameter coefficient ( in in the Theory Guide).

mass_coefficient(*args, **kwargs)

Sets the mass coefficient ( in in the Theory Guide).
diameter_coefficient(*args, **kwargs)#

Sets the diameter coefficient ( in in the Theory Guide).

mass_coefficient(*args, **kwargs)#

Sets the mass coefficient ( in in the Theory Guide).

unsteady_tracking(*args, **kwargs)#

Enables/disables unsteady particle tracking.

user_defined(*args, **kwargs)#

Sets DPM user-defined functions.

class electrolysis(path, service)#

Bases: TUIMenu

Enter the electrolysis model setup menu.

Classes:

anode_setup(path, service)

Enter the menu for the anode controls.

cathode_setup(path, service)

Enter the menu for the cathode controls.

membrane_setup(path, service)

Specify parameters for electrolyte.

Methods:

electrical_tabs_setup(*args, **kwargs)

Specify settings for the electrical tabs.

model_options(*args, **kwargs)

Specify electrolysis model options.

parameters(*args, **kwargs)

Specify electrolysis model parameters.
class anode_setup(path, service)#

Bases: TUIMenu

Enter the menu for the anode controls.

Methods:

catalyst_layer(*args, **kwargs)

Set parameters for the catalyst layer.

current_collector(*args, **kwargs)

Set parameters for the current collector.

electrolyte(*args, **kwargs)

Set parameters for the electrolyte.

flow_channel(*args, **kwargs)

Set parameters for the flow channel.

porous_layer(*args, **kwargs)

Set parameters for the porous layer.
catalyst_layer(*args, **kwargs)#

Set parameters for the catalyst layer.

current_collector(*args, **kwargs)#

Set parameters for the current collector.

electrolyte(*args, **kwargs)#

Set parameters for the electrolyte.

flow_channel(*args, **kwargs)#

Set parameters for the flow channel.

porous_layer(*args, **kwargs)#

Set parameters for the porous layer.

class cathode_setup(path, service)#

Bases: TUIMenu

Enter the menu for the cathode controls.

Methods:

catalyst_layer(*args, **kwargs)

Set parameters for the catalyst layer.

current_collector(*args, **kwargs)

Set parameters for the current collector.

electrolyte(*args, **kwargs)

Set parameters for the electrolyte.

flow_channel(*args, **kwargs)

Set parameters for the flow channel.

porous_layer(*args, **kwargs)

Set parameters for the porous layer.
catalyst_layer(*args, **kwargs)#

Set parameters for the catalyst layer.

current_collector(*args, **kwargs)#

Set parameters for the current collector.

electrolyte(*args, **kwargs)#

Set parameters for the electrolyte.

flow_channel(*args, **kwargs)#

Set parameters for the flow channel.

porous_layer(*args, **kwargs)#

Set parameters for the porous layer.

electrical_tabs_setup(*args, **kwargs)#

Specify settings for the electrical tabs.

class membrane_setup(path, service)#

Bases: TUIMenu

Specify parameters for electrolyte.

Methods:

catalyst_layer(*args, **kwargs)

Set parameters for the catalyst layer.

current_collector(*args, **kwargs)

Set parameters for the current collector.

electrolyte(*args, **kwargs)

Set parameters for the electrolyte.

flow_channel(*args, **kwargs)

Set parameters for the flow channel.

porous_layer(*args, **kwargs)

Set parameters for the porous layer.
catalyst_layer(*args, **kwargs)#

Set parameters for the catalyst layer.

current_collector(*args, **kwargs)#

Set parameters for the current collector.

electrolyte(*args, **kwargs)#

Set parameters for the electrolyte.

flow_channel(*args, **kwargs)#

Set parameters for the flow channel.

porous_layer(*args, **kwargs)#

Set parameters for the porous layer.

model_options(*args, **kwargs)#

Specify electrolysis model options.

parameters(*args, **kwargs)#

Specify electrolysis model parameters.

energy(*args, **kwargs)#

Enable/disable the energy model.

class eulerian_wallfilm(path, service)#

Bases: TUIMenu

Enters the Eulerian wall film model menu.

Classes:

coupled_solution(path, service)

Enters the Coupled-Solution menu.

implicit_options(path, service)

Enter Implicit Scheme Option (beta).

Methods:

enable_film_vof_transition_message(*args, ...)

Enable film-VOF transition message.

enable_wallfilm_model(*args, **kwargs)

Enables/disables Eulerian Wall Film Model.

film_material(*args, **kwargs)

Sets Film Material and Properties.

initialize_wallfilm_model(*args, **kwargs)

Initializes Eulerian Wall Film Model.

list_film_walls(*args, **kwargs)

List film walls.

model_options(*args, **kwargs)

Set Eulerian wall film model options.

solution_options(*args, **kwargs)

Sets Eulerian Wall Film Model Solution Options.

solve_wallfilm_equation(*args, **kwargs)

Activates Eulerian Wall Film Equations.
class coupled_solution(path, service)#

Bases: TUIMenu

Enters the Coupled-Solution menu.

Methods:

enable_coupled_solution(*args, **kwargs)

Enables/disables the coupled solution method.

enable_curvature_smoothing(*args, **kwargs)

Enables/disables the film curvature smoothing option and sets the smoothing parameters.
enable_coupled_solution(*args, **kwargs)#

Enables/disables the coupled solution method.

enable_curvature_smoothing(*args, **kwargs)#

Enables/disables the film curvature smoothing option and sets the smoothing parameters.

enable_film_vof_transition_message(*args, **kwargs)#

Enable film-VOF transition message.

enable_wallfilm_model(*args, **kwargs)#

Enables/disables Eulerian Wall Film Model.

film_material(*args, **kwargs)#

Sets Film Material and Properties.

class implicit_options(path, service)#

Bases: TUIMenu

Enter Implicit Scheme Option (beta).

Methods:

new_implicit_scheme(*args, **kwargs)

Enable alternative implicit scheme.

relative_error_residual(*args, **kwargs)

Enable relative error residual.
new_implicit_scheme(*args, **kwargs)#

Enable alternative implicit scheme.

relative_error_residual(*args, **kwargs)#

Enable relative error residual.

initialize_wallfilm_model(*args, **kwargs)#

Initializes Eulerian Wall Film Model.

list_film_walls(*args, **kwargs)#

List film walls.

model_options(*args, **kwargs)#

Set Eulerian wall film model options.

solution_options(*args, **kwargs)#

Sets Eulerian Wall Film Model Solution Options.

solve_wallfilm_equation(*args, **kwargs)#

Activates Eulerian Wall Film Equations.

frozen_flux(*args, **kwargs)#

Enables/disables frozen flux formulation for transient flows.

class heat_exchanger(path, service)#

Bases: TUIMenu

Enters the heat exchanger menu.

Classes:

dual_cell_model(path, service)

Enters the dual cell model menu.

macro_model(path, service)

Enters the heat macro-model menu.
class dual_cell_model(path, service)#

Bases: TUIMenu

Enters the dual cell model menu.

Methods:

add_heat_exchanger(*args, **kwargs)

Adds heat-exchanger.

alternative_formulation(*args, **kwargs)

Enables/disables alternative formulation for heat transfer calculations.

delete_heat_exchanger(*args, **kwargs)

Deletes heat-exchanger.

heat_exchanger(*args, **kwargs)

Enables/disables the dual cell heat-exchanger model.

modify_heat_exchanger(*args, **kwargs)

Modifies heat-exchanger.

plot_NTU(*args, **kwargs)

Plots NTU vs.

write_NTU(*args, **kwargs)

Writes NTU vs.
add_heat_exchanger(*args, **kwargs)#

Adds heat-exchanger.

alternative_formulation(*args, **kwargs)#

Enables/disables alternative formulation for heat transfer calculations.

delete_heat_exchanger(*args, **kwargs)#

Deletes heat-exchanger.

heat_exchanger(*args, **kwargs)#

Enables/disables the dual cell heat-exchanger model.

modify_heat_exchanger(*args, **kwargs)#

Modifies heat-exchanger.

plot_NTU(*args, **kwargs)#

Plots NTU vs. primary mass flow rate for each auxiliary mass flow rate.

write_NTU(*args, **kwargs)#

Writes NTU vs. primary mass flow rate for each auxiliary mass flow rate.

class macro_model(path, service)#

Bases: TUIMenu

Enters the heat macro-model menu.

Methods:

delete_heat_exchanger_group(*args, **kwargs)

Deletes heat-exchanger group.

heat_exchanger(*args, **kwargs)

Enables/disables heat-exchanger model.

heat_exchanger_group(*args, **kwargs)

Defines heat-exchanger group.

heat_exchanger_macro_report(*args, **kwargs)

Reports the computed values of heat rejection, outlet temperature, and inlet temperature for the macroscopic cells (macros) in a heat exchanger.

heat_exchanger_model(*args, **kwargs)

Defines heat-exchanger core model.

heat_exchanger_report(*args, **kwargs)

Reports the computed values of total heat rejection, outlet temperature, and inlet temperature for a specified heat-exchanger core.

heat_exchanger_zone(*args, **kwargs)

Specifies the zone that represents the heat exchanger, the dimensions of the heat exchanger, the macro grid, and the coolant direction and properties.

plot_NTU(*args, **kwargs)

Plots NTU vs.

write_NTU(*args, **kwargs)

Writes NTU vs.
delete_heat_exchanger_group(*args, **kwargs)#

Deletes heat-exchanger group.

heat_exchanger(*args, **kwargs)#

Enables/disables heat-exchanger model.

heat_exchanger_group(*args, **kwargs)#

Defines heat-exchanger group.

heat_exchanger_macro_report(*args, **kwargs)#

Reports the computed values of heat rejection, outlet temperature, and inlet temperature for the macroscopic cells (macros) in a heat exchanger.

heat_exchanger_model(*args, **kwargs)#

Defines heat-exchanger core model.

heat_exchanger_report(*args, **kwargs)#

Reports the computed values of total heat rejection, outlet temperature, and inlet temperature for a specified heat-exchanger core.

heat_exchanger_zone(*args, **kwargs)#

Specifies the zone that represents the heat exchanger, the dimensions of the heat exchanger, the macro grid, and the coolant direction and properties.

plot_NTU(*args, **kwargs)#

Plots NTU vs. primary mass flow rate for each auxiliary mass flow rate.

write_NTU(*args, **kwargs)#

Writes NTU vs. primary mass flow rate for each auxiliary mass flow rate.

class multiphase(path, service)#

Bases: TUIMenu

Enters the multiphase model menu.

Methods:

body_force_formulation(*args, **kwargs)

Specifies body force formulation.

coupled_level_set(*args, **kwargs)

Enables coupled level set interface tracking method.

interface_modeling_options(*args, **kwargs)

Specifies interface modeling options.

mixture_parameters(*args, **kwargs)

Specifies mixture parameters.

model(*args, **kwargs)

Specifies multiphase model.

number_of_phases(*args, **kwargs)

Specifies the number of phases.

regime_transition_modeling(*args, **kwargs)

Enables the Algebraic Interfacial Area Density (AIAD) model and sets the AIAD secondary continuous phase and the secondary entrained phase.

vof_sub_models(*args, **kwargs)

Enables the Open Channel sub-model and/or the Open Channel Wave Boundary Condition sub-model.

volume_fraction_parameters(*args, **kwargs)

Volume fraction parameters.

Classes:

explicit_expert_options(path, service)

Enters the menu to set explicit VOF expert options.

flow_regime_modeling(path, service)

Flow Regime Modeling.

hybrid_models(path, service)

Enter the menu to select hybrid models.

phases(path, service)

Enter the phases menu.

population_balance(path, service)

Enters the population balance models menu.

sub_models(path, service)

Enter the menu to select sub-models.

wet_steam(path, service)

Enters the wet steam model menu.
body_force_formulation(*args, **kwargs)#

Specifies body force formulation.

coupled_level_set(*args, **kwargs)#

Enables coupled level set interface tracking method.

class explicit_expert_options(path, service)#

Bases: TUIMenu

Enters the menu to set explicit VOF expert options.

Methods:

solve_vof_every_iter(*args, **kwargs)

If you enter yes, the volume fraction equations will be solved every iteration.

sub_time_step_method(*args, **kwargs)

Selects the sub-time step method.

Classes:

volume_fraction_filtering(path, service)

Enters the volume fraction filtering menu.
solve_vof_every_iter(*args, **kwargs)#

If you enter yes, the volume fraction equations will be solved every iteration. By default, the volume fraction equations will be solved only once per time step.

sub_time_step_method(*args, **kwargs)#

Selects the sub-time step method.

class volume_fraction_filtering(path, service)#

Bases: TUIMenu

Enters the volume fraction filtering menu.

Methods:

enable(*args, **kwargs)

Enables/disables the volume fraction filtering treatment.

filtering_options(*args, **kwargs)

Selects the volume fraction filtering method.

vol_frac_cutoff(*args, **kwargs)

Specifies a cut-off value for the volume fraction filtering.
enable(*args, **kwargs)#

Enables/disables the volume fraction filtering treatment.

filtering_options(*args, **kwargs)#

Selects the volume fraction filtering method. This command becomes available once the define/models/multiphase/explicit-expert-options/volume-fraction-filtering/enable? text option has been set to yes.

vol_frac_cutoff(*args, **kwargs)#

Specifies a cut-off value for the volume fraction filtering. This command becomes available after you select the node averaged cutoff method using the define/models/multiphase/explicit-expert-options/volume-fraction-filtering/filtering-options text command.

class flow_regime_modeling(path, service)#

Bases: TUIMenu

Flow Regime Modeling.

Classes:

aiad_parameters(path, service)

AIAD parameters.

Methods:

enable(*args, **kwargs)

Enable flow regime modeling framework including phase state and morphology.
class aiad_parameters(path, service)#

Bases: TUIMenu

AIAD parameters.

Methods:

critical_vf(*args, **kwargs)

Critical volume fraction for bubbly and droplet flow blending factors.

delta_grad(*args, **kwargs)

Parameter for determining transition width for free surface blending factor.

delta_vf(*args, **kwargs)

Parameter for transition width for bubbly and droplet flow blending factors.

ncells_fs(*args, **kwargs)

Parameter for determining interfacial width.
critical_vf(*args, **kwargs)#

Critical volume fraction for bubbly and droplet flow blending factors.

delta_grad(*args, **kwargs)#

Parameter for determining transition width for free surface blending factor.

delta_vf(*args, **kwargs)#

Parameter for transition width for bubbly and droplet flow blending factors.

ncells_fs(*args, **kwargs)#

Parameter for determining interfacial width.

enable(*args, **kwargs)#

Enable flow regime modeling framework including phase state and morphology.

class hybrid_models(path, service)#

Bases: TUIMenu

Enter the menu to select hybrid models.

Methods:

ddpm(*args, **kwargs)

Enable the dense discrete phase model.

multi_fluid_vof(*args, **kwargs)

Enable the multi-fluid VOF model.
ddpm(*args, **kwargs)#

Enable the dense discrete phase model.

multi_fluid_vof(*args, **kwargs)#

Enable the multi-fluid VOF model.

interface_modeling_options(*args, **kwargs)#

Specifies interface modeling options.

mixture_parameters(*args, **kwargs)#

Specifies mixture parameters.

model(*args, **kwargs)#

Specifies multiphase model.

number_of_phases(*args, **kwargs)#

Specifies the number of phases.

class phases(path, service)#

Bases: TUIMenu

Enter the phases menu.

Classes:

iac_expert(path, service)

Enter the IAC expert setting menu.

set_domain_properties(path, service)

Enter the menu to set domain properties.
class iac_expert(path, service)#

Bases: TUIMenu

Enter the IAC expert setting menu.

Methods:

hibiki_ishii_model(*args, **kwargs)

Set hi model coefficients.

iac_pseudo_time_step(*args, **kwargs)

Set iac pseudo-time.

ishii_kim_model(*args, **kwargs)

Set ik model coefficients.

yao_morel_model(*args, **kwargs)

Set ym model coefficients.
hibiki_ishii_model(*args, **kwargs)#

Set hi model coefficients.

iac_pseudo_time_step(*args, **kwargs)#

Set iac pseudo-time.

ishii_kim_model(*args, **kwargs)#

Set ik model coefficients.

yao_morel_model(*args, **kwargs)#

Set ym model coefficients.

class set_domain_properties(path, service)#

Bases: TUIMenu

Enter the menu to set domain properties.

Methods:

change_phases_names(*args, **kwargs)

Change names for all defined phases?.

phase_domains(*args, **kwargs)

Enter the menu to select a specific phase domain.

Classes:

interaction_domain(path, service)

Enter the menu to set the interaction domain properties.
change_phases_names(*args, **kwargs)#

Change names for all defined phases?.

class interaction_domain(path, service)#

Bases: TUIMenu

Enter the menu to set the interaction domain properties.

Classes:

forces(path, service)

Enter the menu to set interfacial forces related models.

heat_mass_reactions(path, service)

Enter the menu to set heat, mass-transfer, or reaction related models.

interfacial_area(path, service)

Enter the menu to set interfacial area models.

model_transition(path, service)

Enter the menu to set model transition mechanisms.

numerics(path, service)

Enter the menu to set numerics models.
class forces(path, service)#

Bases: TUIMenu

Enter the menu to set interfacial forces related models.

Classes:

cavitation(path, service)

Enter the menu to set cavitation models.

interphase_discretization(path, service)

Enter the menu to set interphase discretization models.

interphase_viscous_dissipation(path, service)

Enter the menu to set interphase viscous dissipation related models.

lift(path, service)

Enter the menu to set lift models.

surface_tension(path, service)

Enter the menu to set surface tension models.

virtual_mass(path, service)

Enter the menu to set virtual mass models.

Methods:

drag(*args, **kwargs)

Specify the drag function for each pair of phases.

heat_coeff(*args, **kwargs)

Specify the heat transfer coefficient function between each pair of phases.

interfacial_area(*args, **kwargs)

Set the interfacial area parameters for each pair of phases.

mass_transfer(*args, **kwargs)

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)

Set the model transition mechanism.

reactions(*args, **kwargs)

Define multiple heterogeneous reactions and stoichiometry.

restitution(*args, **kwargs)

Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase.

slip_velocity(*args, **kwargs)

Specify the slip velocity function for each secondary phase with respect to the primary phase.

turbulence_interaction(*args, **kwargs)

Specify the turbulence interaction model for each primary-secondary phase pair.

turbulent_dispersion(*args, **kwargs)

Specify the turbulent dispersion model for each primary-secondary phase pair.

wall_lubrication(*args, **kwargs)

Specify the wall lubrication model for each primary-secondary phase pair.
class cavitation(path, service)#

Bases: TUIMenu

Enter the menu to set cavitation models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

Enable the specification for a wall adhesion angle?.
cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

drag(*args, **kwargs)#

Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor.

heat_coeff(*args, **kwargs)#

Specify the heat transfer coefficient function between each pair of phases.

interfacial_area(*args, **kwargs)#

Set the interfacial area parameters for each pair of phases.

class interphase_discretization(path, service)#

Bases: TUIMenu

Enter the menu to set interphase discretization models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

Enable the specification for a wall adhesion angle?.
cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class interphase_viscous_dissipation(path, service)#

Bases: TUIMenu

Enter the menu to set interphase viscous dissipation related models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

Enable the specification for a wall adhesion angle?.
cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class lift(path, service)#

Bases: TUIMenu

Enter the menu to set lift models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

Enable the specification for a wall adhesion angle?.
cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

mass_transfer(*args, **kwargs)#

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)#

Set the model transition mechanism.

reactions(*args, **kwargs)#

Define multiple heterogeneous reactions and stoichiometry.

restitution(*args, **kwargs)#

Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase.

slip_velocity(*args, **kwargs)#

Specify the slip velocity function for each secondary phase with respect to the primary phase.

class surface_tension(path, service)#

Bases: TUIMenu

Enter the menu to set surface tension models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

Enable the specification for a wall adhesion angle?.
cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

turbulence_interaction(*args, **kwargs)#

Specify the turbulence interaction model for each primary-secondary phase pair.

turbulent_dispersion(*args, **kwargs)#

Specify the turbulent dispersion model for each primary-secondary phase pair.

class virtual_mass(path, service)#

Bases: TUIMenu

Enter the menu to set virtual mass models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

Enable the specification for a wall adhesion angle?.
cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

wall_lubrication(*args, **kwargs)#

Specify the wall lubrication model for each primary-secondary phase pair.

class heat_mass_reactions(path, service)#

Bases: TUIMenu

Enter the menu to set heat, mass-transfer, or reaction related models.

Classes:

cavitation(path, service)

Enter the menu to set cavitation models.

interphase_discretization(path, service)

Enter the menu to set interphase discretization models.

interphase_viscous_dissipation(path, service)

Enter the menu to set interphase viscous dissipation related models.

lift(path, service)

Enter the menu to set lift models.

surface_tension(path, service)

Enter the menu to set surface tension models.

virtual_mass(path, service)

Enter the menu to set virtual mass models.

Methods:

drag(*args, **kwargs)

Specify the drag function for each pair of phases.

heat_coeff(*args, **kwargs)

Specify the heat transfer coefficient function between each pair of phases.

interfacial_area(*args, **kwargs)

Set the interfacial area parameters for each pair of phases.

mass_transfer(*args, **kwargs)

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)

Set the model transition mechanism.

reactions(*args, **kwargs)

Define multiple heterogeneous reactions and stoichiometry.

restitution(*args, **kwargs)

Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase.

slip_velocity(*args, **kwargs)

Specify the slip velocity function for each secondary phase with respect to the primary phase.

turbulence_interaction(*args, **kwargs)

Specify the turbulence interaction model for each primary-secondary phase pair.

turbulent_dispersion(*args, **kwargs)

Specify the turbulent dispersion model for each primary-secondary phase pair.

wall_lubrication(*args, **kwargs)

Specify the wall lubrication model for each primary-secondary phase pair.
class cavitation(path, service)#

Bases: TUIMenu

Enter the menu to set cavitation models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

Enable the specification for a wall adhesion angle?.
cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

drag(*args, **kwargs)#

Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor.

heat_coeff(*args, **kwargs)#

Specify the heat transfer coefficient function between each pair of phases.

interfacial_area(*args, **kwargs)#

Set the interfacial area parameters for each pair of phases.

class interphase_discretization(path, service)#

Bases: TUIMenu

Enter the menu to set interphase discretization models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

Enable the specification for a wall adhesion angle?.
cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class interphase_viscous_dissipation(path, service)#

Bases: TUIMenu

Enter the menu to set interphase viscous dissipation related models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

Enable the specification for a wall adhesion angle?.
cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class lift(path, service)#

Bases: TUIMenu

Enter the menu to set lift models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

Enable the specification for a wall adhesion angle?.
cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

mass_transfer(*args, **kwargs)#

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)#

Set the model transition mechanism.

reactions(*args, **kwargs)#

Define multiple heterogeneous reactions and stoichiometry.

restitution(*args, **kwargs)#

Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase.

slip_velocity(*args, **kwargs)#

Specify the slip velocity function for each secondary phase with respect to the primary phase.

class surface_tension(path, service)#

Bases: TUIMenu

Enter the menu to set surface tension models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

Enable the specification for a wall adhesion angle?.
cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

turbulence_interaction(*args, **kwargs)#

Specify the turbulence interaction model for each primary-secondary phase pair.

turbulent_dispersion(*args, **kwargs)#

Specify the turbulent dispersion model for each primary-secondary phase pair.

class virtual_mass(path, service)#

Bases: TUIMenu

Enter the menu to set virtual mass models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

Enable the specification for a wall adhesion angle?.
cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

wall_lubrication(*args, **kwargs)#

Specify the wall lubrication model for each primary-secondary phase pair.

class interfacial_area(path, service)#

Bases: TUIMenu

Enter the menu to set interfacial area models.

Classes:

cavitation(path, service)

Enter the menu to set cavitation models.

interphase_discretization(path, service)

Enter the menu to set interphase discretization models.

interphase_viscous_dissipation(path, service)

Enter the menu to set interphase viscous dissipation related models.

lift(path, service)

Enter the menu to set lift models.

surface_tension(path, service)

Enter the menu to set surface tension models.

virtual_mass(path, service)

Enter the menu to set virtual mass models.

Methods:

drag(*args, **kwargs)

Specify the drag function for each pair of phases.

heat_coeff(*args, **kwargs)

Specify the heat transfer coefficient function between each pair of phases.

interfacial_area(*args, **kwargs)

Set the interfacial area parameters for each pair of phases.

mass_transfer(*args, **kwargs)

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)

Set the model transition mechanism.

reactions(*args, **kwargs)

Define multiple heterogeneous reactions and stoichiometry.

restitution(*args, **kwargs)

Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase.

slip_velocity(*args, **kwargs)

Specify the slip velocity function for each secondary phase with respect to the primary phase.

turbulence_interaction(*args, **kwargs)

Specify the turbulence interaction model for each primary-secondary phase pair.

turbulent_dispersion(*args, **kwargs)

Specify the turbulent dispersion model for each primary-secondary phase pair.

wall_lubrication(*args, **kwargs)

Specify the wall lubrication model for each primary-secondary phase pair.
class cavitation(path, service)#

Bases: TUIMenu

Enter the menu to set cavitation models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

Enable the specification for a wall adhesion angle?.
cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

drag(*args, **kwargs)#

Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor.

heat_coeff(*args, **kwargs)#

Specify the heat transfer coefficient function between each pair of phases.

interfacial_area(*args, **kwargs)#

Set the interfacial area parameters for each pair of phases.

class interphase_discretization(path, service)#

Bases: TUIMenu

Enter the menu to set interphase discretization models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

Enable the specification for a wall adhesion angle?.
cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class interphase_viscous_dissipation(path, service)#

Bases: TUIMenu

Enter the menu to set interphase viscous dissipation related models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

Enable the specification for a wall adhesion angle?.
cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class lift(path, service)#

Bases: TUIMenu

Enter the menu to set lift models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

Enable the specification for a wall adhesion angle?.
cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

mass_transfer(*args, **kwargs)#

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)#

Set the model transition mechanism.

reactions(*args, **kwargs)#

Define multiple heterogeneous reactions and stoichiometry.

restitution(*args, **kwargs)#

Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase.

slip_velocity(*args, **kwargs)#

Specify the slip velocity function for each secondary phase with respect to the primary phase.

class surface_tension(path, service)#

Bases: TUIMenu

Enter the menu to set surface tension models.

Methods:

cavitation(*args, **kwargs)

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

s