models#

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

Bases: TUIMenu

Enter the models menu to configure the solver.

Methods:

ablation(*args, **kwargs)

Enable/disable ablation model.

addon_module(*args, **kwargs)

Load addon module.

axisymmetric(*args, **kwargs)

Enable/disable the axisymmetric model.

battery_model(*args, **kwargs)

Enter battery model menu.

crevice_model(*args, **kwargs)

Enable/disable the crevice model.

crevice_model_controls(*args, **kwargs)

Enter the crevice model controls menu.

energy(*args, **kwargs)

Enable/disable the energy model.

frozen_flux(*args, **kwargs)

Enable/disable frozen flux formulation for transient flows.

noniterative_time_advance(*args, **kwargs)

Enable/disable the noniterative time advancement scheme.

nox(*args, **kwargs)

Enable/disable the NOx model.

potential_and_li_ion_battery(*args, **kwargs)

Enable/disable the electric-potential model.

solidification_melting(*args, **kwargs)

Enable/disable the solidification and melting model.

soot(*args, **kwargs)

Enable/disable the soot model.

steady(*args, **kwargs)

Enable/disable the steady solution model.

swirl(*args, **kwargs)

Enable/disable axisymmetric swirl velocity.

unsteady_1st_order(*args, **kwargs)

Enable/disable first-order unsteady solution model.

unsteady_2nd_order(*args, **kwargs)

Enable/disable the second-order unsteady solution model.

unsteady_2nd_order_bounded(*args, **kwargs)

Enable/disable bounded second-order unsteady formulation.

unsteady_global_time(*args, **kwargs)

Enable/disable the unsteady global-time-step solution model.

unsteady_structure_euler(*args, **kwargs)

Enable/disable Backward Euler unsteady solution model.

unsteady_structure_newmark(*args, **kwargs)

Enable/disable Newmark unsteady solution model.

vbm(*args, **kwargs)

Enable/disable Virtual Blade Model.

virtual_blade_model(*args, **kwargs)

Enter VBM model menu.

Classes:

acoustics(path, service)

Enter the acoustics model menu.

cht(path, service)

Enter the mapped interface model menu.

dpm(path, service)

Enter the dispersed phase model menu.

electrolysis(path, service)

Enter the electrolysis model setup menu.

eulerian_wallfilm(path, service)

Enter the Eulerian wall film model menu.

heat_exchanger(path, service)

Enter the heat exchanger menu.

multiphase(path, service)

Define multiphase model menu.

nox_parameters(path, service)

Enter the NOx parameters menu.

optics(path, service)

Enter the optics model menu.

radiation(path, service)

Enter the radiation models menu.

shell_conduction(path, service)

Enter the shell conduction model menu.

solver(path, service)

Enter the menu to select the solver.

soot_parameters(path, service)

Enter the soot parameters menu.

species(path, service)

Enter the species models menu.

structure(path, service)

Enter the structure model menu.

system_coupling_settings(path, service)

Enter the system coupling model menu.

two_temperature(path, service)

Define two-temperature model menu.

viscous(path, service)

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

Enable/disable ablation model.

class acoustics(path, service)#

Bases: TUIMenu

Enter the acoustics model menu.

Methods:

acoustic_modal_analysis(*args, **kwargs)

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

auto_prune(*args, **kwargs)

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

broad_band_noise(*args, **kwargs)

Enable/disable the broadband noise model.

compute_write(*args, **kwargs)

Compute sound pressure.

convective_effects(*args, **kwargs)

Enable/disable convective effects option.

cylindrical_export(*args, **kwargs)

Enable/disable the export data in cylindrical coordinates.

display_flow_time(*args, **kwargs)

Enable/disable the display of flow time during read-and-compute.

display_frequencies(*args, **kwargs)

Display resonance frequencies.

export_source_data(*args, **kwargs)

Enable export acoustic source data in ASD format during the wave equation model run.

export_source_data_cgns(*args, **kwargs)

Export acoustic source data in CGNS format.

export_volumetric_sources(*args, **kwargs)

Enable/disable the export of fluid zones.

export_volumetric_sources_cgns(*args, **kwargs)

Enable/disable the export of fluid zones.

ffowcs_williams(*args, **kwargs)

Enable/disable the Ffowcs-Williams-and-Hawkings model.

modal_analysis(*args, **kwargs)

Enable/disable the modal analysis model.

moving_receiver(*args, **kwargs)

Enable/disable moving receiver option.

off(*args, **kwargs)

Enable/disable the acoustics model.

read_compute_write(*args, **kwargs)

Read acoustic source data files and compute sound pressure.

receivers(*args, **kwargs)

Set acoustic receivers.

sources(*args, **kwargs)

Set acoustic sources.

wave_equation(*args, **kwargs)

Enable/disable the wave equation model.

write_acoustic_signals(*args, **kwargs)

Write on-the-fly sound pressure.

write_centroid_info(*args, **kwargs)

Write centroid info.

Classes:

far_field_parameters(path, service)

Enter the far field parameters menu for the wave equation model.

sources_fft(path, service)

Enter the acoustic sources FFT menu.

sponge_layers(path, service)

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

wave_equation_options(path, service)

Enter the options menu for the wave equation model.
acoustic_modal_analysis(*args, **kwargs)#

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

auto_prune(*args, **kwargs)#

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

broad_band_noise(*args, **kwargs)#

Enable/disable the broadband noise model.

compute_write(*args, **kwargs)#

Compute sound pressure.

convective_effects(*args, **kwargs)#

Enable/disable convective effects option.

cylindrical_export(*args, **kwargs)#

Enable/disable the export data in cylindrical coordinates.

display_flow_time(*args, **kwargs)#

Enable/disable the display of flow time during read-and-compute.

display_frequencies(*args, **kwargs)#

Display resonance frequencies.

export_source_data(*args, **kwargs)#

Enable export acoustic source data in ASD format during the wave equation model run.

export_source_data_cgns(*args, **kwargs)#

Export acoustic source data in CGNS format.

export_volumetric_sources(*args, **kwargs)#

Enable/disable the export of fluid zones.

export_volumetric_sources_cgns(*args, **kwargs)#

Enable/disable the export of fluid zones.

class far_field_parameters(path, service)#

Bases: TUIMenu

Enter the far field parameters menu for the wave equation model.

Methods:

far_field_density(*args, **kwargs)

Specify far field density.

far_field_sound_speed(*args, **kwargs)

Specify far field speed of sound.
far_field_density(*args, **kwargs)#

Specify far field density.

far_field_sound_speed(*args, **kwargs)#

Specify far field speed of sound.

ffowcs_williams(*args, **kwargs)#

Enable/disable the Ffowcs-Williams-and-Hawkings model.

modal_analysis(*args, **kwargs)#

Enable/disable the modal analysis model.

moving_receiver(*args, **kwargs)#

Enable/disable moving receiver option.

off(*args, **kwargs)#

Enable/disable the acoustics model.

read_compute_write(*args, **kwargs)#

Read acoustic source data files and compute sound pressure.

receivers(*args, **kwargs)#

Set acoustic receivers.

sources(*args, **kwargs)#

Set acoustic sources.

class sources_fft(path, service)#

Bases: TUIMenu

Enter the acoustic sources FFT menu.

Methods:

clean_up_storage_area(*args, **kwargs)

Clean up storage area.

compute_fft_fields(*args, **kwargs)

Compute FFT fields.

read_asd_files(*args, **kwargs)

Read ASD files.

write_cgns_files(*args, **kwargs)

Write CGNS files.

Classes:

fft_surface_variables(path, service)

Enter the FFT surface variables menu.
clean_up_storage_area(*args, **kwargs)#

Clean up storage area.

compute_fft_fields(*args, **kwargs)#

Compute FFT fields.

class fft_surface_variables(path, service)#

Bases: TUIMenu

Enter the FFT surface variables menu.

Methods:

create_constant_width_bands(*args, **kwargs)

Create constant-width bands.

create_octave_bands(*args, **kwargs)

Create octave bands.

create_set_of_modes(*args, **kwargs)

Create set of modes.

create_third_bands(*args, **kwargs)

Create third bands.

remove_variables(*args, **kwargs)

Remove variables.
create_constant_width_bands(*args, **kwargs)#

Create constant-width bands.

create_octave_bands(*args, **kwargs)#

Create octave bands.

create_set_of_modes(*args, **kwargs)#

Create set of modes.

create_third_bands(*args, **kwargs)#

Create third bands.

remove_variables(*args, **kwargs)#

Remove variables.

read_asd_files(*args, **kwargs)#

Read ASD files.

write_cgns_files(*args, **kwargs)#

Write CGNS files.

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)

Delete a sponge layer definition.

edit(*args, **kwargs)

Edit a sponge layer definition.

list(*args, **kwargs)

List the names of the sponge layer definitions.

list_active(*args, **kwargs)

List the names of the active sponge layer definitions.

list_properties(*args, **kwargs)

List the properties of a sponge layer definition.
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)#

Delete a sponge layer definition.

edit(*args, **kwargs)#

Edit a sponge layer definition.

list(*args, **kwargs)#

List the names of the sponge layer definitions.

list_active(*args, **kwargs)#

List the names of the active sponge layer definitions.

list_properties(*args, **kwargs)#

List the properties of a sponge layer definition.

wave_equation(*args, **kwargs)#

Enable/disable the wave equation model.

class wave_equation_options(path, service)#

Bases: TUIMenu

Enter the options menu for the wave equation model.

Classes:

basic_shapes(path, service)

Enter the basic shapes menu to build source mask and sponge layer geometry shapes using cell registers.

remote_receivers_options(path, service)

Enter the menu to set up the Kirchhoff's integral method and output its results.

Methods:

remote_receivers(*args, **kwargs)

Activate the Kirchhoff's integral method for remote receivers.

source_mask_udf(*args, **kwargs)

Select user-defined function for sound source masking.

sponge_layer_base_level(*args, **kwargs)

Specify artificial viscosity base level applied everywhere.

sponge_layer_factor(*args, **kwargs)

Specify artificial viscosity factor for sponge layer.

sponge_layer_udf(*args, **kwargs)

Select user-defined function for sponge layer.

time_filter_source(*args, **kwargs)

Activate time-filtering of sound sources.
class basic_shapes(path, service)#

Bases: TUIMenu

Enter the basic shapes menu to build source mask and sponge layer geometry shapes using cell registers.

Methods:

add_source_mask_shape(*args, **kwargs)

Add a region register for the source mask.

add_sponge_layer_shape(*args, **kwargs)

Add a region register for the sponge layer.

list_region_registers(*args, **kwargs)

List all available region registers (hex/cylinder/sphere).

list_source_mask_shapes(*args, **kwargs)

List all active source mask registers.

list_sponge_layer_shapes(*args, **kwargs)

List all active sponge layer registers.

remove_source_mask_shape(*args, **kwargs)

Remove a region register from the source mask.

remove_sponge_layer_shape(*args, **kwargs)

Remove a region register from the sponge layer.
add_source_mask_shape(*args, **kwargs)#

Add a region register for the source mask.

add_sponge_layer_shape(*args, **kwargs)#

Add a region register for the sponge layer.

list_region_registers(*args, **kwargs)#

List all available region registers (hex/cylinder/sphere).

list_source_mask_shapes(*args, **kwargs)#

List all active source mask registers.

list_sponge_layer_shapes(*args, **kwargs)#

List all active sponge layer registers.

remove_source_mask_shape(*args, **kwargs)#

Remove a region register from the source mask.

remove_sponge_layer_shape(*args, **kwargs)#

Remove a region register from the sponge layer.

remote_receivers(*args, **kwargs)#

Activate the Kirchhoff’s integral method for remote receivers.

class remote_receivers_options(path, service)#

Bases: TUIMenu

Enter the menu to set up the Kirchhoff’s integral method and output its results.

Methods:

integration_surface(*args, **kwargs)

Select Kirchhoff's integration surface.

write_signals(*args, **kwargs)

Write signals calculated at receiver locations.
integration_surface(*args, **kwargs)#

Select Kirchhoff’s integration surface.

write_signals(*args, **kwargs)#

Write signals calculated at receiver locations.

source_mask_udf(*args, **kwargs)#

Select user-defined function for sound source masking.

sponge_layer_base_level(*args, **kwargs)#

Specify artificial viscosity base level applied everywhere.

sponge_layer_factor(*args, **kwargs)#

Specify artificial viscosity factor for sponge layer.

sponge_layer_udf(*args, **kwargs)#

Select user-defined function for sponge layer.

time_filter_source(*args, **kwargs)#

Activate time-filtering of sound sources.

write_acoustic_signals(*args, **kwargs)#

Write on-the-fly sound pressure.

write_centroid_info(*args, **kwargs)#

Write centroid info.

addon_module(*args, **kwargs)#

Load addon module.

axisymmetric(*args, **kwargs)#

Enable/disable the axisymmetric model.

battery_model(*args, **kwargs)#

Enter battery model menu.

class cht(path, service)#

Bases: TUIMenu

Enter the mapped interface model menu.

Classes:

explicit_time_averaged_coupling(path, service)

Enter the explcit time averaged thermal coupling menu.

Methods:

implicit_coupling(*args, **kwargs)

Enable/disable implicit coupling for mapped interface.

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

Enter the explcit 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)#

Enable/disable implicit coupling for mapped interface.

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

Enable/disable the crevice model.

crevice_model_controls(*args, **kwargs)#

Enter the crevice model controls menu.

class dpm(path, service)#

Bases: TUIMenu

Enter the dispersed phase model menu.

Methods:

clear_particles_from_domain(*args, **kwargs)

Remove/keep all particles currently in the domain.

fill_injection_material_sources(*args, **kwargs)

Initialize the DPM sources corresponding to each material.

injections(*args, **kwargs)

Enter the injections menu.

spray_model(*args, **kwargs)

Enter the spray model menu.

unsteady_tracking(*args, **kwargs)

Enable/disable unsteady particle tracking.

user_defined(*args, **kwargs)

Set DPM user-defined functions.

Classes:

collisions(path, service)

Enter the DEM collisions menu.

erosion_dynamic_mesh(path, service)

Enter the erosion-dynamic mesh interactions menu.

interaction(path, service)

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

numerics(path, service)

Enter the numerics menu to set numerical solution parameters.

options(path, service)

Enter the options menu to set optional DPM models.

parallel(path, service)

Enter the parallel menu.

splash_options(path, service)

Enter the splash options menu to set optional parameters.

stripping_options(path, service)

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

Remove/keep all particles currently in the domain.

class collisions(path, service)#

Bases: TUIMenu

Enter the DEM collisions menu.

Methods:

collision_mesh(*args, **kwargs)

Input for the collision mesh.

collision_pair_settings(*args, **kwargs)

Supply settings for collisions to a pair of collision partners.

dem_collisions(*args, **kwargs)

Enable/disable the DEM collision model.

list_all_pair_settings(*args, **kwargs)

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

max_particle_velocity(*args, **kwargs)

Set the maximum particle velocity that may arise from collisions.

Classes:

collision_partners(path, service)

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

Input for the collision mesh.

collision_pair_settings(*args, **kwargs)#

Supply settings for collisions to a pair of collision partners.

class collision_partners(path, service)#

Bases: TUIMenu

Manage collision partners.

Methods:

copy(*args, **kwargs)

Copy a collision partner.

create(*args, **kwargs)

Create a collision partner.

delete(*args, **kwargs)

Delete a collision partner.

list(*args, **kwargs)

Lists all known collision partners.

rename(*args, **kwargs)

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

Copy a collision partner.

create(*args, **kwargs)#

Create a collision partner.

delete(*args, **kwargs)#

Delete a collision partner.

list(*args, **kwargs)#

Lists all known collision partners.

rename(*args, **kwargs)#

Rename a collision partner.

dem_collisions(*args, **kwargs)#

Enable/disable the DEM collision model.

list_all_pair_settings(*args, **kwargs)#

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

max_particle_velocity(*args, **kwargs)#

Set the maximum particle velocity that may arise from collisions.

class erosion_dynamic_mesh(path, service)#

Bases: TUIMenu

Enter the erosion-dynamic mesh interactions menu.

Methods:

enable_erosion_dynamic_mesh_coupling(*args, ...)

Enable mesh deformation due to wall erosion.

run_simulation(*args, **kwargs)

Perform coupled erosion-dynamic mesh simulation.

Classes:

general_parameters(path, service)

Enter the erosion-dynamic mesh setup menu.

run_parameters(path, service)

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

Enable mesh deformation due to wall erosion.

class general_parameters(path, service)#

Bases: TUIMenu

Enter the erosion-dynamic mesh setup menu.

Methods:

dynamic_mesh_settings(*args, **kwargs)

Perform dynamic mesh related setup.

erosion_settings(*args, **kwargs)

Set erosion modelling specific settings.

participating_walls(*args, **kwargs)

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

Perform dynamic mesh related setup.

erosion_settings(*args, **kwargs)#

Set erosion modelling specific settings.

participating_walls(*args, **kwargs)#

Specify all participating walls.

class run_parameters(path, service)#

Bases: TUIMenu

Enter the erosion-dynamic mesh run menu.

Methods:

autosave_files(*args, **kwargs)

Set the iteration increment to save data files.

autosave_graphics(*args, **kwargs)

Set the iteration increment to save graphics files.

flow_simulation_control(*args, **kwargs)

Set number of iterations per flow simulation step.

mesh_motion_time_step(*args, **kwargs)

Set the mesh motion time stepping parameters and method.

simulation_termination(*args, **kwargs)

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

Set the iteration increment to save data files.

autosave_graphics(*args, **kwargs)#

Set the iteration increment to save graphics files.

flow_simulation_control(*args, **kwargs)#

Set number of iterations per flow simulation step.

mesh_motion_time_step(*args, **kwargs)#

Set the mesh motion time stepping parameters and method.

simulation_termination(*args, **kwargs)#

Set total time of erosion.

run_simulation(*args, **kwargs)#

Perform coupled erosion-dynamic mesh simulation.

fill_injection_material_sources(*args, **kwargs)#

Initialize the DPM sources corresponding to each material.

injections(*args, **kwargs)#

Enter the injections menu.

class interaction(path, service)#

Bases: TUIMenu

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

Methods:

choice_of_eulerian_phase_for_interaction(...)

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

coupled_calculations(*args, **kwargs)

Enable/disable coupling of continuous and discrete phase calculations.

ddpm_energy_coupling_via_source_term(*args, ...)

Energy coupling in DDPM established via source term.

ddpm_enhanced_inter_phase_exchange(*args, ...)

Enhanced Eulerian inter-phase exchange.

ddpm_iad_particle(*args, **kwargs)

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

dpm_iteration_interval(*args, **kwargs)

Set the number of continuous phase iterations per DPM iteration.

enable_drag_scaling_due_to_flow_blocking(...)

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

enable_flow_blocking_by_particles(*args, ...)

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

enable_source_scaling_due_to_flow_blocking(...)

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

implicit_momentum_coupling(*args, **kwargs)

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

implicit_source_term_coupling(*args, **kwargs)

Enable/disable implicit treatment for all DPM source terms.

keep_linearized_dpm_source_terms_constant(...)

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

linear_growth_of_dpm_source_term(*args, **kwargs)

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

linearized_dpm_mixture_fraction_source_terms(...)

Perform a linearization of mixture fraction source terms.

linearized_dpm_source_terms(*args, **kwargs)

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

linearized_dpm_source_terms_limiter(*args, ...)

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

linearized_dpm_species_source_terms(*args, ...)

Perform linearization of species source terms.

max_vf_allowed_for_blocking(*args, **kwargs)

Maximum DPM volume fraction used in continuous flow.

min_vf_threshold_for_dpm_src_scaling(*args, ...)

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

replace_dpm_mass_source_by_mixture_fraction(...)

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

reset_sources_at_timestep(*args, **kwargs)

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

underrelaxation_factor(*args, **kwargs)

Set the under-relaxation factor.

update_dpm_sources_every_flow_iteration(...)

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

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

coupled_calculations(*args, **kwargs)#

Enable/disable coupling of continuous and discrete phase calculations.

ddpm_energy_coupling_via_source_term(*args, **kwargs)#

Energy coupling in DDPM established via source term.

ddpm_enhanced_inter_phase_exchange(*args, **kwargs)#

Enhanced Eulerian inter-phase exchange.

ddpm_iad_particle(*args, **kwargs)#

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

dpm_iteration_interval(*args, **kwargs)#

Set the number of continuous phase iterations per DPM iteration.

enable_drag_scaling_due_to_flow_blocking(*args, **kwargs)#

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

enable_flow_blocking_by_particles(*args, **kwargs)#

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

enable_source_scaling_due_to_flow_blocking(*args, **kwargs)#

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

implicit_momentum_coupling(*args, **kwargs)#

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

implicit_source_term_coupling(*args, **kwargs)#

Enable/disable implicit treatment for all DPM source terms.

keep_linearized_dpm_source_terms_constant(*args, **kwargs)#

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

linear_growth_of_dpm_source_term(*args, **kwargs)#

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

linearized_dpm_mixture_fraction_source_terms(*args, **kwargs)#

Perform a linearization of mixture fraction source terms.

linearized_dpm_source_terms(*args, **kwargs)#

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

linearized_dpm_source_terms_limiter(*args, **kwargs)#

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

linearized_dpm_species_source_terms(*args, **kwargs)#

Perform linearization of species source terms.

max_vf_allowed_for_blocking(*args, **kwargs)#

Maximum DPM volume fraction used in continuous flow.

min_vf_threshold_for_dpm_src_scaling(*args, **kwargs)#

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

replace_dpm_mass_source_by_mixture_fraction(*args, **kwargs)#

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

reset_sources_at_timestep(*args, **kwargs)#

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

underrelaxation_factor(*args, **kwargs)#

Set the under-relaxation factor.

update_dpm_sources_every_flow_iteration(*args, **kwargs)#

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

class numerics(path, service)#

Bases: TUIMenu

Enter the numerics menu to set numerical solution parameters.

Methods:

automated_scheme_selection(*args, **kwargs)

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

average_DDPM_variables(*args, **kwargs)

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

average_each_step(*args, **kwargs)

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

average_kernel(*args, **kwargs)

Specify a kernel for the averaging.

average_source_terms(*args, **kwargs)

Average DPM source terms on nodes.

coupled_heat_mass_update(*args, **kwargs)

Enable/disable coupled heat and mass update.

drag_law(*args, **kwargs)

Set the drag law.

dynamic_interaction(*args, **kwargs)

Enable/disable dynamic interaction range.

enable_node_based_averaging(*args, **kwargs)

Enable node based averaging of DPM variables.

enhanced_packing_limit_numerics(*args, **kwargs)

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

error_control(*args, **kwargs)

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

gaussian_factor(*args, **kwargs)

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

granular_stress_tensor(*args, **kwargs)

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

minimum_liquid_fraction(*args, **kwargs)

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

mppic_settings(*args, **kwargs)

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

predictor_corrector(*args, **kwargs)

Enable predictor/corrector approach to track particles.

tracking_parameters(*args, **kwargs)

Set parameters for the (initial) tracking step length.

tracking_scheme(*args, **kwargs)

Specify a tracking scheme.

tracking_statistics(*args, **kwargs)

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

underrelax_film_height(*args, **kwargs)

Define underrelaxation factor for film height.

vaporization_limiting_factors(*args, **kwargs)

Set Vaporization Fractional Change Limits.

verbosity(*args, **kwargs)

Adjust the DPM tracker's verbosity level.

Classes:

high_resolution_tracking(path, service)

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

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

average_DDPM_variables(*args, **kwargs)#

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

average_each_step(*args, **kwargs)#

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

average_kernel(*args, **kwargs)#

Specify a kernel for the averaging.

average_source_terms(*args, **kwargs)#

Average DPM source terms on nodes.

coupled_heat_mass_update(*args, **kwargs)#

Enable/disable coupled heat and mass update.

drag_law(*args, **kwargs)#

Set the drag law.

dynamic_interaction(*args, **kwargs)#

Enable/disable dynamic interaction range.

enable_node_based_averaging(*args, **kwargs)#

Enable node based averaging of DPM variables.

enhanced_packing_limit_numerics(*args, **kwargs)#

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

error_control(*args, **kwargs)#

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

gaussian_factor(*args, **kwargs)#

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

granular_stress_tensor(*args, **kwargs)#

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

class high_resolution_tracking(path, service)#

Bases: TUIMenu

Enter the high resolution tracking menu.

Methods:

always_use_face_centroid_with_periodics(...)

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

boundary_layer_tracking(*args, **kwargs)

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

check_subtet_validity(*args, **kwargs)

Test for inverted subtets due to warped cells.

enable_automatic_intersection_tolerance(...)

Enable automatic scaling of subtet intersection tolerance.

enable_barycentric_intersections(*args, **kwargs)

Use barycentric coordinates for intersection calculations.

enable_high_resolution_tracking(*args, **kwargs)

Enable high resolution tracking.

project_wall_film_particles_to_film(*args, ...)

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

remove_stuck_particles(*args, **kwargs)

Remove particles that are stuck at edges or faces.

set_film_spreading_parameter(*args, **kwargs)

Set the spreading parameter for Lagrangian wallfilm particles.

set_subtet_intersection_tolerance(*args, ...)

Set the tolerance for subtet intersection calculations.

sliding_interface_crossover_fraction(*args, ...)

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

use_barycentric_sampling(*args, **kwargs)

Use barycentric coordinates when sampling at planes.

use_particle_timestep_for_intersection_tolerance(...)

Use the particle timestep for the axisymmetric subtet intersection tolerance.

use_quad_face_centroid(*args, **kwargs)

Use quad face centroids when creating subtets.

use_velocity_based_error_control(*args, **kwargs)

Use adaptive time stepping based upon the particle velocity.

Classes:

barycentric_interpolation(path, service)

Enter the barycentric interpolation menu.

particle_relocation(path, service)

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

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

class barycentric_interpolation(path, service)#

Bases: TUIMenu

Enter the barycentric interpolation menu.

Methods:

enable_transient_variable_interpolation(...)

Enable transient variable interpolation.

interpolate_flow_cp(*args, **kwargs)

Enable interpolation of flow specific heat to the particle position.

interpolate_flow_density(*args, **kwargs)

Enable interpolation of flow density to the particle position.

interpolate_flow_solution_gradients(*args, ...)

Enable interpolation of flow solution gradients.

interpolate_flow_viscosity(*args, **kwargs)

Enable interpolation of flow viscosity to the particle position.

interpolate_temperature(*args, **kwargs)

Enable interpolation of temperature to the particle position.

interpolate_wallfilm_properties(*args, **kwargs)

Enable interpolation of wallfilm properties to the particle position.

nodal_reconstruction_frequency(*args, **kwargs)

Update nodal reconstruction every N'th DPM iteration.

precompute_pdf_species(*args, **kwargs)

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

user_interpolation_function(*args, **kwargs)

Enter user interpolation function.

zero_nodal_velocity_on_walls(*args, **kwargs)

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

Enable transient variable interpolation.

interpolate_flow_cp(*args, **kwargs)#

Enable interpolation of flow specific heat to the particle position.

interpolate_flow_density(*args, **kwargs)#

Enable interpolation of flow density to the particle position.

interpolate_flow_solution_gradients(*args, **kwargs)#

Enable interpolation of flow solution gradients.

interpolate_flow_viscosity(*args, **kwargs)#

Enable interpolation of flow viscosity to the particle position.

interpolate_temperature(*args, **kwargs)#

Enable interpolation of temperature to the particle position.

interpolate_wallfilm_properties(*args, **kwargs)#

Enable interpolation of wallfilm properties to the particle position.

nodal_reconstruction_frequency(*args, **kwargs)#

Update nodal reconstruction every N’th DPM iteration.

precompute_pdf_species(*args, **kwargs)#

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

user_interpolation_function(*args, **kwargs)#

Enter user interpolation function.

zero_nodal_velocity_on_walls(*args, **kwargs)#

Set the nodal velocity on all walls to zero.

boundary_layer_tracking(*args, **kwargs)#

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

check_subtet_validity(*args, **kwargs)#

Test for inverted subtets due to warped cells.

enable_automatic_intersection_tolerance(*args, **kwargs)#

Enable automatic scaling of subtet intersection tolerance.

enable_barycentric_intersections(*args, **kwargs)#

Use barycentric coordinates for intersection calculations.

enable_high_resolution_tracking(*args, **kwargs)#

Enable high resolution tracking.

class particle_relocation(path, service)#

Bases: TUIMenu

Enter the particle relocation menu.

Methods:

enhanced_cell_relocation_method(*args, **kwargs)

Enable enhanced method of locating particles in cells.

enhanced_wallfilm_location_method(*args, ...)

Enable enhanced method of locating film particles on faces.

load_legacy_particles(*args, **kwargs)

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

overset_relocation_robustness_level(*args, ...)

Set the robustness level for particle relocation in overset meshes.

use_legacy_particle_location_method(*args, ...)

Enable legacy method of locating particles in cells.

wallfilm_relocation_tolerance_scale_factor(...)

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

Enable enhanced method of locating particles in cells.

enhanced_wallfilm_location_method(*args, **kwargs)#

Enable enhanced method of locating film particles on faces.

load_legacy_particles(*args, **kwargs)#

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

overset_relocation_robustness_level(*args, **kwargs)#

Set the robustness level for particle relocation in overset meshes.

use_legacy_particle_location_method(*args, **kwargs)#

Enable legacy method of locating particles in cells.

wallfilm_relocation_tolerance_scale_factor(*args, **kwargs)#

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

project_wall_film_particles_to_film(*args, **kwargs)#

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

remove_stuck_particles(*args, **kwargs)#

Remove particles that are stuck at edges or faces.

set_film_spreading_parameter(*args, **kwargs)#

Set the spreading parameter for Lagrangian wallfilm particles.

set_subtet_intersection_tolerance(*args, **kwargs)#

Set the tolerance for subtet intersection calculations.

sliding_interface_crossover_fraction(*args, **kwargs)#

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

use_barycentric_sampling(*args, **kwargs)#

Use barycentric coordinates when sampling at planes.

use_particle_timestep_for_intersection_tolerance(*args, **kwargs)#

Use the particle timestep for the axisymmetric subtet intersection tolerance.

use_quad_face_centroid(*args, **kwargs)#

Use quad face centroids when creating subtets.

use_velocity_based_error_control(*args, **kwargs)#

Use adaptive time stepping based upon the particle velocity.

minimum_liquid_fraction(*args, **kwargs)#

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

mppic_settings(*args, **kwargs)#

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

predictor_corrector(*args, **kwargs)#

Enable predictor/corrector approach to track particles.

tracking_parameters(*args, **kwargs)#

Set parameters for the (initial) tracking step length.

tracking_scheme(*args, **kwargs)#

Specify a tracking scheme.

tracking_statistics(*args, **kwargs)#

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

underrelax_film_height(*args, **kwargs)#

Define underrelaxation factor for film height.

vaporization_limiting_factors(*args, **kwargs)#

Set Vaporization Fractional Change Limits.

verbosity(*args, **kwargs)#

Adjust the DPM tracker’s verbosity level.

class options(path, service)#

Bases: TUIMenu

Enter the options menu to set optional DPM models.

Methods:

allow_supercritical_pressure_vaporization(...)

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

brownian_motion(*args, **kwargs)

Enable/disable Brownian motion of particles.

convective_film_heat_transfer(*args, **kwargs)

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

current_positions_in_sample_file_format(...)

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

enable_contour_plots(*args, **kwargs)

Enable contour and vector plots of particle data.

ensemble_average(*args, **kwargs)

Set ensemble average cloud properties.

erosion_accretion(*args, **kwargs)

Enable/disable erosion/accretion.

include_lwf_particles_in_dpm_concentration(...)

Include LWF particle mass in DPM Concentration.

init_erosion_accretion_rate(*args, **kwargs)

Initialize erosion/accretion rates with Zero.

lowest_volatiles_mass_fraction(*args, **kwargs)

Set the lowest volatiles mass fraction.

maximum_udf_species(*args, **kwargs)

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

particle_radiation(*args, **kwargs)

Enable/disable particle radiation.

pressure_gradient_force(*args, **kwargs)

Enable/disable pressure gradient force.

remove_wall_film_temperature_limiter(*args, ...)

Remove the wall film temperature limiter.

saffman_lift_force(*args, **kwargs)

Enable/disable Saffman lift force.

scr_urea_deposition_risk_analysis(*args, ...)

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

set_minimum_particle_diameter(*args, **kwargs)

Set the minimum particle diameter.

set_thermolysis_limit(*args, **kwargs)

Set the thermolysis limit.

stagger_radius(*args, **kwargs)

Provide a stagger radius for non atomizer injections.

stagger_spatially_atomizer_injections(*args, ...)

Spatially stagger atomizer injections?.

stagger_spatially_standard_injections(*args, ...)

Spatially stagger non-atomizer injections?.

stagger_temporally(*args, **kwargs)

Stagger transient parcels for their first time step?.

staggering_factor(*args, **kwargs)

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

step_report_sig_figures(*args, **kwargs)

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

thermophoretic_force(*args, **kwargs)

Enable/disable thermophoretic force.

track_in_absolute_frame(*args, **kwargs)

Enable/disable tracking in absolute frame.

treat_multicomponent_saturation_temperature_failure(...)

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

two_way_coupling(*args, **kwargs)

Enable/disable calculation of DPM sources in TKE equation.

uniform_mass_distribution_for_injections(...)

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

use_absolute_pressure_for_vaporization(...)

Enable/disable using Absolute Pressure for Vaporization.

vaporization_heat_transfer_averaging(*args, ...)

Enable/disable correction for Vaporization heat transfer.

vaporization_options(*args, **kwargs)

Set Vaporization options.

virtual_mass_force(*args, **kwargs)

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

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

brownian_motion(*args, **kwargs)#

Enable/disable Brownian motion of particles.

convective_film_heat_transfer(*args, **kwargs)#

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

current_positions_in_sample_file_format(*args, **kwargs)#

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

enable_contour_plots(*args, **kwargs)#

Enable contour and vector plots of particle data.

ensemble_average(*args, **kwargs)#

Set ensemble average cloud properties.

erosion_accretion(*args, **kwargs)#

Enable/disable erosion/accretion.

include_lwf_particles_in_dpm_concentration(*args, **kwargs)#

Include LWF particle mass in DPM Concentration.

init_erosion_accretion_rate(*args, **kwargs)#

Initialize erosion/accretion rates with Zero.

lowest_volatiles_mass_fraction(*args, **kwargs)#

Set the lowest volatiles mass fraction.

maximum_udf_species(*args, **kwargs)#

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

particle_radiation(*args, **kwargs)#

Enable/disable particle radiation.

pressure_gradient_force(*args, **kwargs)#

Enable/disable pressure gradient force.

remove_wall_film_temperature_limiter(*args, **kwargs)#

Remove the wall film temperature limiter.

saffman_lift_force(*args, **kwargs)#

Enable/disable Saffman lift force.

scr_urea_deposition_risk_analysis(*args, **kwargs)#

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

set_minimum_particle_diameter(*args, **kwargs)#

Set the minimum particle diameter.

set_thermolysis_limit(*args, **kwargs)#

Set the thermolysis limit.

stagger_radius(*args, **kwargs)#

Provide a stagger radius for non atomizer injections.

stagger_spatially_atomizer_injections(*args, **kwargs)#

Spatially stagger atomizer injections?.

stagger_spatially_standard_injections(*args, **kwargs)#

Spatially stagger non-atomizer injections?.

stagger_temporally(*args, **kwargs)#

Stagger transient parcels for their first time step?.

staggering_factor(*args, **kwargs)#

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

step_report_sig_figures(*args, **kwargs)#

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

thermophoretic_force(*args, **kwargs)#

Enable/disable thermophoretic force.

track_in_absolute_frame(*args, **kwargs)#

Enable/disable tracking in absolute frame.

treat_multicomponent_saturation_temperature_failure(*args, **kwargs)#

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

two_way_coupling(*args, **kwargs)#

Enable/disable calculation of DPM sources in TKE equation.

uniform_mass_distribution_for_injections(*args, **kwargs)#

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

use_absolute_pressure_for_vaporization(*args, **kwargs)#

Enable/disable using Absolute Pressure for Vaporization.

vaporization_heat_transfer_averaging(*args, **kwargs)#

Enable/disable correction for Vaporization heat transfer.

vaporization_options(*args, **kwargs)#

Set Vaporization options.

virtual_mass_force(*args, **kwargs)#

Enable/disable virtual mass force.

class parallel(path, service)#

Bases: TUIMenu

Enter the parallel menu.

Methods:

enable_workpile(*args, **kwargs)

Enable/disable the particle workpile algorithm.

fix_source_term_accumulation_order(*args, ...)

Enforce deterministic order of source term accumulation.

hybrid_2domain(*args, **kwargs)

Use DPM domain to simulate particles.

hybrid_collision_model(*args, **kwargs)

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

hybrid_collision_unidirectional(*args, **kwargs)

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

hybrid_collision_variant(*args, **kwargs)

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

hybrid_workpile(*args, **kwargs)

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

n_threads(*args, **kwargs)

Set the number of processors to use for DPM.

report(*args, **kwargs)

Print particle workpile statistics.

use_hybrid(*args, **kwargs)

Set DPM parallel-mode to hybrid.

use_message_passing(*args, **kwargs)

Set DPM parallel-mode to message passing.

use_shared_memory(*args, **kwargs)

Set DPM parallel-mode to shared memory.

Classes:

expert(path, service)

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

Enable/disable the particle workpile algorithm.

class expert(path, service)#

Bases: TUIMenu

Enter the menu to set expert DPM parallel options.

Methods:

partition_method_hybrid_2domain(*args, **kwargs)

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

Set DPM Domain partition method.

fix_source_term_accumulation_order(*args, **kwargs)#

Enforce deterministic order of source term accumulation.

hybrid_2domain(*args, **kwargs)#

Use DPM domain to simulate particles.

hybrid_collision_model(*args, **kwargs)#

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

hybrid_collision_unidirectional(*args, **kwargs)#

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

hybrid_collision_variant(*args, **kwargs)#

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

hybrid_workpile(*args, **kwargs)#

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

n_threads(*args, **kwargs)#

Set the number of processors to use for DPM.

report(*args, **kwargs)#

Print particle workpile statistics.

use_hybrid(*args, **kwargs)#

Set DPM parallel-mode to hybrid.

use_message_passing(*args, **kwargs)#

Set DPM parallel-mode to message passing.

use_shared_memory(*args, **kwargs)#

Set DPM parallel-mode to shared memory.

class splash_options(path, service)#

Bases: TUIMenu

Enter the splash options menu to set optional parameters.

Methods:

orourke_splash_fraction(*args, **kwargs)

Select splash fraction method.

splash_pdf_limiting(*args, **kwargs)

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

Select splash fraction method.

splash_pdf_limiting(*args, **kwargs)#

Select splash pdf limiting method.

spray_model(*args, **kwargs)#

Enter the spray model menu.

class stripping_options(path, service)#

Bases: TUIMenu

Enter the stripping options menu to set optional parameters.

Methods:

diameter_coefficient(*args, **kwargs)

Set the stripping diameter coefficient.

mass_coefficient(*args, **kwargs)

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

Set the stripping diameter coefficient.

mass_coefficient(*args, **kwargs)#

Set the stripping mass coefficient.

unsteady_tracking(*args, **kwargs)#

Enable/disable unsteady particle tracking.

user_defined(*args, **kwargs)#

Set DPM user-defined functions.

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

Enter the Eulerian wall film model menu.

Classes:

coupled_solution(path, service)

Enter Eulerian wall film 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)

Enable Eulerian wall film model.

film_material(*args, **kwargs)

Set film material and properties.

initialize_wallfilm_model(*args, **kwargs)

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

Set Eulerian wall film model solution options.

solve_wallfilm_equation(*args, **kwargs)

Activate Eulerian wall film equations.
class coupled_solution(path, service)#

Bases: TUIMenu

Enter Eulerian wall film coupled solution menu.

Methods:

enable_coupled_solution(*args, **kwargs)

Enable Eulerian wall film coupled solution.

enable_curvature_smoothing(*args, **kwargs)

Enable Eulerian wall film curvature smoothing.
enable_coupled_solution(*args, **kwargs)#

Enable Eulerian wall film coupled solution.

enable_curvature_smoothing(*args, **kwargs)#

Enable Eulerian wall film curvature smoothing.

enable_film_vof_transition_message(*args, **kwargs)#

Enable film-VOF transition message.

enable_wallfilm_model(*args, **kwargs)#

Enable Eulerian wall film model.

film_material(*args, **kwargs)#

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

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

Set Eulerian wall film model solution options.

solve_wallfilm_equation(*args, **kwargs)#

Activate Eulerian wall film equations.

frozen_flux(*args, **kwargs)#

Enable/disable frozen flux formulation for transient flows.

class heat_exchanger(path, service)#

Bases: TUIMenu

Enter the heat exchanger menu.

Classes:

dual_cell_model(path, service)

Enter the dual cell model menu.

macro_model(path, service)

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

Bases: TUIMenu

Enter the dual cell model menu.

Methods:

add_heat_exchanger(*args, **kwargs)

Add heat-exchanger.

alternative_formulation(*args, **kwargs)

Enable/disable alternative formulation for heat transfer calculations.

delete_heat_exchanger(*args, **kwargs)

Delete heat-exchanger.

heat_exchanger(*args, **kwargs)

Enable/disable the dual cell heat-exchanger model.

modify_heat_exchanger(*args, **kwargs)

Modify heat-exchanger.

plot_NTU(*args, **kwargs)

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

write_NTU(*args, **kwargs)

Write NTU vs primary mass flow rate for each auxiliary mass flow rate.
add_heat_exchanger(*args, **kwargs)#

Add heat-exchanger.

alternative_formulation(*args, **kwargs)#

Enable/disable alternative formulation for heat transfer calculations.

delete_heat_exchanger(*args, **kwargs)#

Delete heat-exchanger.

heat_exchanger(*args, **kwargs)#

Enable/disable the dual cell heat-exchanger model.

modify_heat_exchanger(*args, **kwargs)#

Modify heat-exchanger.

plot_NTU(*args, **kwargs)#

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

write_NTU(*args, **kwargs)#

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

class macro_model(path, service)#

Bases: TUIMenu

Enter the heat macro-model menu.

Methods:

delete_heat_exchanger_group(*args, **kwargs)

Delete heat-exchanger group.

heat_exchanger(*args, **kwargs)

Enable/disable heat-exchanger model.

heat_exchanger_group(*args, **kwargs)

Define heat-exchanger group.

heat_exchanger_macro_report(*args, **kwargs)

Report heat-exchanger information for all the macros.

heat_exchanger_model(*args, **kwargs)

Define heat-exchanger core model.

heat_exchanger_report(*args, **kwargs)

Report heat-exchanger information.

heat_exchanger_zone(*args, **kwargs)

Define heat-exchanger zone.

plot_NTU(*args, **kwargs)

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

write_NTU(*args, **kwargs)

Write NTU vs primary mass flow rate for each auxiliary mass flow rate.
delete_heat_exchanger_group(*args, **kwargs)#

Delete heat-exchanger group.

heat_exchanger(*args, **kwargs)#

Enable/disable heat-exchanger model.

heat_exchanger_group(*args, **kwargs)#

Define heat-exchanger group.

heat_exchanger_macro_report(*args, **kwargs)#

Report heat-exchanger information for all the macros.

heat_exchanger_model(*args, **kwargs)#

Define heat-exchanger core model.

heat_exchanger_report(*args, **kwargs)#

Report heat-exchanger information.

heat_exchanger_zone(*args, **kwargs)#

Define heat-exchanger zone.

plot_NTU(*args, **kwargs)#

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

write_NTU(*args, **kwargs)#

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

class multiphase(path, service)#

Bases: TUIMenu

Define multiphase model menu.

Methods:

body_force_formulation(*args, **kwargs)

Body force formulation.

coupled_level_set(*args, **kwargs)

Coupled level set.

interface_modeling_options(*args, **kwargs)

Interface Modeling Options.

mixture_parameters(*args, **kwargs)

Mixture parameters.

model(*args, **kwargs)

Specify multiphase model.

number_of_phases(*args, **kwargs)

Specify the number of phases.

regime_transition_modeling(*args, **kwargs)

Regime-transition-modeling-options.

vof_sub_models(*args, **kwargs)

VOF sub-models.

volume_fraction_parameters(*args, **kwargs)

Volume fraction parameters.

Classes:

explicit_expert_options(path, service)

Expert options for explicit formulation.

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)

Enter the population balance model menu.

sub_models(path, service)

Enter the menu to select sub-models.

wet_steam(path, service)

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

Body force formulation.

coupled_level_set(*args, **kwargs)#

Coupled level set.

class explicit_expert_options(path, service)#

Bases: TUIMenu

Expert options for explicit formulation.

Methods:

solve_vof_every_iter(*args, **kwargs)

Solve volume fraction equation every iteration for explicit formulation.

sub_time_step_method(*args, **kwargs)

Select sub-time step method for the time integration in explicit formulation.

Classes:

volume_fraction_filtering(path, service)

Advanced volume fraction filtering controls for explicit formulation.
solve_vof_every_iter(*args, **kwargs)#

Solve volume fraction equation every iteration for explicit formulation.

sub_time_step_method(*args, **kwargs)#

Select sub-time step method for the time integration in explicit formulation.

class volume_fraction_filtering(path, service)#

Bases: TUIMenu

Advanced volume fraction filtering controls for explicit formulation.

Methods:

enable(*args, **kwargs)

Enable volume fraction filtering treatment.

filtering_options(*args, **kwargs)

Select volume fraction filtering method.

vol_frac_cutoff(*args, **kwargs)

Enter node-averaged volume fraction cutoff.
enable(*args, **kwargs)#

Enable volume fraction filtering treatment.

filtering_options(*args, **kwargs)#

Select volume fraction filtering method.

vol_frac_cutoff(*args, **kwargs)#

Enter node-averaged volume fraction cutoff.

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

Interface Modeling Options.

mixture_parameters(*args, **kwargs)#

Mixture parameters.

model(*args, **kwargs)#

Specify multiphase model.

number_of_phases(*args, **kwargs)#

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

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)