multiphase#

class ansys.fluent.core.solver.tui_231.main_menu.setup.models.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)#: 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 model_transition(path, service)#

Bases: TUIMenu

Enter the menu to set model transition mechanisms.

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

Bases: TUIMenu

Enter the menu to set numerics 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.

phase_domains(*args, **kwargs)#: Enter the menu to select a specific phase domain.

class population_balance(path, service)#

Bases: TUIMenu

Enter the population balance model menu.

Classes:

`expert`(path, service)	Enter the expert menu for quadrature-based population balance method.
`phenomena`(path, service)	Enter the phenomena menu for population balance.

Methods:

`include_expansion`(args, *kwargs)	Set expansion.
`model`(args, *kwargs)	Select the population balance model.
`size_calculator`(args, *kwargs)	Calculate fluid particle diameters using different methods.

class expert(path, service)#

Bases: TUIMenu

Enter the expert menu for quadrature-based population balance method.

Classes:

qmom(path, service)

class qmom(path, service)#

Bases: TUIMenu

Methods:

`inversion_algorithm`(args, *kwargs)	Select the inversion algorithm for quadrature-based population balance method.
`print_realizable_moment_warning`(args, *kwargs)	Print the information for realizable moments in the population balance model.
`realizable_moments`(args, *kwargs)	Set the population balance model.
`retain_qmom_sources_for_low_vof`(args, *kwargs)	Retain qmom source calculation for low secondary phase vof.

inversion_algorithm(*args, **kwargs)#: Select the inversion algorithm for quadrature-based population balance method.

print_realizable_moment_warning(*args, **kwargs)#: Print the information for realizable moments in the population balance model.

realizable_moments(*args, **kwargs)#: Set the population balance model.

retain_qmom_sources_for_low_vof(*args, **kwargs)#: Retain qmom source calculation for low secondary phase vof.

include_expansion(*args, **kwargs)#: Set expansion.

model(*args, **kwargs)#: Select the population balance model.

class phenomena(path, service)#

Bases: TUIMenu

Enter the phenomena menu for population balance.

Methods:

`aggregation`(args, *kwargs)	Set the aggregation kernel.
`aggregation_factor`(args, *kwargs)	Set a factor which controls the intensity of the selected aggregation kernel.
`breakage`(args, *kwargs)	Set the breakage kernel.
`breakage_aggregation_vof_cutoff`(args, *kwargs)	Control vof cut-off for breakage and aggregation.
`breakage_factor`(args, *kwargs)	Set a factor which controls the intensity of the selected breakage kernel.
`growth`(args, *kwargs)	Set the growth rate.
`nucleation`(args, *kwargs)	Set the nucleantion rate.

aggregation(*args, **kwargs)#: Set the aggregation kernel.

aggregation_factor(*args, **kwargs)#: Set a factor which controls the intensity of the selected aggregation kernel.

breakage(*args, **kwargs)#: Set the breakage kernel.

breakage_aggregation_vof_cutoff(*args, **kwargs)#: Control vof cut-off for breakage and aggregation.

breakage_factor(*args, **kwargs)#: Set a factor which controls the intensity of the selected breakage kernel.

growth(*args, **kwargs)#: Set the growth rate.

nucleation(*args, **kwargs)#: Set the nucleantion rate.

size_calculator(*args, **kwargs)#: Calculate fluid particle diameters using different methods.

regime_transition_modeling(*args, **kwargs)#: Regime-transition-modeling-options.

class sub_models(path, service)#

Bases: TUIMenu

Enter the menu to select sub-models.

Methods:

boiling(*args, **kwargs)

Activate boiling model.

Classes:

boiling_options(path, service)

Set boiling options.

boiling(*args, **kwargs)#: Activate boiling model.

class boiling_options(path, service)#

Bases: TUIMenu

Set boiling options.

Methods:

`nlbf_model`(args, *kwargs)	Set the non-local boundary field correction.
`options`(args, *kwargs)	Choose the type of boiling model.

nlbf_model(*args, **kwargs)#: Set the non-local boundary field correction.

options(*args, **kwargs)#: Choose the type of boiling model.

vof_sub_models(*args, **kwargs)#: VOF sub-models.

volume_fraction_parameters(*args, **kwargs)#: Volume fraction parameters.

class wet_steam(path, service)#

Bases: TUIMenu

Enter the wet steam model menu.

Methods:

`compile_user_defined_wetsteam_functions`(...)	Compile user-defined wet steam library.
`enable`(args, *kwargs)	Enable/disable the wet steam model.
`load_unload_user_defined_wetsteam_library`(...)	Load or unload user-defined wet steam library.

Classes:

set(path, service)

Enter the set menu for setting wet steam model options.

compile_user_defined_wetsteam_functions(*args, **kwargs)#: Compile user-defined wet steam library.

enable(*args, **kwargs)#: Enable/disable the wet steam model.

load_unload_user_defined_wetsteam_library(*args, **kwargs)#: Load or unload user-defined wet steam library.

class set(path, service)#

Bases: TUIMenu

Enter the set menu for setting wet steam model options.

Methods:

`droplet_growth_rate`(args, *kwargs)	Select the formula to model the droplet growth rate.
`max_liquid_mass_fraction`(args, *kwargs)	Set the maximum limit on the condensed liquid-phase mass-fraction to prevent divergence.
`rgp_tables`(args, *kwargs)	Select which properties to use: build-in or from RGP tables.
`stagnation_conditions`(args, *kwargs)	If the gas phase is selected, zero wetness is assumed when evaluating total or static values of pressure and temperature.
`virial_equation`(args, *kwargs)	Select the formulation of the virial equation of state and associated equations for thermodynamic properties of steam.
`zonal_phase_change`(args, *kwargs)	Select cell zones where phase change process is active.

droplet_growth_rate(*args, **kwargs)#: Select the formula to model the droplet growth rate.

max_liquid_mass_fraction(*args, **kwargs)#: Set the maximum limit on the condensed liquid-phase mass-fraction to prevent divergence.

rgp_tables(*args, **kwargs)#: Select which properties to use: build-in or from RGP tables.

stagnation_conditions(*args, **kwargs)#: If the gas phase is selected, zero wetness is assumed when evaluating total or static values of pressure and temperature.

virial_equation(*args, **kwargs)#: Select the formulation of the virial equation of state and associated equations for thermodynamic properties of steam.

zonal_phase_change(*args, **kwargs)#: Select cell zones where phase change process is active.

`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.
`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.
`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.
`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.
`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?.