setup#

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

Bases: TUIMenu

Enter setup menu.

Classes:

boundary_conditions(path, service)

Enter the boudary conditions menu.

dynamic_mesh(path, service)

Enter the dynamic mesh menu.

expert(path, service)

Enter expert setup menu.

gap_model(path, service)

Enter the narrow-gaps menu.

materials(path, service)

Enter the materials menu.

mesh_interfaces(path, service)

Enter the mesh-interfaces menu.

mixing_planes(path, service)

Enter the mixing planes menu.

models(path, service)

Enter the models menu to configure the solver.

named_expressions(path, service)

Manage named expressions.

operating_conditions(path, service)

Enter the define operating conditions menu.

overset_interfaces(path, service)

Enter the overset-interfaces menu.

reference_frames(path, service)

Manage reference frames.

reference_values(path, service)

Reference value menu.

turbo_model(path, service)

Turbo features menu.
class boundary_conditions(path, service)#

Bases: TUIMenu

Enter the boudary conditions menu.

Methods:

axis(*args, **kwargs)

Set boundary conditions for a zone of this type.

copy_bc(*args, **kwargs)

Copy boundary conditions to another zone.

degassing(*args, **kwargs)

Set boundary conditions for a zone of this type.

exhaust_fan(*args, **kwargs)

Set boundary conditions for a zone of this type.

fan(*args, **kwargs)

Set boundary conditions for a zone of this type.

fluid(*args, **kwargs)

Set boundary conditions for a zone of this type.

geometry(*args, **kwargs)

Set boundary conditions for a zone of this type.

inlet_vent(*args, **kwargs)

Set boundary conditions for a zone of this type.

intake_fan(*args, **kwargs)

Set boundary conditions for a zone of this type.

interface(*args, **kwargs)

Set boundary conditions for a zone of this type.

interior(*args, **kwargs)

Set boundary conditions for a zone of this type.

list_zones(*args, **kwargs)

List zone IDs, types, kinds, and names.

mass_flow_inlet(*args, **kwargs)

Set boundary conditions for a zone of this type.

mass_flow_outlet(*args, **kwargs)

Set boundary conditions for a zone of this type.

network(*args, **kwargs)

Set boundary conditions for a zone of this type.

network_end(*args, **kwargs)

Set boundary conditions for a zone of this type.

outflow(*args, **kwargs)

Set boundary conditions for a zone of this type.

outlet_vent(*args, **kwargs)

Set boundary conditions for a zone of this type.

overset(*args, **kwargs)

Set boundary conditions for a zone of this type.

periodic(*args, **kwargs)

Set boundary conditions for a zone of this type.

porous_jump(*args, **kwargs)

Set boundary conditions for a zone of this type.

pressure_far_field(*args, **kwargs)

Set boundary conditions for a zone of this type.

pressure_inlet(*args, **kwargs)

Set boundary conditions for a zone of this type.

pressure_outlet(*args, **kwargs)

Set boundary conditions for a zone of this type.

radiator(*args, **kwargs)

Set boundary conditions for a zone of this type.

rans_les_interface(*args, **kwargs)

Set boundary conditions for a zone of this type.

recirculation_inlet(*args, **kwargs)

Set boundary conditions for a zone of this type.

recirculation_outlet(*args, **kwargs)

Set boundary conditions for a zone of this type.

shadow(*args, **kwargs)

Set boundary conditions for a zone of this type.

solid(*args, **kwargs)

Set boundary conditions for a zone of this type.

symmetry(*args, **kwargs)

Set boundary conditions for a zone of this type.

velocity_inlet(*args, **kwargs)

Set boundary conditions for a zone of this type.

wall(*args, **kwargs)

Set boundary conditions for a zone of this type.

zone_name(*args, **kwargs)

Give a zone a new name.

zone_type(*args, **kwargs)

Set a zone's type.

Classes:

bc_settings(path, service)

.

expert(path, service)

Enter expert bc menu.

modify_zones(path, service)

Enter the modify zones menu.

profiles(path, service)

Enter the boundary profiles menu.

query(path, service)

Enter zone query menu.

rename_zone(path, service)

Enter zone rename menu.

set(path, service)

Enter the set boundary conditions menu.
axis(*args, **kwargs)#

Set boundary conditions for a zone of this type.

class bc_settings(path, service)#

Bases: TUIMenu

.

Methods:

mass_flow(*args, **kwargs)

Select method for setting the mass flow rate.

pressure_outlet(*args, **kwargs)

Select pressure specification method on pressure-outlet boundaries.

Classes:

pressure_far_field(path, service)

Select presure-far-field boundary-condition options.
mass_flow(*args, **kwargs)#

Select method for setting the mass flow rate.

class pressure_far_field(path, service)#

Bases: TUIMenu

Select presure-far-field boundary-condition options.

Methods:

riemann_invariants_tangency_correction(...)

Apply a local correction where the flow is tangential to the boundary.

type(*args, **kwargs)

Choose pressure-far-field boundary-condition type.
riemann_invariants_tangency_correction(*args, **kwargs)#

Apply a local correction where the flow is tangential to the boundary.

type(*args, **kwargs)#

Choose pressure-far-field boundary-condition type.

pressure_outlet(*args, **kwargs)#

Select pressure specification method on pressure-outlet boundaries.

copy_bc(*args, **kwargs)#

Copy boundary conditions to another zone.

degassing(*args, **kwargs)#

Set boundary conditions for a zone of this type.

exhaust_fan(*args, **kwargs)#

Set boundary conditions for a zone of this type.

class expert(path, service)#

Bases: TUIMenu

Enter expert bc menu.

Classes:

impedance_data_fitting(path, service)

Enter the impedance data fitting menu.

non_reflecting_bc(path, service)

Enter the non-reflecting b.c.

perforated_walls(path, service)

Enter the perforated walls setting menu.

periodic_conditions(path, service)

Enter the periodic conditions menu.

Methods:

non_overlapping_zone_name(*args, **kwargs)

Get non-overlapping zone name from the associated interface zone.

open_channel_wave_settings(*args, **kwargs)

Open channel wave input analysis.

openchannel_threads(*args, **kwargs)

List open channel group IDs, names, types, and variables.

target_mass_flow_rate_settings(*args, **kwargs)

Enter the targeted mass flow rate setting menu.
class impedance_data_fitting(path, service)#

Bases: TUIMenu

Enter the impedance data fitting menu.

Methods:

absorption_data(*args, **kwargs)

Read experimental absorption coefficient data and output impedance parameters for a boundary condition.

convergence_tolerance(*args, **kwargs)

Set the convergence tolerance for the fitting algorithm.

impedance_data(*args, **kwargs)

Read experimental impedance data and output impedance parameters for a boundary condition.

import_parameters(*args, **kwargs)

Import impedance parameters into boundary condition.

iterations(*args, **kwargs)

Set the number of iterations for the fitting algorithm.

reflection_data(*args, **kwargs)

Read experimental reflection coefficient data and output impedance parameters for a boundary condition.

residue_tolerance(*args, **kwargs)

Set the residue tolerance for the fitting algorithm.

verbosity(*args, **kwargs)

Set verbosity level [0, 1] for fitting algorithm.
absorption_data(*args, **kwargs)#

Read experimental absorption coefficient data and output impedance parameters for a boundary condition.

convergence_tolerance(*args, **kwargs)#

Set the convergence tolerance for the fitting algorithm.

impedance_data(*args, **kwargs)#

Read experimental impedance data and output impedance parameters for a boundary condition.

import_parameters(*args, **kwargs)#

Import impedance parameters into boundary condition.

iterations(*args, **kwargs)#

Set the number of iterations for the fitting algorithm.

reflection_data(*args, **kwargs)#

Read experimental reflection coefficient data and output impedance parameters for a boundary condition.

residue_tolerance(*args, **kwargs)#

Set the residue tolerance for the fitting algorithm.

verbosity(*args, **kwargs)#

Set verbosity level [0, 1] for fitting algorithm.

non_overlapping_zone_name(*args, **kwargs)#

Get non-overlapping zone name from the associated interface zone.

class non_reflecting_bc(path, service)#

Bases: TUIMenu

Enter the non-reflecting b.c. menu.

Classes:

general_nrbc(path, service)

Enter the menu for setting general non-reflecting boundary conditions.

turbo_specific_nrbc(path, service)

Enter the turbo-specific n.r.b.c.
class general_nrbc(path, service)#

Bases: TUIMenu

Enter the menu for setting general non-reflecting boundary conditions.

Classes:

set(path, service)

Enter the general non-reflecting b.c.
class set(path, service)#

Bases: TUIMenu

Enter the general non-reflecting b.c. menu.

Methods:

relax(*args, **kwargs)

Set NRBC relaxation factor (default value 0.5).

sigma(*args, **kwargs)

Set nrbc sigma factor (default value 0.15).

sigma2(*args, **kwargs)

Set nrbc sigma2 factor (default value 5.0).

tangential_source(*args, **kwargs)

Include or not NRBC tangential source (default value #t).

verbosity(*args, **kwargs)

Print boundary equations convergence info.
relax(*args, **kwargs)#

Set NRBC relaxation factor (default value 0.5).

sigma(*args, **kwargs)#

Set nrbc sigma factor (default value 0.15).

sigma2(*args, **kwargs)#

Set nrbc sigma2 factor (default value 5.0).

tangential_source(*args, **kwargs)#

Include or not NRBC tangential source (default value #t).

verbosity(*args, **kwargs)#

Print boundary equations convergence info.

class turbo_specific_nrbc(path, service)#

Bases: TUIMenu

Enter the turbo-specific n.r.b.c. menu.

Methods:

enable(*args, **kwargs)

Enable/disable turbo-specific non-reflecting b.c.'s.

initialize(*args, **kwargs)

Initialize turbo-specific non-reflecting b.c.'s.

show_status(*args, **kwargs)

Show current status of turbo-specific non-reflecting b.c.'s.

Classes:

set(path, service)

Enter the set menu for turbo-specific non-reflecting b.c.
enable(*args, **kwargs)#

Enable/disable turbo-specific non-reflecting b.c.’s.

initialize(*args, **kwargs)#

Initialize turbo-specific non-reflecting b.c.’s.

class set(path, service)#

Bases: TUIMenu

Enter the set menu for turbo-specific non-reflecting b.c. parameters.

Methods:

discretization(*args, **kwargs)

Enable use of higher-order reconstruction at boundaries if available.

under_relaxation(*args, **kwargs)

Set turbo-specific non-reflecting b.c.

verbosity(*args, **kwargs)

Set turbo-specific non-reflecting b.c.
discretization(*args, **kwargs)#

Enable use of higher-order reconstruction at boundaries if available.

under_relaxation(*args, **kwargs)#

Set turbo-specific non-reflecting b.c. under-relaxation factor. specify < 0 => use P/a_ave specify = 0 => use 1/N specify > 0 => use specified.

verbosity(*args, **kwargs)#

Set turbo-specific non-reflecting b.c. verbosity level. 0 : silent 1 : basic info. default 2 : detailed info. for debugging .

show_status(*args, **kwargs)#

Show current status of turbo-specific non-reflecting b.c.’s.

open_channel_wave_settings(*args, **kwargs)#

Open channel wave input analysis.

openchannel_threads(*args, **kwargs)#

List open channel group IDs, names, types, and variables.

class perforated_walls(path, service)#

Bases: TUIMenu

Enter the perforated walls setting menu.

Methods:

model_setup(*args, **kwargs)

Set up perforated walls.

read_input_file(*args, **kwargs)

Read an input file.
model_setup(*args, **kwargs)#

Set up perforated walls.

read_input_file(*args, **kwargs)#

Read an input file.

class periodic_conditions(path, service)#

Bases: TUIMenu

Enter the periodic conditions menu.

Methods:

massflow_rate_specification(*args, **kwargs)

Enable/disable specification of mass flow rate at the periodic boundary.

pressure_gradient_specification(*args, **kwargs)

Enable/disable specification of pressure gradient at the periodic boundary.
massflow_rate_specification(*args, **kwargs)#

Enable/disable specification of mass flow rate at the periodic boundary.

pressure_gradient_specification(*args, **kwargs)#

Enable/disable specification of pressure gradient at the periodic boundary.

target_mass_flow_rate_settings(*args, **kwargs)#

Enter the targeted mass flow rate setting menu.

fan(*args, **kwargs)#

Set boundary conditions for a zone of this type.

fluid(*args, **kwargs)#

Set boundary conditions for a zone of this type.

geometry(*args, **kwargs)#

Set boundary conditions for a zone of this type.

inlet_vent(*args, **kwargs)#

Set boundary conditions for a zone of this type.

intake_fan(*args, **kwargs)#

Set boundary conditions for a zone of this type.

interface(*args, **kwargs)#

Set boundary conditions for a zone of this type.

interior(*args, **kwargs)#

Set boundary conditions for a zone of this type.

list_zones(*args, **kwargs)#

List zone IDs, types, kinds, and names.

mass_flow_inlet(*args, **kwargs)#

Set boundary conditions for a zone of this type.

mass_flow_outlet(*args, **kwargs)#

Set boundary conditions for a zone of this type.

class modify_zones(path, service)#

Bases: TUIMenu

Enter the modify zones menu.

Methods:

activate_cell_zone(*args, **kwargs)

Activate a cell thread.

append_mesh(*args, **kwargs)

Append new mesh.

append_mesh_data(*args, **kwargs)

Append new mesh with data.

change_zone_phase(*args, **kwargs)

Change the realgas phase for a zone.

change_zone_state(*args, **kwargs)

Change the realgas material state for a zone.

convert_all_solid_mrf_to_solid_motion(*args, ...)

Change all solid zones motion specification from MRF to solid motion.

copy_mesh_to_mrf_motion(*args, **kwargs)

Copy motion variable values for origin, axis and velocities from Mesh Motion to Frame Motion.

copy_move_cell_zone(*args, **kwargs)

Copy and translate or rotate a cell zone.

copy_mrf_to_mesh_motion(*args, **kwargs)

Copy motion variable values for origin, axis and velocities from Frame Motion to Mesh Motion.

create_all_shell_threads(*args, **kwargs)

Mark all finite thickness wall for shell creation.

create_periodic_interface(*args, **kwargs)

Create a conformal or non-conformal periodic interface.

deactivate_cell_zone(*args, **kwargs)

Deactivate cell thread.

delete_all_shells(*args, **kwargs)

Delete all shell zones and switch off shell conduction on all the walls.

delete_cell_zone(*args, **kwargs)

Delete a cell thread.

extrude_face_zone_delta(*args, **kwargs)

Extrude a face thread a specified distance based on a list of deltas.

extrude_face_zone_para(*args, **kwargs)

Extrude a face thread a specified distance based on a distance and a list of parametric locations between 0 and 1 (eg.

fuse_face_zones(*args, **kwargs)

Attempt to fuse zones by removing duplicate faces and nodes.

list_zones(*args, **kwargs)

List zone IDs, types, kinds, and names.

make_periodic(*args, **kwargs)

Attempt to establish conformal periodic face zone connectivity.

matching_tolerance(*args, **kwargs)

Set the normalized tolerance used for finding coincident nodes.

merge_zones(*args, **kwargs)

Merge zones of the same type and condition into one.

mrf_to_sliding_mesh(*args, **kwargs)

Change motion specification from MRF to moving mesh.

orient_face_zone(*args, **kwargs)

Orient the face zone.

recreate_all_shells(*args, **kwargs)

Create shell on all the walls where which were deleted using the command delete-all-shells.

replace_zone(*args, **kwargs)

Replace a cell zone.

rotate_zone(*args, **kwargs)

Rotate nodal coordinates of input cell zones.

scale_zone(*args, **kwargs)

Scale nodal coordinates of input cell zones.

sep_cell_zone_mark(*args, **kwargs)

Separate a cell zone based on cell marking.

sep_cell_zone_region(*args, **kwargs)

Separate a cell zone based on contiguous regions.

sep_face_zone_angle(*args, **kwargs)

Separate a face zone based on significant angle.

sep_face_zone_face(*args, **kwargs)

Separate each face in a zone into unique zone.

sep_face_zone_mark(*args, **kwargs)

Separate a face zone based on cell marking.

sep_face_zone_region(*args, **kwargs)

Separate a face zone based on contiguous regions.

slit_face_zone(*args, **kwargs)

Slit a two-sided wall into two connected wall zones.

slit_interior_between_diff_solids(*args, ...)

Slit interior created between different solids into coupled walls.

slit_periodic(*args, **kwargs)

Slit a periodic zone into two symmetry zones.

translate_zone(*args, **kwargs)

Translate nodal coordinates of input cell zones.

zone_name(*args, **kwargs)

Give a zone a new name.

zone_type(*args, **kwargs)

Set a zone's type.
activate_cell_zone(*args, **kwargs)#

Activate a cell thread.

append_mesh(*args, **kwargs)#

Append new mesh.

append_mesh_data(*args, **kwargs)#

Append new mesh with data.

change_zone_phase(*args, **kwargs)#

Change the realgas phase for a zone.

change_zone_state(*args, **kwargs)#

Change the realgas material state for a zone.

convert_all_solid_mrf_to_solid_motion(*args, **kwargs)#

Change all solid zones motion specification from MRF to solid motion.

copy_mesh_to_mrf_motion(*args, **kwargs)#

Copy motion variable values for origin, axis and velocities from Mesh Motion to Frame Motion.

copy_move_cell_zone(*args, **kwargs)#

Copy and translate or rotate a cell zone.

copy_mrf_to_mesh_motion(*args, **kwargs)#

Copy motion variable values for origin, axis and velocities from Frame Motion to Mesh Motion.

create_all_shell_threads(*args, **kwargs)#

Mark all finite thickness wall for shell creation. Shell zones will be created at the start of iterations.

create_periodic_interface(*args, **kwargs)#

Create a conformal or non-conformal periodic interface.

deactivate_cell_zone(*args, **kwargs)#

Deactivate cell thread.

delete_all_shells(*args, **kwargs)#

Delete all shell zones and switch off shell conduction on all the walls. These zones can be recreated using the command recreate-all-shells.

delete_cell_zone(*args, **kwargs)#

Delete a cell thread.

extrude_face_zone_delta(*args, **kwargs)#

Extrude a face thread a specified distance based on a list of deltas.

extrude_face_zone_para(*args, **kwargs)#

Extrude a face thread a specified distance based on a distance and a list of parametric locations between 0 and 1 (eg. 0 0.2 0.4 0.8 1.0).

fuse_face_zones(*args, **kwargs)#

Attempt to fuse zones by removing duplicate faces and nodes.

list_zones(*args, **kwargs)#

List zone IDs, types, kinds, and names.

make_periodic(*args, **kwargs)#

Attempt to establish conformal periodic face zone connectivity.

matching_tolerance(*args, **kwargs)#

Set the normalized tolerance used for finding coincident nodes.

merge_zones(*args, **kwargs)#

Merge zones of the same type and condition into one.

mrf_to_sliding_mesh(*args, **kwargs)#

Change motion specification from MRF to moving mesh.

orient_face_zone(*args, **kwargs)#

Orient the face zone.

recreate_all_shells(*args, **kwargs)#

Create shell on all the walls where which were deleted using the command delete-all-shells.

replace_zone(*args, **kwargs)#

Replace a cell zone.

rotate_zone(*args, **kwargs)#

Rotate nodal coordinates of input cell zones.

scale_zone(*args, **kwargs)#

Scale nodal coordinates of input cell zones.

sep_cell_zone_mark(*args, **kwargs)#

Separate a cell zone based on cell marking.

sep_cell_zone_region(*args, **kwargs)#

Separate a cell zone based on contiguous regions.

sep_face_zone_angle(*args, **kwargs)#

Separate a face zone based on significant angle.

sep_face_zone_face(*args, **kwargs)#

Separate each face in a zone into unique zone.

sep_face_zone_mark(*args, **kwargs)#

Separate a face zone based on cell marking.

sep_face_zone_region(*args, **kwargs)#

Separate a face zone based on contiguous regions.

slit_face_zone(*args, **kwargs)#

Slit a two-sided wall into two connected wall zones.

slit_interior_between_diff_solids(*args, **kwargs)#

Slit interior created between different solids into coupled walls.

slit_periodic(*args, **kwargs)#

Slit a periodic zone into two symmetry zones.

translate_zone(*args, **kwargs)#

Translate nodal coordinates of input cell zones.

zone_name(*args, **kwargs)#

Give a zone a new name.

zone_type(*args, **kwargs)#

Set a zone’s type.

network(*args, **kwargs)#

Set boundary conditions for a zone of this type.

network_end(*args, **kwargs)#

Set boundary conditions for a zone of this type.

outflow(*args, **kwargs)#

Set boundary conditions for a zone of this type.

outlet_vent(*args, **kwargs)#

Set boundary conditions for a zone of this type.

overset(*args, **kwargs)#

Set boundary conditions for a zone of this type.

periodic(*args, **kwargs)#

Set boundary conditions for a zone of this type.

porous_jump(*args, **kwargs)#

Set boundary conditions for a zone of this type.

pressure_far_field(*args, **kwargs)#

Set boundary conditions for a zone of this type.

pressure_inlet(*args, **kwargs)#

Set boundary conditions for a zone of this type.

pressure_outlet(*args, **kwargs)#

Set boundary conditions for a zone of this type.

class profiles(path, service)#

Bases: TUIMenu

Enter the boundary profiles menu.

Methods:

delete(*args, **kwargs)

Delete a profile.

delete_all(*args, **kwargs)

Delete all boundary-profiles.

display_profile_point_cloud_data(*args, **kwargs)

Display Profile Point Cloud Data.

display_profile_surface(*args, **kwargs)

Display a profile.

interpolation_method(*args, **kwargs)

Choose the method for interpolation of profiles.

link_profile_to_reference_frame(*args, **kwargs)

Link profile to a reference frame.

list_profile_fields(*args, **kwargs)

List the fields of a particular profile.

list_profile_parameters(*args, **kwargs)

List the parameters of a particular profile.

list_profiles(*args, **kwargs)

List all profiles.

morphing(*args, **kwargs)

Enable/disable profile morphing options in Orient Profile panel.

orient_profile(*args, **kwargs)

Orient Profile.

overlay_profile_point_cloud_data(*args, **kwargs)

Overlay Profile Point Cloud Data.

overlay_profile_surface(*args, **kwargs)

Overlay Profile Surface.

replicate_profile(*args, **kwargs)

Replicate Profile.

set_preference_profile_point_cloud_data(...)

Set Preference Profile Point Cloud Data e.g., Point marker symbol,size,color.

update_interval(*args, **kwargs)

Set interval between updates of dynamic profiles.
delete(*args, **kwargs)#

Delete a profile.

delete_all(*args, **kwargs)#

Delete all boundary-profiles.

display_profile_point_cloud_data(*args, **kwargs)#

Display Profile Point Cloud Data.

display_profile_surface(*args, **kwargs)#

Display a profile.

interpolation_method(*args, **kwargs)#

Choose the method for interpolation of profiles.

Link profile to a reference frame.

list_profile_fields(*args, **kwargs)#

List the fields of a particular profile.

list_profile_parameters(*args, **kwargs)#

List the parameters of a particular profile.

list_profiles(*args, **kwargs)#

List all profiles.

morphing(*args, **kwargs)#

Enable/disable profile morphing options in Orient Profile panel.

orient_profile(*args, **kwargs)#

Orient Profile.

overlay_profile_point_cloud_data(*args, **kwargs)#

Overlay Profile Point Cloud Data.

overlay_profile_surface(*args, **kwargs)#

Overlay Profile Surface.

replicate_profile(*args, **kwargs)#

Replicate Profile.

set_preference_profile_point_cloud_data(*args, **kwargs)#

Set Preference Profile Point Cloud Data e.g., Point marker symbol,size,color.

update_interval(*args, **kwargs)#

Set interval between updates of dynamic profiles.

class query(path, service)#

Bases: TUIMenu

Enter zone query menu.

Methods:

axis(*args, **kwargs)

Show boundary conditions for a zone of this type.

degassing(*args, **kwargs)

Show boundary conditions for a zone of this type.

delete_query(*args, **kwargs)

Delete saved query.

exhaust_fan(*args, **kwargs)

Show boundary conditions for a zone of this type.

fan(*args, **kwargs)

Show boundary conditions for a zone of this type.

fluid(*args, **kwargs)

Show boundary conditions for a zone of this type.

geometry(*args, **kwargs)

Show boundary conditions for a zone of this type.

inlet_vent(*args, **kwargs)

Show boundary conditions for a zone of this type.

intake_fan(*args, **kwargs)

Show boundary conditions for a zone of this type.

interface(*args, **kwargs)

Show boundary conditions for a zone of this type.

interior(*args, **kwargs)

Show boundary conditions for a zone of this type.

list_boundary_conditions(*args, **kwargs)

List boundary conditions.

list_cell_zone_conditions(*args, **kwargs)

List cell zone conditions.

list_named_selection(*args, **kwargs)

List named selection of zone type.

list_queries(*args, **kwargs)

List all saved queries.

mass_flow_inlet(*args, **kwargs)

Show boundary conditions for a zone of this type.

mass_flow_outlet(*args, **kwargs)

Show boundary conditions for a zone of this type.

named_zone_list(*args, **kwargs)

Create named list of zones.

network(*args, **kwargs)

Show boundary conditions for a zone of this type.

network_end(*args, **kwargs)

Show boundary conditions for a zone of this type.

outflow(*args, **kwargs)

Show boundary conditions for a zone of this type.

outlet_vent(*args, **kwargs)

Show boundary conditions for a zone of this type.

overset(*args, **kwargs)

Show boundary conditions for a zone of this type.

periodic(*args, **kwargs)

Show boundary conditions for a zone of this type.

porous_jump(*args, **kwargs)

Show boundary conditions for a zone of this type.

pressure_far_field(*args, **kwargs)

Show boundary conditions for a zone of this type.

pressure_inlet(*args, **kwargs)

Show boundary conditions for a zone of this type.

pressure_outlet(*args, **kwargs)

Show boundary conditions for a zone of this type.

radiator(*args, **kwargs)

Show boundary conditions for a zone of this type.

rans_les_interface(*args, **kwargs)

Show boundary conditions for a zone of this type.

recirculation_inlet(*args, **kwargs)

Show boundary conditions for a zone of this type.

recirculation_outlet(*args, **kwargs)

Show boundary conditions for a zone of this type.

shadow(*args, **kwargs)

Show boundary conditions for a zone of this type.

solid(*args, **kwargs)

Show boundary conditions for a zone of this type.

symmetry(*args, **kwargs)

Show boundary conditions for a zone of this type.

velocity_inlet(*args, **kwargs)

Show boundary conditions for a zone of this type.

wall(*args, **kwargs)

Show boundary conditions for a zone of this type.
axis(*args, **kwargs)#

Show boundary conditions for a zone of this type.

degassing(*args, **kwargs)#

Show boundary conditions for a zone of this type.

delete_query(*args, **kwargs)#

Delete saved query.

exhaust_fan(*args, **kwargs)#

Show boundary conditions for a zone of this type.

fan(*args, **kwargs)#

Show boundary conditions for a zone of this type.

fluid(*args, **kwargs)#

Show boundary conditions for a zone of this type.

geometry(*args, **kwargs)#

Show boundary conditions for a zone of this type.

inlet_vent(*args, **kwargs)#

Show boundary conditions for a zone of this type.

intake_fan(*args, **kwargs)#

Show boundary conditions for a zone of this type.

interface(*args, **kwargs)#

Show boundary conditions for a zone of this type.

interior(*args, **kwargs)#

Show boundary conditions for a zone of this type.

list_boundary_conditions(*args, **kwargs)#

List boundary conditions.

list_cell_zone_conditions(*args, **kwargs)#

List cell zone conditions.

list_named_selection(*args, **kwargs)#

List named selection of zone type.

list_queries(*args, **kwargs)#

List all saved queries.

mass_flow_inlet(*args, **kwargs)#

Show boundary conditions for a zone of this type.

mass_flow_outlet(*args, **kwargs)#

Show boundary conditions for a zone of this type.

named_zone_list(*args, **kwargs)#

Create named list of zones.

network(*args, **kwargs)#

Show boundary conditions for a zone of this type.

network_end(*args, **kwargs)#

Show boundary conditions for a zone of this type.

outflow(*args, **kwargs)#

Show boundary conditions for a zone of this type.

outlet_vent(*args, **kwargs)#

Show boundary conditions for a zone of this type.

overset(*args, **kwargs)#

Show boundary conditions for a zone of this type.

periodic(*args, **kwargs)#

Show boundary conditions for a zone of this type.

porous_jump(*args, **kwargs)#

Show boundary conditions for a zone of this type.

pressure_far_field(*args, **kwargs)#

Show boundary conditions for a zone of this type.

pressure_inlet(*args, **kwargs)#

Show boundary conditions for a zone of this type.

pressure_outlet(*args, **kwargs)#

Show boundary conditions for a zone of this type.

radiator(*args, **kwargs)#

Show boundary conditions for a zone of this type.

rans_les_interface(*args, **kwargs)#

Show boundary conditions for a zone of this type.

recirculation_inlet(*args, **kwargs)#

Show boundary conditions for a zone of this type.

recirculation_outlet(*args, **kwargs)#

Show boundary conditions for a zone of this type.

shadow(*args, **kwargs)#

Show boundary conditions for a zone of this type.

solid(*args, **kwargs)#

Show boundary conditions for a zone of this type.

symmetry(*args, **kwargs)#

Show boundary conditions for a zone of this type.

velocity_inlet(*args, **kwargs)#

Show boundary conditions for a zone of this type.

wall(*args, **kwargs)#

Show boundary conditions for a zone of this type.

radiator(*args, **kwargs)#

Set boundary conditions for a zone of this type.

rans_les_interface(*args, **kwargs)#

Set boundary conditions for a zone of this type.

recirculation_inlet(*args, **kwargs)#

Set boundary conditions for a zone of this type.

recirculation_outlet(*args, **kwargs)#

Set boundary conditions for a zone of this type.

class rename_zone(path, service)#

Bases: TUIMenu

Enter zone rename menu.

Methods:

add_suffix_or_prefix(*args, **kwargs)

Add suffix or prefix to zone name.

rename_by_adjacency(*args, **kwargs)

Rename zone to adjacent zones.

rename_to_default(*args, **kwargs)

Rename zone to default name.
add_suffix_or_prefix(*args, **kwargs)#

Add suffix or prefix to zone name.

rename_by_adjacency(*args, **kwargs)#

Rename zone to adjacent zones.

rename_to_default(*args, **kwargs)#

Rename zone to default name.

class set(path, service)#

Bases: TUIMenu

Enter the set boundary conditions menu.

Methods:

axis(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

degassing(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

exhaust_fan(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

fan(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

fluid(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

geometry(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

inlet_vent(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

intake_fan(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

interface(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

interior(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

mass_flow_inlet(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

mass_flow_outlet(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

network(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

network_end(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

outflow(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

outlet_vent(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

overset(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

periodic(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

porous_jump(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

pressure_far_field(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

pressure_inlet(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

pressure_outlet(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

radiator(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

rans_les_interface(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

recirculation_inlet(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

recirculation_outlet(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

shadow(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

solid(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

symmetry(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

velocity_inlet(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

wall(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.
axis(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

degassing(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

exhaust_fan(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

fan(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

fluid(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

geometry(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

inlet_vent(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

intake_fan(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

interface(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

interior(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

mass_flow_inlet(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

mass_flow_outlet(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

network(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

network_end(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

outflow(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

outlet_vent(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

overset(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

periodic(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

porous_jump(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

pressure_far_field(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

pressure_inlet(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

pressure_outlet(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

radiator(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

rans_les_interface(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

recirculation_inlet(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

recirculation_outlet(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

shadow(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

solid(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

symmetry(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

velocity_inlet(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

wall(*args, **kwargs)#

Set boundary conditions for a zone or multiple zones of this type.

shadow(*args, **kwargs)#

Set boundary conditions for a zone of this type.

solid(*args, **kwargs)#

Set boundary conditions for a zone of this type.

symmetry(*args, **kwargs)#

Set boundary conditions for a zone of this type.

velocity_inlet(*args, **kwargs)#

Set boundary conditions for a zone of this type.

wall(*args, **kwargs)#

Set boundary conditions for a zone of this type.

zone_name(*args, **kwargs)#

Give a zone a new name.

zone_type(*args, **kwargs)#

Set a zone’s type.

class dynamic_mesh(path, service)#

Bases: TUIMenu

Enter the dynamic mesh menu.

Classes:

actions(path, service)

Enter the dynamic mesh actions menu.

controls(path, service)

Enter the dynamic mesh control menu.

events(path, service)

Enter the dynamic mesh events menu.

transient_settings(path, service)

Enter the dynamic mesh transient settings menu.

zones(path, service)

Enter the dynamic mesh zones menu.

Methods:

dynamic_mesh(*args, **kwargs)

Enable/disable the dynamic mesh solver and options.
class actions(path, service)#

Bases: TUIMenu

Enter the dynamic mesh actions menu.

Methods:

remesh_cell_zone(*args, **kwargs)

Manually remesh cell zone with option to remesh adjacent dynamic face zones.
remesh_cell_zone(*args, **kwargs)#

Manually remesh cell zone with option to remesh adjacent dynamic face zones.

class controls(path, service)#

Bases: TUIMenu

Enter the dynamic mesh control menu.

Classes:

contact_parameters(path, service)

Enter the dynamic mesh contact detection menu.

implicit_update_parameters(path, service)

Enter the dynamic mesh implicit update menu.

in_cylinder_parameters(path, service)

Enter the dynamic mesh in-cylinder menu.

layering_parameters(path, service)

Enter the dynamic mesh layering menu.

periodic_displacement_parameters(path, service)

Enter the dynamic mesh periodic displacement menu.

remeshing_parameters(path, service)

Enter the dynamic mesh remeshing menu.

six_dof_parameters(path, service)

Enter the dynamic mesh six-dof menu.

smoothing_parameters(path, service)

Enter the dynamic mesh smoothing menu.

Methods:

in_cylinder_output(*args, **kwargs)

Enable/disable in-cylinder output.

layering(*args, **kwargs)

Enable/disable dynamic-layering in quad/hex cell zones.

remeshing(*args, **kwargs)

Enable/disable local remeshing in tri/tet and mixed cell zones.

smoothing(*args, **kwargs)

Enable/disable dynamic mesh smoothing.

steady_pseudo_time_control(*args, **kwargs)

Enable/disable pseudo time step control in user interface.
class contact_parameters(path, service)#

Bases: TUIMenu

Enter the dynamic mesh contact detection menu.

Methods:

contact_face_zones(*args, **kwargs)

Select face zones involved in contact detection.

contact_method(*args, **kwargs)

Select the method used for flow control in the contact region.

contact_threshold(*args, **kwargs)

Specify threshold distance for contact detection.

contact_udf(*args, **kwargs)

Select UDF to be invoked when contact is detected.

flow_control(*args, **kwargs)

Enable/disable flow control.

render_contact_cells(*args, **kwargs)

Set the option to include contact-cells in post-processing.

update_contact_marks(*args, **kwargs)

Update which cells are marked in order to block flow in the contact region.

verbosity(*args, **kwargs)

Set the verbosity for contact-detection.

Classes:

flow_control_parameters(path, service)

Enter the flow control menu.
contact_face_zones(*args, **kwargs)#

Select face zones involved in contact detection.

contact_method(*args, **kwargs)#

Select the method used for flow control in the contact region.

contact_threshold(*args, **kwargs)#

Specify threshold distance for contact detection.

contact_udf(*args, **kwargs)#

Select UDF to be invoked when contact is detected.

flow_control(*args, **kwargs)#

Enable/disable flow control.

class flow_control_parameters(path, service)#

Bases: TUIMenu

Enter the flow control menu.

Methods:

create_flow_control_zone(*args, **kwargs)

Create a flow control zone.

delete_flow_control_zone(*args, **kwargs)

Delete a flow control zone.

solution_stabilization(*args, **kwargs)

Enable/disable the performance of additional iterations per time step and the application of solution controls to improve the stability of the solver.
create_flow_control_zone(*args, **kwargs)#

Create a flow control zone.

delete_flow_control_zone(*args, **kwargs)#

Delete a flow control zone.

solution_stabilization(*args, **kwargs)#

Enable/disable the performance of additional iterations per time step and the application of solution controls to improve the stability of the solver.

render_contact_cells(*args, **kwargs)#

Set the option to include contact-cells in post-processing.

update_contact_marks(*args, **kwargs)#

Update which cells are marked in order to block flow in the contact region.

verbosity(*args, **kwargs)#

Set the verbosity for contact-detection.

class implicit_update_parameters(path, service)#

Bases: TUIMenu

Enter the dynamic mesh implicit update menu.

Methods:

motion_relaxation(*args, **kwargs)

Specify motion relaxation of implicit update.

residual_criteria(*args, **kwargs)

Specify residual criteria of implicit update.

update_interval(*args, **kwargs)

Specify update interval of implicit update.
motion_relaxation(*args, **kwargs)#

Specify motion relaxation of implicit update.

residual_criteria(*args, **kwargs)#

Specify residual criteria of implicit update.

update_interval(*args, **kwargs)#

Specify update interval of implicit update.

in_cylinder_output(*args, **kwargs)#

Enable/disable in-cylinder output.

class in_cylinder_parameters(path, service)#

Bases: TUIMenu

Enter the dynamic mesh in-cylinder menu.

Methods:

crank_angle_step(*args, **kwargs)

Specify the crank angle step size.

crank_period(*args, **kwargs)

Specify the crank period.

max_crank_angle_step(*args, **kwargs)

Specify the maximum crank angle step size.

minimum_lift(*args, **kwargs)

Specify the minimum lift for in-cylinder valves.

modify_lift(*args, **kwargs)

Modify the lift curve (shift or scale).

piston_data(*args, **kwargs)

Specify the crank radius, connecting rod length, and piston pin offset.

piston_stroke_cutoff(*args, **kwargs)

Specify the cut off point for in-cylinder piston.

position_starting_mesh(*args, **kwargs)

Move mesh from top dead center to starting crank angle.

print_plot_lift(*args, **kwargs)

Print or plot valve lift curve.

starting_crank_angle(*args, **kwargs)

Specify the starting crank angle.
crank_angle_step(*args, **kwargs)#

Specify the crank angle step size.

crank_period(*args, **kwargs)#

Specify the crank period.

max_crank_angle_step(*args, **kwargs)#

Specify the maximum crank angle step size.

minimum_lift(*args, **kwargs)#

Specify the minimum lift for in-cylinder valves.

modify_lift(*args, **kwargs)#

Modify the lift curve (shift or scale).

piston_data(*args, **kwargs)#

Specify the crank radius, connecting rod length, and piston pin offset.

piston_stroke_cutoff(*args, **kwargs)#

Specify the cut off point for in-cylinder piston.

position_starting_mesh(*args, **kwargs)#

Move mesh from top dead center to starting crank angle.

print_plot_lift(*args, **kwargs)#

Print or plot valve lift curve.

starting_crank_angle(*args, **kwargs)#

Specify the starting crank angle.

layering(*args, **kwargs)#

Enable/disable dynamic-layering in quad/hex cell zones.

class layering_parameters(path, service)#

Bases: TUIMenu

Enter the dynamic mesh layering menu.

Methods:

collapse_factor(*args, **kwargs)

Set the factor determining when to collapse dynamic layers.

constant_height(*args, **kwargs)

Enable/disable layering based on constant height, else layering based on constant ratio.

split_factor(*args, **kwargs)

Set the factor determining when to split dynamic layers.
collapse_factor(*args, **kwargs)#

Set the factor determining when to collapse dynamic layers.

constant_height(*args, **kwargs)#

Enable/disable layering based on constant height, else layering based on constant ratio.

split_factor(*args, **kwargs)#

Set the factor determining when to split dynamic layers.

class periodic_displacement_parameters(path, service)#

Bases: TUIMenu

Enter the dynamic mesh periodic displacement menu.

Methods:

copy_displacement(*args, **kwargs)

Copy Periodic Displacement.

create_displacement(*args, **kwargs)

Create Periodic Displacement.

create_group(*args, **kwargs)

Create Periodic Displacement Group.

delete_all_displacements(*args, **kwargs)

Delete All Periodic Displacements.

delete_all_groups(*args, **kwargs)

Delete All Periodic Displacement Groups.

delete_displacement(*args, **kwargs)

Delete Periodic Displacement.

delete_group(*args, **kwargs)

Delete Periodic Displacement Group.

edit_displacement(*args, **kwargs)

Edit Periodic Displacement.

edit_group(*args, **kwargs)

Edit Periodic Displacement Group.

list_displacements(*args, **kwargs)

List Periodic Displacements.

list_groups(*args, **kwargs)

List Periodic Displacement Groups.

set_active_displacement(*args, **kwargs)

Set Active Periodic Displacement in Group.
copy_displacement(*args, **kwargs)#

Copy Periodic Displacement.

create_displacement(*args, **kwargs)#

Create Periodic Displacement.

create_group(*args, **kwargs)#

Create Periodic Displacement Group.

delete_all_displacements(*args, **kwargs)#

Delete All Periodic Displacements.

delete_all_groups(*args, **kwargs)#

Delete All Periodic Displacement Groups.

delete_displacement(*args, **kwargs)#

Delete Periodic Displacement.

delete_group(*args, **kwargs)#

Delete Periodic Displacement Group.

edit_displacement(*args, **kwargs)#

Edit Periodic Displacement.

edit_group(*args, **kwargs)#

Edit Periodic Displacement Group.

list_displacements(*args, **kwargs)#

List Periodic Displacements.

list_groups(*args, **kwargs)#

List Periodic Displacement Groups.

set_active_displacement(*args, **kwargs)#

Set Active Periodic Displacement in Group.

remeshing(*args, **kwargs)#

Enable/disable local remeshing in tri/tet and mixed cell zones.

class remeshing_parameters(path, service)#

Bases: TUIMenu

Enter the dynamic mesh remeshing menu.

Methods:

cell_skew_max(*args, **kwargs)

Set the cell skewness threshold above which cells will be remeshed.

face_skew_max(*args, **kwargs)

Set the face skewness threshold above which faces will be remeshed.

length_max(*args, **kwargs)

Set the length threshold above which cells will be remeshed.

length_min(*args, **kwargs)

Set the length threshold below which cells will be remeshed.

parallel_remeshing(*args, **kwargs)

Enable/disable parallel remeshing for zone remeshing.

poly_remeshing(*args, **kwargs)

Enable/disable poly remeshing.

remeshing_after_moving(*args, **kwargs)

Enable/disable optional remeshing after mesh motion to meet skewness threshold.

remeshing_methods(*args, **kwargs)

Enable/disable remeshing methods.

retain_size_distribution(*args, **kwargs)

Enable/disable retaining of size distribution.

size_remesh_interval(*args, **kwargs)

Set the interval (in time steps) when remeshing based on size is done.

sizing_funct_defaults(*args, **kwargs)

Set sizing function defaults.

sizing_funct_rate(*args, **kwargs)

Determine how far from the boundary the increase/decrease happens.

sizing_funct_resolution(*args, **kwargs)

Set the sizing function resolution with respect to shortest boundary.

sizing_funct_variation(*args, **kwargs)

Set the maximum sizing function increase/decrease in the interior.

sizing_function(*args, **kwargs)

Enable/disable sizing function to control size based remeshing.

unified_remeshing(*args, **kwargs)

Enable/disable unified remeshing.

zone_remeshing(*args, **kwargs)

Enable/disable cell zone remeshing method.

Classes:

prism_controls(path, service)

Specify optional prism controls.

prism_layer_parameters(path, service)

Enter the dynamic mesh prism remeshing menu.

sizing_controls(path, service)

Specify optional sizing controls.
cell_skew_max(*args, **kwargs)#

Set the cell skewness threshold above which cells will be remeshed.

face_skew_max(*args, **kwargs)#

Set the face skewness threshold above which faces will be remeshed.

length_max(*args, **kwargs)#

Set the length threshold above which cells will be remeshed.

length_min(*args, **kwargs)#

Set the length threshold below which cells will be remeshed.

parallel_remeshing(*args, **kwargs)#

Enable/disable parallel remeshing for zone remeshing.

poly_remeshing(*args, **kwargs)#

Enable/disable poly remeshing.

class prism_controls(path, service)#

Bases: TUIMenu

Specify optional prism controls.

Methods:

add(*args, **kwargs)

Add a new object.

delete(*args, **kwargs)

Delete an object.

edit(*args, **kwargs)

Edit an object.

list(*args, **kwargs)

List objects.

list_properties(*args, **kwargs)

List properties of an object.
add(*args, **kwargs)#

Add a new object.

delete(*args, **kwargs)#

Delete an object.

edit(*args, **kwargs)#

Edit an object.

list(*args, **kwargs)#

List objects.

list_properties(*args, **kwargs)#

List properties of an object.

class prism_layer_parameters(path, service)#

Bases: TUIMenu

Enter the dynamic mesh prism remeshing menu.

Methods:

first_height(*args, **kwargs)

Set first cell height in the prism layer.

growth_rate(*args, **kwargs)

Set the geometric growth rate of the prism layer.

number_of_layers(*args, **kwargs)

Set the number of elements in the prism layer.
first_height(*args, **kwargs)#

Set first cell height in the prism layer.

growth_rate(*args, **kwargs)#

Set the geometric growth rate of the prism layer.

number_of_layers(*args, **kwargs)#

Set the number of elements in the prism layer.

remeshing_after_moving(*args, **kwargs)#

Enable/disable optional remeshing after mesh motion to meet skewness threshold. Steady state dynamic mesh only.

remeshing_methods(*args, **kwargs)#

Enable/disable remeshing methods.

retain_size_distribution(*args, **kwargs)#

Enable/disable retaining of size distribution.

size_remesh_interval(*args, **kwargs)#

Set the interval (in time steps) when remeshing based on size is done.

class sizing_controls(path, service)#

Bases: TUIMenu

Specify optional sizing controls.

Methods:

add(*args, **kwargs)

Add a new object.

delete(*args, **kwargs)

Delete an object.

edit(*args, **kwargs)

Edit an object.

list(*args, **kwargs)

List objects.

list_properties(*args, **kwargs)

List properties of an object.
add(*args, **kwargs)#

Add a new object.

delete(*args, **kwargs)#

Delete an object.

edit(*args, **kwargs)#

Edit an object.

list(*args, **kwargs)#

List objects.

list_properties(*args, **kwargs)#

List properties of an object.

sizing_funct_defaults(*args, **kwargs)#

Set sizing function defaults.

sizing_funct_rate(*args, **kwargs)#

Determine how far from the boundary the increase/decrease happens.

sizing_funct_resolution(*args, **kwargs)#

Set the sizing function resolution with respect to shortest boundary.

sizing_funct_variation(*args, **kwargs)#

Set the maximum sizing function increase/decrease in the interior.

sizing_function(*args, **kwargs)#

Enable/disable sizing function to control size based remeshing.

unified_remeshing(*args, **kwargs)#

Enable/disable unified remeshing.

zone_remeshing(*args, **kwargs)#

Enable/disable cell zone remeshing method.

class six_dof_parameters(path, service)#

Bases: TUIMenu

Enter the dynamic mesh six-dof menu.

Methods:

create_properties(*args, **kwargs)

Create a set of Six DOF Properties.

delete_properties(*args, **kwargs)

Delete a set of Six DOF Properties.

list_properties(*args, **kwargs)

List Six DOF Properties.

motion_history(*args, **kwargs)

Enable/disable writing position/orientation of six DOF zones to file.

motion_history_file_name(*args, **kwargs)

Location of six DOF motion history file.

second_order(*args, **kwargs)

Enable/disable second order six DOF solver.

x_component_of_gravity(*args, **kwargs)

Specify x-component-of-gravity.

y_component_of_gravity(*args, **kwargs)

Specify y-component-of-gravity.

z_component_of_gravity(*args, **kwargs)

Specify z-component-of-gravity.
create_properties(*args, **kwargs)#

Create a set of Six DOF Properties.

delete_properties(*args, **kwargs)#

Delete a set of Six DOF Properties.

list_properties(*args, **kwargs)#

List Six DOF Properties.

motion_history(*args, **kwargs)#

Enable/disable writing position/orientation of six DOF zones to file.

motion_history_file_name(*args, **kwargs)#

Location of six DOF motion history file.

second_order(*args, **kwargs)#

Enable/disable second order six DOF solver.

x_component_of_gravity(*args, **kwargs)#

Specify x-component-of-gravity.

y_component_of_gravity(*args, **kwargs)#

Specify y-component-of-gravity.

z_component_of_gravity(*args, **kwargs)#

Specify z-component-of-gravity.

smoothing(*args, **kwargs)#

Enable/disable dynamic mesh smoothing.

class smoothing_parameters(path, service)#

Bases: TUIMenu

Enter the dynamic mesh smoothing menu.

Methods:

amg_stabilization(*args, **kwargs)

Set the AMG stabilization method for mesh smoothing (FEM).

bnd_node_relaxation(*args, **kwargs)

Set the spring boundary node relaxation factor.

bnd_stiffness_factor(*args, **kwargs)

Set the stiffness factor for springs connected to boundary nodes.

boundary_distance_method(*args, **kwargs)

Set the method used to evaluate the boundary distance for the diffusion coefficient calculation.

constant_factor(*args, **kwargs)

Set the spring constant relaxation factor.

convergence_tolerance(*args, **kwargs)

Set the convergence tolerance for spring-based solver.

diffusion_coeff_function(*args, **kwargs)

Specify whether the diffusion coefficient is based on the boundary distance or the cell volume.

diffusion_coeff_parameter(*args, **kwargs)

Set the diffusion coefficient parameter used for diffusion-based smoothing.

diffusion_fvm(*args, **kwargs)

Set the numerical method used for diffusion-based smoothing.

laplace_node_relaxation(*args, **kwargs)

Set the Laplace boundary node relaxation factor.

max_iter(*args, **kwargs)

Set the maximum number of iterations for spring-based solver.

poisson_ratio(*args, **kwargs)

Set the Poisson's ratio used by the linearly elastic solid model.

relative_convergence_tolerance(*args, **kwargs)

Set the relative residual convergence tolerance for diffusion-based (FVM) smoothing.

skew_smooth_all_deforming_boundaries(*args, ...)

Enable/disable skewness smoothing for all deforming dynamic boundary zones.

skew_smooth_cell_skew_max(*args, **kwargs)

Set the cell skewness threshold above which cells will be smoothed using the skewness method.

skew_smooth_face_skew_max(*args, **kwargs)

Set the face skewness threshold above which deforming boundary faces will be smoothed using the skewness method.

skew_smooth_niter(*args, **kwargs)

Set the number of skewness-based smoothing cycles.

smooth_from_reference_position(*args, **kwargs)

Enable smoothing from reference position.

smoothing_method(*args, **kwargs)

Specify the smoothing method used by the dynamic mesh model.

spring_on_all_elements(*args, **kwargs)

Enable/disable spring-based smoothing for all cell shapes.

spring_on_simplex_elements(*args, **kwargs)

Enable/disable spring-based smoothing for tri/tet elements in mixed element zones.

verbosity(*args, **kwargs)

Set the verbosity for spring smoothing.
amg_stabilization(*args, **kwargs)#

Set the AMG stabilization method for mesh smoothing (FEM).

bnd_node_relaxation(*args, **kwargs)#

Set the spring boundary node relaxation factor.

bnd_stiffness_factor(*args, **kwargs)#

Set the stiffness factor for springs connected to boundary nodes.

boundary_distance_method(*args, **kwargs)#

Set the method used to evaluate the boundary distance for the diffusion coefficient calculation.

constant_factor(*args, **kwargs)#

Set the spring constant relaxation factor.

convergence_tolerance(*args, **kwargs)#

Set the convergence tolerance for spring-based solver.

diffusion_coeff_function(*args, **kwargs)#

Specify whether the diffusion coefficient is based on the boundary distance or the cell volume.

diffusion_coeff_parameter(*args, **kwargs)#

Set the diffusion coefficient parameter used for diffusion-based smoothing.

diffusion_fvm(*args, **kwargs)#

Set the numerical method used for diffusion-based smoothing.

laplace_node_relaxation(*args, **kwargs)#

Set the Laplace boundary node relaxation factor.

max_iter(*args, **kwargs)#

Set the maximum number of iterations for spring-based solver.

poisson_ratio(*args, **kwargs)#

Set the Poisson’s ratio used by the linearly elastic solid model.

relative_convergence_tolerance(*args, **kwargs)#

Set the relative residual convergence tolerance for diffusion-based (FVM) smoothing.

skew_smooth_all_deforming_boundaries(*args, **kwargs)#

Enable/disable skewness smoothing for all deforming dynamic boundary zones. If disabled, only the deforming dynamic boundary zones are smoothed which have smoothing explicitly enabled or use local face remeshing.

skew_smooth_cell_skew_max(*args, **kwargs)#

Set the cell skewness threshold above which cells will be smoothed using the skewness method.

skew_smooth_face_skew_max(*args, **kwargs)#

Set the face skewness threshold above which deforming boundary faces will be smoothed using the skewness method.

skew_smooth_niter(*args, **kwargs)#

Set the number of skewness-based smoothing cycles.

smooth_from_reference_position(*args, **kwargs)#

Enable smoothing from reference position.

smoothing_method(*args, **kwargs)#

Specify the smoothing method used by the dynamic mesh model.

spring_on_all_elements(*args, **kwargs)#

Enable/disable spring-based smoothing for all cell shapes.

spring_on_simplex_elements(*args, **kwargs)#

Enable/disable spring-based smoothing for tri/tet elements in mixed element zones.

verbosity(*args, **kwargs)#

Set the verbosity for spring smoothing.

steady_pseudo_time_control(*args, **kwargs)#

Enable/disable pseudo time step control in user interface.

dynamic_mesh(*args, **kwargs)#

Enable/disable the dynamic mesh solver and options.

class events(path, service)#

Bases: TUIMenu

Enter the dynamic mesh events menu.

Methods:

export_event_file(*args, **kwargs)

Export dynamic mesh events to file.

import_event_file(*args, **kwargs)

Import dynamic mesh event file.
export_event_file(*args, **kwargs)#

Export dynamic mesh events to file.

import_event_file(*args, **kwargs)#

Import dynamic mesh event file.

class transient_settings(path, service)#

Bases: TUIMenu

Enter the dynamic mesh transient settings menu.

Methods:

allow_second_order(*args, **kwargs)

Enable/disable 2nd order transient scheme for dynamic mesh cases.

verbosity(*args, **kwargs)

Enable/disable transient scheme verbosity for dynamic mesh cases.
allow_second_order(*args, **kwargs)#

Enable/disable 2nd order transient scheme for dynamic mesh cases.

verbosity(*args, **kwargs)#

Enable/disable transient scheme verbosity for dynamic mesh cases.

class zones(path, service)#

Bases: TUIMenu

Enter the dynamic mesh zones menu.

Methods:

create(*args, **kwargs)

Create dynamic zone.

delete(*args, **kwargs)

Delete dynamic zone.

insert_boundary_layer(*args, **kwargs)

Insert new cell zone.

insert_interior_layer(*args, **kwargs)

Insert new layer cell zone at specified location.

list(*args, **kwargs)

List dynamic zones.

remove_boundary_layer(*args, **kwargs)

Remove cell zone.

remove_interior_layer(*args, **kwargs)

Remove interior layer cell zone.
create(*args, **kwargs)#

Create dynamic zone.

delete(*args, **kwargs)#

Delete dynamic zone.

insert_boundary_layer(*args, **kwargs)#

Insert new cell zone.

insert_interior_layer(*args, **kwargs)#

Insert new layer cell zone at specified location.

list(*args, **kwargs)#

List dynamic zones.

remove_boundary_layer(*args, **kwargs)#

Remove cell zone.

remove_interior_layer(*args, **kwargs)#

Remove interior layer cell zone.

class expert(path, service)#

Bases: TUIMenu

Enter expert setup menu.

Methods:

beta_feature_access(*args, **kwargs)

Enable access to beta features in the interface.

enable_mesh_morpher_optimizer(*args, **kwargs)

Enable use of mesh morpher/optimizer.

heterogeneous_stiff_chemistry(*args, **kwargs)

Set heterogeneous stiff-chemistry solver.

stiff_chemistry(*args, **kwargs)

Set solver options for stiff-chemistry solutions.

Classes:

spectral(path, service)

Enter the Spectral menu.
beta_feature_access(*args, **kwargs)#

Enable access to beta features in the interface.

enable_mesh_morpher_optimizer(*args, **kwargs)#

Enable use of mesh morpher/optimizer.

heterogeneous_stiff_chemistry(*args, **kwargs)#

Set heterogeneous stiff-chemistry solver.

class spectral(path, service)#

Bases: TUIMenu

Enter the Spectral menu.

Methods:

calculate_fourier_coefficients(*args, **kwargs)

Calculates Fourier coefficient data.

calculate_harmonic_exports(*args, **kwargs)

Calculates Harmonic Export data.

delete_fourier_coefficients(*args, **kwargs)

Deletes Fourier coefficient data.

delete_harmonic_exports(*args, **kwargs)

Deletes Harmonic Export data.
calculate_fourier_coefficients(*args, **kwargs)#

Calculates Fourier coefficient data.

calculate_harmonic_exports(*args, **kwargs)#

Calculates Harmonic Export data.

delete_fourier_coefficients(*args, **kwargs)#

Deletes Fourier coefficient data.

delete_harmonic_exports(*args, **kwargs)#

Deletes Harmonic Export data.

stiff_chemistry(*args, **kwargs)#

Set solver options for stiff-chemistry solutions.

class gap_model(path, service)#

Bases: TUIMenu

Enter the narrow-gaps menu.

Classes:

advanced_options(path, service)

Show options.

Methods:

create(*args, **kwargs)

Create a gap object.

delete(*args, **kwargs)

Delete an exiting gap object.

delete_all(*args, **kwargs)

Delete all of the exiting gap objects.

edit(*args, **kwargs)

Edit an exiting gap object.

enable(*args, **kwargs)

Enable/Disable gap model.

list_gap_cell_zones(*args, **kwargs)

List name of the gap cells zones that can be used as exclided cell zones in gaps creation.

list_gap_face_zones(*args, **kwargs)

List name of the gap face zones that can be used for gaps creation.

list_gap_regions(*args, **kwargs)

List gap regions.

render_gap_regions(*args, **kwargs)

Update gap regions for postprocessing.
class advanced_options(path, service)#

Bases: TUIMenu

Show options.

Methods:

alternative_marking(*args, **kwargs)

Mark gap regions using an alternative marking algorithm.

cell_check_distance_factor(*args, **kwargs)

Enter value of the cell distance factor.

check_cfl_condition(*args, **kwargs)

Check time step size for better convergence.

clear_gap_regions(*args, **kwargs)

Clear gap model solution information and marks.

enhanced_data_interpolation(*args, **kwargs)

Use enhanced data interpolation for updating information in gap regions.

expert(*args, **kwargs)

Enable expert options for gap model.

extend_gap_regions(*args, **kwargs)

Extend gap regions for better convergence.

fill_data_in_gap_regions(*args, **kwargs)

Interpolate solution data into the whole gap regions.

flow_blocking_stabilization_parameters(...)

Adjust stabilization settings for the sponge layer used for blocked gap regions.

include_coupled_walls(*args, **kwargs)

Include coupled walls in gap face zones.

precise_gap_marking(*args, **kwargs)

Mark cells in gap regions using more accurate search algorithm.

reduce_gap_regions(*args, **kwargs)

Using a more restrictive algorithm for marking cells in gap regions.

render_flow_modeling_gaps(*args, **kwargs)

Render solution inside flow modeling gap cells.

render_gap_interface(*args, **kwargs)

Render gap interface.

revert_controls_to_default(*args, **kwargs)

Revert gap stabilization and any related solver settings to default.

solution_stabilization(*args, **kwargs)

Set solution stabilization level for gap model.

sponge_layer(*args, **kwargs)

Set advanced settings for gap sponge layer.

update_gap_regions(*args, **kwargs)

Update gap regions and gap model solution information.

verbosity(*args, **kwargs)

Set the verbosity for gap model.
alternative_marking(*args, **kwargs)#

Mark gap regions using an alternative marking algorithm.

cell_check_distance_factor(*args, **kwargs)#

Enter value of the cell distance factor.

check_cfl_condition(*args, **kwargs)#

Check time step size for better convergence.

clear_gap_regions(*args, **kwargs)#

Clear gap model solution information and marks.

enhanced_data_interpolation(*args, **kwargs)#

Use enhanced data interpolation for updating information in gap regions.

expert(*args, **kwargs)#

Enable expert options for gap model.

extend_gap_regions(*args, **kwargs)#

Extend gap regions for better convergence.

fill_data_in_gap_regions(*args, **kwargs)#

Interpolate solution data into the whole gap regions.

flow_blocking_stabilization_parameters(*args, **kwargs)#

Adjust stabilization settings for the sponge layer used for blocked gap regions.

include_coupled_walls(*args, **kwargs)#

Include coupled walls in gap face zones.

precise_gap_marking(*args, **kwargs)#

Mark cells in gap regions using more accurate search algorithm.

reduce_gap_regions(*args, **kwargs)#

Using a more restrictive algorithm for marking cells in gap regions.

render_flow_modeling_gaps(*args, **kwargs)#

Render solution inside flow modeling gap cells.

render_gap_interface(*args, **kwargs)#

Render gap interface.

revert_controls_to_default(*args, **kwargs)#

Revert gap stabilization and any related solver settings to default.

solution_stabilization(*args, **kwargs)#

Set solution stabilization level for gap model.

sponge_layer(*args, **kwargs)#

Set advanced settings for gap sponge layer.

update_gap_regions(*args, **kwargs)#

Update gap regions and gap model solution information.

verbosity(*args, **kwargs)#

Set the verbosity for gap model.

create(*args, **kwargs)#

Create a gap object.

delete(*args, **kwargs)#

Delete an exiting gap object.

delete_all(*args, **kwargs)#

Delete all of the exiting gap objects.

edit(*args, **kwargs)#

Edit an exiting gap object.

enable(*args, **kwargs)#

Enable/Disable gap model.

list_gap_cell_zones(*args, **kwargs)#

List name of the gap cells zones that can be used as exclided cell zones in gaps creation.

list_gap_face_zones(*args, **kwargs)#

List name of the gap face zones that can be used for gaps creation.

list_gap_regions(*args, **kwargs)#

List gap regions.

render_gap_regions(*args, **kwargs)#

Update gap regions for postprocessing.

class materials(path, service)#

Bases: TUIMenu

Enter the materials menu.

Methods:

change_create(*args, **kwargs)

Change the properties of a locally-stored material or create a new material.

copy(*args, **kwargs)

Copy a material from the database.

copy_by_formula(*args, **kwargs)

Copy a material from the database by formula.

delete(*args, **kwargs)

Delete a material from local storage.

list_materials(*args, **kwargs)

List all locally-stored materials.

list_properties(*args, **kwargs)

List the properties of a locally-stored material.

Classes:

data_base(path, service)

Enter the database menu.
change_create(*args, **kwargs)#

Change the properties of a locally-stored material or create a new material.

copy(*args, **kwargs)#

Copy a material from the database.

copy_by_formula(*args, **kwargs)#

Copy a material from the database by formula.

class data_base(path, service)#

Bases: TUIMenu

Enter the database menu.

Methods:

database_type(*args, **kwargs)

Set the database type.

edit(*args, **kwargs)

Edit a material.

list_materials(*args, **kwargs)

List all materials in the database.

list_properties(*args, **kwargs)

List the properties of a material in the database.

new(*args, **kwargs)

Define a new material.

save(*args, **kwargs)

Save user-defined database.
database_type(*args, **kwargs)#

Set the database type.

edit(*args, **kwargs)#

Edit a material.

list_materials(*args, **kwargs)#

List all materials in the database.

list_properties(*args, **kwargs)#

List the properties of a material in the database.

new(*args, **kwargs)#

Define a new material.

save(*args, **kwargs)#

Save user-defined database.

delete(*args, **kwargs)#

Delete a material from local storage.

list_materials(*args, **kwargs)#

List all locally-stored materials.

list_properties(*args, **kwargs)#

List the properties of a locally-stored material.

class mesh_interfaces(path, service)#

Bases: TUIMenu

Enter the mesh-interfaces menu.

Classes:

auto_options(path, service)

Enter auto-options menu.

mapped_interface_options(path, service)

Enter the mapped-interface-options menu.

non_conformal_interface_numerics(path, service)

Setting non-conformal numerics options.

Methods:

auto_pairing(*args, **kwargs)

Automatically pair and create mesh interfaces for some or all interface zones.

create(*args, **kwargs)

Create a mesh interface.

delete(*args, **kwargs)

Delete a mesh interface.

delete_all(*args, **kwargs)

Delete all mesh interfaces.

display(*args, **kwargs)

Display specified mesh interface zone.

edit(*args, **kwargs)

Edit a mesh interface.

enable_si_with_nodes(*args, **kwargs)

Enable sliding interfaces with nodes.

enable_visualization_of_interfaces(*args, ...)

Display facets on mesh interfaces.

enforce_continuity_after_bc(*args, **kwargs)

Across the interface, enforces continuity over boundary condition.

enforce_coupled_wall_between_solids(*args, ...)

Create coupled wall interface between solids.

improve_quality(*args, **kwargs)

Improve mesh interface quality.

list(*args, **kwargs)

List all mesh-interfaces.

make_periodic(*args, **kwargs)

Make interface zones periodic.

make_phaselag_from_boundaries(*args, **kwargs)

Make interface zones phase lagged.

make_phaselag_from_periodic(*args, **kwargs)

Convert periodic interface to phase lagged.

non_overlapping_zone_name(*args, **kwargs)

Get non-overlapping zone name from the associated interface zone.

one_to_one_pairing(*args, **kwargs)

Use the default one-to-one interface creation method?.

remove_left_handed_interface_faces(*args, ...)

Remove left-handed faces during mesh interface creation.

transfer_motion_across_interfaces(*args, ...)

Transfer motion from one side of the interface to the other when only one side undergoes user-defined or system-coupling motion.

turbo_create(*args, **kwargs)

Create a general turbo interface.

verbosity(*args, **kwargs)

Set mesh interface verbosity.
class auto_options(path, service)#

Bases: TUIMenu

Enter auto-options menu.

Methods:

keep_empty_interface(*args, **kwargs)

Keep empty interfaces during one-to-one mesh interface creation.

naming_option(*args, **kwargs)

Specify whether or not to include an informative suffix to the mesh interface name.

pairing_between_different_cell_zones_only(...)

Pairing between interface zones from different cell zones only.

pairing_between_interface_zones_only(*args, ...)

Pairing between interface zones only.

proximity_tolerance(*args, **kwargs)

Specification of auto pairing tolerance.

set_default_name_prefix(*args, **kwargs)

Specification of auto pairing default name prefix.

set_one_to_one_pairing_tolerance(*args, **kwargs)

Enable/disable one-to-one auto pairing tolerance.
keep_empty_interface(*args, **kwargs)#

Keep empty interfaces during one-to-one mesh interface creation.

naming_option(*args, **kwargs)#

Specify whether or not to include an informative suffix to the mesh interface name.

pairing_between_different_cell_zones_only(*args, **kwargs)#

Pairing between interface zones from different cell zones only.

pairing_between_interface_zones_only(*args, **kwargs)#

Pairing between interface zones only.

proximity_tolerance(*args, **kwargs)#

Specification of auto pairing tolerance.

set_default_name_prefix(*args, **kwargs)#

Specification of auto pairing default name prefix.

set_one_to_one_pairing_tolerance(*args, **kwargs)#

Enable/disable one-to-one auto pairing tolerance.

auto_pairing(*args, **kwargs)#

Automatically pair and create mesh interfaces for some or all interface zones.

create(*args, **kwargs)#

Create a mesh interface.

delete(*args, **kwargs)#

Delete a mesh interface.

delete_all(*args, **kwargs)#

Delete all mesh interfaces.

display(*args, **kwargs)#

Display specified mesh interface zone.

edit(*args, **kwargs)#

Edit a mesh interface.

enable_si_with_nodes(*args, **kwargs)#

Enable sliding interfaces with nodes.

enable_visualization_of_interfaces(*args, **kwargs)#

Display facets on mesh interfaces.

enforce_continuity_after_bc(*args, **kwargs)#

Across the interface, enforces continuity over boundary condition.

enforce_coupled_wall_between_solids(*args, **kwargs)#

Create coupled wall interface between solids.

improve_quality(*args, **kwargs)#

Improve mesh interface quality.

list(*args, **kwargs)#

List all mesh-interfaces.

make_periodic(*args, **kwargs)#

Make interface zones periodic.

make_phaselag_from_boundaries(*args, **kwargs)#

Make interface zones phase lagged.

make_phaselag_from_periodic(*args, **kwargs)#

Convert periodic interface to phase lagged.

class mapped_interface_options(path, service)#

Bases: TUIMenu

Enter the mapped-interface-options menu.

Methods:

convert_to_mapped_interface(*args, **kwargs)

Convert non-conformal mesh interface to mapped mesh interfaces.

solution_controls(*args, **kwargs)

Specification of mapped frequency and under-relaxation factor for mapped interfaces.

tolerance(*args, **kwargs)

Specification of mapped interface tolerance.
convert_to_mapped_interface(*args, **kwargs)#

Convert non-conformal mesh interface to mapped mesh interfaces.

solution_controls(*args, **kwargs)#

Specification of mapped frequency and under-relaxation factor for mapped interfaces.

tolerance(*args, **kwargs)#

Specification of mapped interface tolerance.

class non_conformal_interface_numerics(path, service)#

Bases: TUIMenu

Setting non-conformal numerics options.

Methods:

change_numerics(*args, **kwargs)

Enable modified non-conformal interface numerics.
change_numerics(*args, **kwargs)#

Enable modified non-conformal interface numerics.

non_overlapping_zone_name(*args, **kwargs)#

Get non-overlapping zone name from the associated interface zone.

one_to_one_pairing(*args, **kwargs)#

Use the default one-to-one interface creation method?.

remove_left_handed_interface_faces(*args, **kwargs)#

Remove left-handed faces during mesh interface creation.

transfer_motion_across_interfaces(*args, **kwargs)#

Transfer motion from one side of the interface to the other when only one side undergoes user-defined or system-coupling motion.

turbo_create(*args, **kwargs)#

Create a general turbo interface.

verbosity(*args, **kwargs)#

Set mesh interface verbosity.

class mixing_planes(path, service)#

Bases: TUIMenu

Enter the mixing planes menu.

Methods:

create(*args, **kwargs)

Create a mixing plane.

delete(*args, **kwargs)

Delete a mixing plane.

list(*args, **kwargs)

List defined mixing plane(s).

Classes:

set(path, service)

Enter the mixing plane set menu.
create(*args, **kwargs)#

Create a mixing plane.

delete(*args, **kwargs)#

Delete a mixing plane.

list(*args, **kwargs)#

List defined mixing plane(s).

class set(path, service)#

Bases: TUIMenu

Enter the mixing plane set menu.

Methods:

averaging_method(*args, **kwargs)

Set mixing plane profile averaging method.

fix_pressure_level(*args, **kwargs)

Set fix pressure level using define/reference-pressure-location.

under_relaxation(*args, **kwargs)

Set mixing plane under-relaxation factor.

Classes:

conserve_swirl(path, service)

Enter the mixing plane conserve-swirl menu.

conserve_total_enthalpy(path, service)

Enter the menu to set total enthalpy conservation in mixing plane menu.
averaging_method(*args, **kwargs)#

Set mixing plane profile averaging method.

class conserve_swirl(path, service)#

Bases: TUIMenu

Enter the mixing plane conserve-swirl menu.

Methods:

enable(*args, **kwargs)

Enable/disable swirl conservation in mixing plane.

report_swirl_integration(*args, **kwargs)

Report swirl integration (torque) on inflow and outflow zones.

verbosity(*args, **kwargs)

Enable/disable verbosity in swirl conservation calculations.
enable(*args, **kwargs)#

Enable/disable swirl conservation in mixing plane.

report_swirl_integration(*args, **kwargs)#

Report swirl integration (torque) on inflow and outflow zones.

verbosity(*args, **kwargs)#

Enable/disable verbosity in swirl conservation calculations.

class conserve_total_enthalpy(path, service)#

Bases: TUIMenu

Enter the menu to set total enthalpy conservation in mixing plane menu.

Methods:

enable(*args, **kwargs)

Enable/disable total enthalpy conservation in mixing plane.

verbosity(*args, **kwargs)

Enable/disable verbosity in total-enthalpy conservation calculations.
enable(*args, **kwargs)#

Enable/disable total enthalpy conservation in mixing plane.

verbosity(*args, **kwargs)#

Enable/disable verbosity in total-enthalpy conservation calculations.

fix_pressure_level(*args, **kwargs)#

Set fix pressure level using define/reference-pressure-location.

under_relaxation(*args, **kwargs)#

Set mixing plane under-relaxation factor.

class models(path, service)#

Bases: TUIMenu

Enter the models menu to configure the solver.

Methods:

ablation(*args, **kwargs)

Enable/disable ablation model.

addon_module(*args, **kwargs)

Load addon module.

axisymmetric(*args, **kwargs)

Enable/disable the axisymmetric model.

battery_model(*args, **kwargs)

Enter battery model menu.

crevice_model(*args, **kwargs)

Enable/disable the crevice model.

crevice_model_controls(*args, **kwargs)

Enter the crevice model controls menu.

energy(*args, **kwargs)

Enable/disable the energy model.

frozen_flux(*args, **kwargs)

Enable/disable frozen flux formulation for transient flows.

noniterative_time_advance(*args, **kwargs)

Enable/disable the noniterative time advancement scheme.

nox(*args, **kwargs)

Enable/disable the NOx model.

potential_and_li_ion_battery(*args, **kwargs)

Enable/disable the electric-potential model.

solidification_melting(*args, **kwargs)

Enable/disable the solidification and melting model.

soot(*args, **kwargs)

Enable/disable the soot model.

steady(*args, **kwargs)

Enable/disable the steady solution model.

swirl(*args, **kwargs)

Enable/disable axisymmetric swirl velocity.

unsteady_1st_order(*args, **kwargs)

Enable/disable first-order unsteady solution model.

unsteady_2nd_order(*args, **kwargs)

Enable/disable the second-order unsteady solution model.

unsteady_2nd_order_bounded(*args, **kwargs)

Enable/disable bounded second-order unsteady formulation.

unsteady_global_time(*args, **kwargs)

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

unsteady_structure_euler(*args, **kwargs)

Enable/disable Backward Euler unsteady solution model.

unsteady_structure_newmark(*args, **kwargs)

Enable/disable Newmark unsteady solution model.

vbm(*args, **kwargs)

Enable/disable Virtual Blade Model.

virtual_blade_model(*args, **kwargs)

Enter VBM model menu.

Classes:

acoustics(path, service)

Enter the acoustics model menu.

cht(path, service)

Enter the mapped interface model menu.

dpm(path, service)

Enter the dispersed phase model menu.

electrolysis(path, service)

Enter the electrolysis model setup menu.

eulerian_wallfilm(path, service)

Enter the Eulerian wall film model menu.

heat_exchanger(path, service)

Enter the heat exchanger menu.

multiphase(path, service)

Define multiphase model menu.

nox_parameters(path, service)

Enter the NOx parameters menu.

optics(path, service)

Enter the optics model menu.

radiation(path, service)

Enter the radiation models menu.

shell_conduction(path, service)

Enter the shell conduction model menu.

solver(path, service)

Enter the menu to select the solver.

soot_parameters(path, service)

Enter the soot parameters menu.

species(path, service)

Enter the species models menu.

structure(path, service)

Enter the structure model menu.

system_coupling_settings(path, service)

Enter the system coupling model menu.

two_temperature(path, service)

Define two-temperature model menu.

viscous(path, service)

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

Enable/disable ablation model.

class acoustics(path, service)#

Bases: TUIMenu

Enter the acoustics model menu.

Methods:

acoustic_modal_analysis(*args, **kwargs)

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

auto_prune(*args, **kwargs)

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

broad_band_noise(*args, **kwargs)

Enable/disable the broadband noise model.

compute_write(*args, **kwargs)

Compute sound pressure.

convective_effects(*args, **kwargs)

Enable/disable convective effects option.

cylindrical_export(*args, **kwargs)

Enable/disable the export data in cylindrical coordinates.

display_flow_time(*args, **kwargs)

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

display_frequencies(*args, **kwargs)

Display resonance frequencies.

export_source_data(*args, **kwargs)

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

export_source_data_cgns(*args, **kwargs)

Export acoustic source data in CGNS format.

export_volumetric_sources(*args, **kwargs)

Enable/disable the export of fluid zones.

export_volumetric_sources_cgns(*args, **kwargs)

Enable/disable the export of fluid zones.

ffowcs_williams(*args, **kwargs)

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

modal_analysis(*args, **kwargs)

Enable/disable the modal analysis model.

moving_receiver(*args, **kwargs)

Enable/disable moving receiver option.

off(*args, **kwargs)

Enable/disable the acoustics model.

read_compute_write(*args, **kwargs)

Read acoustic source data files and compute sound pressure.

receivers(*args, **kwargs)

Set acoustic receivers.

sources(*args, **kwargs)

Set acoustic sources.

wave_equation(*args, **kwargs)

Enable/disable the wave equation model.

write_acoustic_signals(*args, **kwargs)

Write on-the-fly sound pressure.

write_centroid_info(*args, **kwargs)

Write centroid info.

Classes:

far_field_parameters(path, service)

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

sources_fft(path, service)

Enter the acoustic sources FFT menu.

sponge_layers(path, service)

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

wave_equation_options(path, service)

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

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

auto_prune(*args, **kwargs)#

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

broad_band_noise(*args, **kwargs)#

Enable/disable the broadband noise model.

compute_write(*args, **kwargs)#

Compute sound pressure.

convective_effects(*args, **kwargs)#

Enable/disable convective effects option.

cylindrical_export(*args, **kwargs)#

Enable/disable the export data in cylindrical coordinates.

display_flow_time(*args, **kwargs)#

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

display_frequencies(*args, **kwargs)#

Display resonance frequencies.

export_source_data(*args, **kwargs)#

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

export_source_data_cgns(*args, **kwargs)#

Export acoustic source data in CGNS format.

export_volumetric_sources(*args, **kwargs)#

Enable/disable the export of fluid zones.

export_volumetric_sources_cgns(*args, **kwargs)#

Enable/disable the export of fluid zones.

class far_field_parameters(path, service)#

Bases: TUIMenu

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

Methods:

far_field_density(*args, **kwargs)

Specify far field density.

far_field_sound_speed(*args, **kwargs)

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

Specify far field density.

far_field_sound_speed(*args, **kwargs)#

Specify far field speed of sound.

ffowcs_williams(*args, **kwargs)#

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

modal_analysis(*args, **kwargs)#

Enable/disable the modal analysis model.

moving_receiver(*args, **kwargs)#

Enable/disable moving receiver option.

off(*args, **kwargs)#

Enable/disable the acoustics model.

read_compute_write(*args, **kwargs)#

Read acoustic source data files and compute sound pressure.

receivers(*args, **kwargs)#

Set acoustic receivers.

sources(*args, **kwargs)#

Set acoustic sources.

class sources_fft(path, service)#

Bases: TUIMenu

Enter the acoustic sources FFT menu.

Methods:

clean_up_storage_area(*args, **kwargs)

Clean up storage area.

compute_fft_fields(*args, **kwargs)

Compute FFT fields.

read_asd_files(*args, **kwargs)

Read ASD files.

write_cgns_files(*args, **kwargs)

Write CGNS files.

Classes:

fft_surface_variables(path, service)

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

Clean up storage area.

compute_fft_fields(*args, **kwargs)#

Compute FFT fields.

class fft_surface_variables(path, service)#

Bases: TUIMenu

Enter the FFT surface variables menu.

Methods:

create_constant_width_bands(*args, **kwargs)

Create constant-width bands.

create_octave_bands(*args, **kwargs)

Create octave bands.

create_set_of_modes(*args, **kwargs)

Create set of modes.

create_third_bands(*args, **kwargs)

Create third bands.

remove_variables(*args, **kwargs)

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

Create constant-width bands.

create_octave_bands(*args, **kwargs)#

Create octave bands.

create_set_of_modes(*args, **kwargs)#

Create set of modes.

create_third_bands(*args, **kwargs)#

Create third bands.

remove_variables(*args, **kwargs)#

Remove variables.

read_asd_files(*args, **kwargs)#

Read ASD files.

write_cgns_files(*args, **kwargs)#

Write CGNS files.

class sponge_layers(path, service)#

Bases: TUIMenu

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

Methods:

activate(*args, **kwargs)

Activate a sponge object.

add(*args, **kwargs)

Add a new sponge layer definition.

deactivate(*args, **kwargs)

Deactivate a sponge layer definition.

delete(*args, **kwargs)

Delete a sponge layer definition.

edit(*args, **kwargs)

Edit a sponge layer definition.

list(*args, **kwargs)

List the names of the sponge layer definitions.

list_active(*args, **kwargs)

List the names of the active sponge layer definitions.

list_properties(*args, **kwargs)

List the properties of a sponge layer definition.
activate(*args, **kwargs)#

Activate a sponge object.

add(*args, **kwargs)#

Add a new sponge layer definition.

deactivate(*args, **kwargs)#

Deactivate a sponge layer definition.

delete(*args, **kwargs)#

Delete a sponge layer definition.

edit(*args, **kwargs)#

Edit a sponge layer definition.

list(*args, **kwargs)#

List the names of the sponge layer definitions.

list_active(*args, **kwargs)#

List the names of the active sponge layer definitions.

list_properties(*args, **kwargs)#

List the properties of a sponge layer definition.

wave_equation(*args, **kwargs)#

Enable/disable the wave equation model.

class wave_equation_options(path, service)#

Bases: TUIMenu

Enter the options menu for the wave equation model.

Classes:

basic_shapes(path, service)

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

remote_receivers_options(path, service)

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

Methods:

remote_receivers(*args, **kwargs)

Activate the Kirchhoff's integral method for remote receivers.

source_mask_udf(*args, **kwargs)

Select user-defined function for sound source masking.

sponge_layer_base_level(*args, **kwargs)

Specify artificial viscosity base level applied everywhere.

sponge_layer_factor(*args, **kwargs)

Specify artificial viscosity factor for sponge layer.

sponge_layer_udf(*args, **kwargs)

Select user-defined function for sponge layer.

time_filter_source(*args, **kwargs)

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

Bases: TUIMenu

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

Methods:

add_source_mask_shape(*args, **kwargs)

Add a region register for the source mask.

add_sponge_layer_shape(*args, **kwargs)

Add a region register for the sponge layer.

list_region_registers(*args, **kwargs)

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

list_source_mask_shapes(*args, **kwargs)

List all active source mask registers.

list_sponge_layer_shapes(*args, **kwargs)

List all active sponge layer registers.

remove_source_mask_shape(*args, **kwargs)

Remove a region register from the source mask.

remove_sponge_layer_shape(*args, **kwargs)

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

Add a region register for the source mask.

add_sponge_layer_shape(*args, **kwargs)#

Add a region register for the sponge layer.

list_region_registers(*args, **kwargs)#

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

list_source_mask_shapes(*args, **kwargs)#

List all active source mask registers.

list_sponge_layer_shapes(*args, **kwargs)#

List all active sponge layer registers.

remove_source_mask_shape(*args, **kwargs)#

Remove a region register from the source mask.

remove_sponge_layer_shape(*args, **kwargs)#

Remove a region register from the sponge layer.

remote_receivers(*args, **kwargs)#

Activate the Kirchhoff’s integral method for remote receivers.

class remote_receivers_options(path, service)#

Bases: TUIMenu

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

Methods:

integration_surface(*args, **kwargs)

Select Kirchhoff's integration surface.

write_signals(*args, **kwargs)

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

Select Kirchhoff’s integration surface.

write_signals(*args, **kwargs)#

Write signals calculated at receiver locations.

source_mask_udf(*args, **kwargs)#

Select user-defined function for sound source masking.

sponge_layer_base_level(*args, **kwargs)#

Specify artificial viscosity base level applied everywhere.

sponge_layer_factor(*args, **kwargs)#

Specify artificial viscosity factor for sponge layer.

sponge_layer_udf(*args, **kwargs)#

Select user-defined function for sponge layer.

time_filter_source(*args, **kwargs)#

Activate time-filtering of sound sources.

write_acoustic_signals(*args, **kwargs)#

Write on-the-fly sound pressure.

write_centroid_info(*args, **kwargs)#

Write centroid info.

addon_module(*args, **kwargs)#

Load addon module.

axisymmetric(*args, **kwargs)#

Enable/disable the axisymmetric model.

battery_model(*args, **kwargs)#

Enter battery model menu.

class cht(path, service)#

Bases: TUIMenu

Enter the mapped interface model menu.

Classes:

explicit_time_averaged_coupling(path, service)

Enter the explcit time averaged thermal coupling menu.

Methods:

implicit_coupling(*args, **kwargs)

Enable/disable implicit coupling for mapped interface.

read_mi_type_wall(*args, **kwargs)

Read mapped interface data settings from a csv file.

write_mi_type_wall(*args, **kwargs)

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

Bases: TUIMenu

Enter the explcit time averaged thermal coupling menu.

Methods:

conformal_coupled_walls(*args, **kwargs)

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

coupling_controls(*args, **kwargs)

Specify explcit coupling controls.

fuse_explicit_cht_zones(*args, **kwargs)

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

mapped_interfaces(*args, **kwargs)

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

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

coupling_controls(*args, **kwargs)#

Specify explcit coupling controls.

fuse_explicit_cht_zones(*args, **kwargs)#

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

mapped_interfaces(*args, **kwargs)#

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

implicit_coupling(*args, **kwargs)#

Enable/disable implicit coupling for mapped interface.

read_mi_type_wall(*args, **kwargs)#

Read mapped interface data settings from a csv file.

write_mi_type_wall(*args, **kwargs)#

Write mapped interface settings to a scv file.

crevice_model(*args, **kwargs)#

Enable/disable the crevice model.

crevice_model_controls(*args, **kwargs)#

Enter the crevice model controls menu.

class dpm(path, service)#

Bases: TUIMenu

Enter the dispersed phase model menu.

Methods:

clear_particles_from_domain(*args, **kwargs)

Remove/keep all particles currently in the domain.

fill_injection_material_sources(*args, **kwargs)

Initialize the DPM sources corresponding to each material.

injections(*args, **kwargs)

Enter the injections menu.

spray_model(*args, **kwargs)

Enter the spray model menu.

unsteady_tracking(*args, **kwargs)

Enable/disable unsteady particle tracking.

user_defined(*args, **kwargs)

Set DPM user-defined functions.

Classes:

collisions(path, service)

Enter the DEM collisions menu.

erosion_dynamic_mesh(path, service)

Enter the erosion-dynamic mesh interactions menu.

interaction(path, service)

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

numerics(path, service)

Enter the numerics menu to set numerical solution parameters.

options(path, service)

Enter the options menu to set optional DPM models.

parallel(path, service)

Enter the parallel menu.

splash_options(path, service)

Enter the splash options menu to set optional parameters.

stripping_options(path, service)

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

Remove/keep all particles currently in the domain.

class collisions(path, service)#

Bases: TUIMenu

Enter the DEM collisions menu.

Methods:

collision_mesh(*args, **kwargs)

Input for the collision mesh.

collision_pair_settings(*args, **kwargs)

Supply settings for collisions to a pair of collision partners.

dem_collisions(*args, **kwargs)

Enable/disable the DEM collision model.

list_all_pair_settings(*args, **kwargs)

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

max_particle_velocity(*args, **kwargs)

Set the maximum particle velocity that may arise from collisions.

Classes:

collision_partners(path, service)

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

Input for the collision mesh.

collision_pair_settings(*args, **kwargs)#

Supply settings for collisions to a pair of collision partners.

class collision_partners(path, service)#

Bases: TUIMenu

Manage collision partners.

Methods:

copy(*args, **kwargs)

Copy a collision partner.

create(*args, **kwargs)

Create a collision partner.

delete(*args, **kwargs)

Delete a collision partner.

list(*args, **kwargs)

Lists all known collision partners.

rename(*args, **kwargs)

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

Copy a collision partner.

create(*args, **kwargs)#

Create a collision partner.

delete(*args, **kwargs)#

Delete a collision partner.

list(*args, **kwargs)#

Lists all known collision partners.

rename(*args, **kwargs)#

Rename a collision partner.

dem_collisions(*args, **kwargs)#

Enable/disable the DEM collision model.

list_all_pair_settings(*args, **kwargs)#

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

max_particle_velocity(*args, **kwargs)#

Set the maximum particle velocity that may arise from collisions.

class erosion_dynamic_mesh(path, service)#

Bases: TUIMenu

Enter the erosion-dynamic mesh interactions menu.

Methods:

enable_erosion_dynamic_mesh_coupling(*args, ...)

Enable mesh deformation due to wall erosion.

run_simulation(*args, **kwargs)

Perform coupled erosion-dynamic mesh simulation.

Classes:

general_parameters(path, service)

Enter the erosion-dynamic mesh setup menu.

run_parameters(path, service)

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

Enable mesh deformation due to wall erosion.

class general_parameters(path, service)#

Bases: TUIMenu

Enter the erosion-dynamic mesh setup menu.

Methods:

dynamic_mesh_settings(*args, **kwargs)

Perform dynamic mesh related setup.

erosion_settings(*args, **kwargs)

Set erosion modelling specific settings.

participating_walls(*args, **kwargs)

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

Perform dynamic mesh related setup.

erosion_settings(*args, **kwargs)#

Set erosion modelling specific settings.

participating_walls(*args, **kwargs)#

Specify all participating walls.

class run_parameters(path, service)#

Bases: TUIMenu

Enter the erosion-dynamic mesh run menu.

Methods:

autosave_files(*args, **kwargs)

Set the iteration increment to save data files.

autosave_graphics(*args, **kwargs)

Set the iteration increment to save graphics files.

flow_simulation_control(*args, **kwargs)

Set number of iterations per flow simulation step.

mesh_motion_time_step(*args, **kwargs)

Set the mesh motion time stepping parameters and method.

simulation_termination(*args, **kwargs)

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

Set the iteration increment to save data files.

autosave_graphics(*args, **kwargs)#

Set the iteration increment to save graphics files.

flow_simulation_control(*args, **kwargs)#

Set number of iterations per flow simulation step.

mesh_motion_time_step(*args, **kwargs)#

Set the mesh motion time stepping parameters and method.

simulation_termination(*args, **kwargs)#

Set total time of erosion.

run_simulation(*args, **kwargs)#

Perform coupled erosion-dynamic mesh simulation.

fill_injection_material_sources(*args, **kwargs)#

Initialize the DPM sources corresponding to each material.

injections(*args, **kwargs)#

Enter the injections menu.

class interaction(path, service)#

Bases: TUIMenu

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

Methods:

choice_of_eulerian_phase_for_interaction(...)

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

coupled_calculations(*args, **kwargs)

Enable/disable coupling of continuous and discrete phase calculations.

ddpm_energy_coupling_via_source_term(*args, ...)

Energy coupling in DDPM established via source term.

ddpm_enhanced_inter_phase_exchange(*args, ...)

Enhanced Eulerian inter-phase exchange.

ddpm_iad_particle(*args, **kwargs)

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

dpm_iteration_interval(*args, **kwargs)

Set the number of continuous phase iterations per DPM iteration.

enable_drag_scaling_due_to_flow_blocking(...)

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

enable_flow_blocking_by_particles(*args, ...)

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

enable_source_scaling_due_to_flow_blocking(...)

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

implicit_momentum_coupling(*args, **kwargs)

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

implicit_source_term_coupling(*args, **kwargs)

Enable/disable implicit treatment for all DPM source terms.

keep_linearized_dpm_source_terms_constant(...)

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

linear_growth_of_dpm_source_term(*args, **kwargs)

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

linearized_dpm_mixture_fraction_source_terms(...)

Perform a linearization of mixture fraction source terms.

linearized_dpm_source_terms(*args, **kwargs)

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

linearized_dpm_source_terms_limiter(*args, ...)

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

linearized_dpm_species_source_terms(*args, ...)

Perform linearization of species source terms.

max_vf_allowed_for_blocking(*args, **kwargs)

Maximum DPM volume fraction used in continuous flow.

min_vf_threshold_for_dpm_src_scaling(*args, ...)

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

replace_dpm_mass_source_by_mixture_fraction(...)

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

reset_sources_at_timestep(*args, **kwargs)

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

underrelaxation_factor(*args, **kwargs)

Set the under-relaxation factor.

update_dpm_sources_every_flow_iteration(...)

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

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

coupled_calculations(*args, **kwargs)#

Enable/disable coupling of continuous and discrete phase calculations.

ddpm_energy_coupling_via_source_term(*args, **kwargs)#

Energy coupling in DDPM established via source term.

ddpm_enhanced_inter_phase_exchange(*args, **kwargs)#

Enhanced Eulerian inter-phase exchange.

ddpm_iad_particle(*args, **kwargs)#

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

dpm_iteration_interval(*args, **kwargs)#

Set the number of continuous phase iterations per DPM iteration.

enable_drag_scaling_due_to_flow_blocking(*args, **kwargs)#

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

enable_flow_blocking_by_particles(*args, **kwargs)#

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

enable_source_scaling_due_to_flow_blocking(*args, **kwargs)#

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

implicit_momentum_coupling(*args, **kwargs)#

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

implicit_source_term_coupling(*args, **kwargs)#

Enable/disable implicit treatment for all DPM source terms.

keep_linearized_dpm_source_terms_constant(*args, **kwargs)#

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

linear_growth_of_dpm_source_term(*args, **kwargs)#

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

linearized_dpm_mixture_fraction_source_terms(*args, **kwargs)#

Perform a linearization of mixture fraction source terms.

linearized_dpm_source_terms(*args, **kwargs)#

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

linearized_dpm_source_terms_limiter(*args, **kwargs)#

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

linearized_dpm_species_source_terms(*args, **kwargs)#

Perform linearization of species source terms.

max_vf_allowed_for_blocking(*args, **kwargs)#

Maximum DPM volume fraction used in continuous flow.

min_vf_threshold_for_dpm_src_scaling(*args, **kwargs)#

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

replace_dpm_mass_source_by_mixture_fraction(*args, **kwargs)#

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

reset_sources_at_timestep(*args, **kwargs)#

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

underrelaxation_factor(*args, **kwargs)#

Set the under-relaxation factor.

update_dpm_sources_every_flow_iteration(*args, **kwargs)#

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

class numerics(path, service)#

Bases: TUIMenu

Enter the numerics menu to set numerical solution parameters.

Methods:

automated_scheme_selection(*args, **kwargs)

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

average_DDPM_variables(*args, **kwargs)

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

average_each_step(*args, **kwargs)

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

average_kernel(*args, **kwargs)

Specify a kernel for the averaging.

average_source_terms(*args, **kwargs)

Average DPM source terms on nodes.

coupled_heat_mass_update(*args, **kwargs)

Enable/disable coupled heat and mass update.

drag_law(*args, **kwargs)

Set the drag law.

dynamic_interaction(*args, **kwargs)

Enable/disable dynamic interaction range.

enable_node_based_averaging(*args, **kwargs)

Enable node based averaging of DPM variables.

enhanced_packing_limit_numerics(*args, **kwargs)

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

error_control(*args, **kwargs)

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

gaussian_factor(*args, **kwargs)

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

granular_stress_tensor(*args, **kwargs)

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

minimum_liquid_fraction(*args, **kwargs)

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

mppic_settings(*args, **kwargs)

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

predictor_corrector(*args, **kwargs)

Enable predictor/corrector approach to track particles.

tracking_parameters(*args, **kwargs)

Set parameters for the (initial) tracking step length.

tracking_scheme(*args, **kwargs)

Specify a tracking scheme.

tracking_statistics(*args, **kwargs)

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

underrelax_film_height(*args, **kwargs)

Define underrelaxation factor for film height.

vaporization_limiting_factors(*args, **kwargs)

Set Vaporization Fractional Change Limits.

verbosity(*args, **kwargs)

Adjust the DPM tracker's verbosity level.

Classes:

high_resolution_tracking(path, service)

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

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

average_DDPM_variables(*args, **kwargs)#

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

average_each_step(*args, **kwargs)#

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

average_kernel(*args, **kwargs)#

Specify a kernel for the averaging.

average_source_terms(*args, **kwargs)#

Average DPM source terms on nodes.

coupled_heat_mass_update(*args, **kwargs)#

Enable/disable coupled heat and mass update.

drag_law(*args, **kwargs)#

Set the drag law.

dynamic_interaction(*args, **kwargs)#

Enable/disable dynamic interaction range.

enable_node_based_averaging(*args, **kwargs)#

Enable node based averaging of DPM variables.

enhanced_packing_limit_numerics(*args, **kwargs)#

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

error_control(*args, **kwargs)#

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

gaussian_factor(*args, **kwargs)#

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

granular_stress_tensor(*args, **kwargs)#

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

class high_resolution_tracking(path, service)#

Bases: TUIMenu

Enter the high resolution tracking menu.

Methods:

always_use_face_centroid_with_periodics(...)

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

boundary_layer_tracking(*args, **kwargs)

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

check_subtet_validity(*args, **kwargs)

Test for inverted subtets due to warped cells.

enable_automatic_intersection_tolerance(...)

Enable automatic scaling of subtet intersection tolerance.

enable_barycentric_intersections(*args, **kwargs)

Use barycentric coordinates for intersection calculations.

enable_high_resolution_tracking(*args, **kwargs)

Enable high resolution tracking.

project_wall_film_particles_to_film(*args, ...)

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

remove_stuck_particles(*args, **kwargs)

Remove particles that are stuck at edges or faces.

set_film_spreading_parameter(*args, **kwargs)

Set the spreading parameter for Lagrangian wallfilm particles.

set_subtet_intersection_tolerance(*args, ...)

Set the tolerance for subtet intersection calculations.

sliding_interface_crossover_fraction(*args, ...)

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

use_barycentric_sampling(*args, **kwargs)

Use barycentric coordinates when sampling at planes.

use_particle_timestep_for_intersection_tolerance(...)

Use the particle timestep for the axisymmetric subtet intersection tolerance.

use_quad_face_centroid(*args, **kwargs)

Use quad face centroids when creating subtets.

use_velocity_based_error_control(*args, **kwargs)

Use adaptive time stepping based upon the particle velocity.

Classes:

barycentric_interpolation(path, service)

Enter the barycentric interpolation menu.

particle_relocation(path, service)

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

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

class barycentric_interpolation(path, service)#

Bases: TUIMenu

Enter the barycentric interpolation menu.

Methods:

enable_transient_variable_interpolation(...)

Enable transient variable interpolation.

interpolate_flow_cp(*args, **kwargs)

Enable interpolation of flow specific heat to the particle position.

interpolate_flow_density(*args, **kwargs)

Enable interpolation of flow density to the particle position.

interpolate_flow_solution_gradients(*args, ...)

Enable interpolation of flow solution gradients.

interpolate_flow_viscosity(*args, **kwargs)

Enable interpolation of flow viscosity to the particle position.

interpolate_temperature(*args, **kwargs)

Enable interpolation of temperature to the particle position.

interpolate_wallfilm_properties(*args, **kwargs)

Enable interpolation of wallfilm properties to the particle position.

nodal_reconstruction_frequency(*args, **kwargs)

Update nodal reconstruction every N'th DPM iteration.

precompute_pdf_species(*args, **kwargs)

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

user_interpolation_function(*args, **kwargs)

Enter user interpolation function.

zero_nodal_velocity_on_walls(*args, **kwargs)

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

Enable transient variable interpolation.

interpolate_flow_cp(*args, **kwargs)#

Enable interpolation of flow specific heat to the particle position.

interpolate_flow_density(*args, **kwargs)#

Enable interpolation of flow density to the particle position.

interpolate_flow_solution_gradients(*args, **kwargs)#

Enable interpolation of flow solution gradients.

interpolate_flow_viscosity(*args, **kwargs)#

Enable interpolation of flow viscosity to the particle position.

interpolate_temperature(*args, **kwargs)#

Enable interpolation of temperature to the particle position.

interpolate_wallfilm_properties(*args, **kwargs)#

Enable interpolation of wallfilm properties to the particle position.

nodal_reconstruction_frequency(*args, **kwargs)#

Update nodal reconstruction every N’th DPM iteration.

precompute_pdf_species(*args, **kwargs)#

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

user_interpolation_function(*args, **kwargs)#

Enter user interpolation function.

zero_nodal_velocity_on_walls(*args, **kwargs)#

Set the nodal velocity on all walls to zero.

boundary_layer_tracking(*args, **kwargs)#

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

check_subtet_validity(*args, **kwargs)#

Test for inverted subtets due to warped cells.

enable_automatic_intersection_tolerance(*args, **kwargs)#

Enable automatic scaling of subtet intersection tolerance.

enable_barycentric_intersections(*args, **kwargs)#

Use barycentric coordinates for intersection calculations.

enable_high_resolution_tracking(*args, **kwargs)#

Enable high resolution tracking.

class particle_relocation(path, service)#

Bases: TUIMenu

Enter the particle relocation menu.

Methods:

enhanced_cell_relocation_method(*args, **kwargs)

Enable enhanced method of locating particles in cells.

enhanced_wallfilm_location_method(*args, ...)

Enable enhanced method of locating film particles on faces.

load_legacy_particles(*args, **kwargs)

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

overset_relocation_robustness_level(*args, ...)

Set the robustness level for particle relocation in overset meshes.

use_legacy_particle_location_method(*args, ...)

Enable legacy method of locating particles in cells.

wallfilm_relocation_tolerance_scale_factor(...)

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

Enable enhanced method of locating particles in cells.

enhanced_wallfilm_location_method(*args, **kwargs)#

Enable enhanced method of locating film particles on faces.

load_legacy_particles(*args, **kwargs)#

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

overset_relocation_robustness_level(*args, **kwargs)#

Set the robustness level for particle relocation in overset meshes.

use_legacy_particle_location_method(*args, **kwargs)#

Enable legacy method of locating particles in cells.

wallfilm_relocation_tolerance_scale_factor(*args, **kwargs)#

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

project_wall_film_particles_to_film(*args, **kwargs)#

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

remove_stuck_particles(*args, **kwargs)#

Remove particles that are stuck at edges or faces.

set_film_spreading_parameter(*args, **kwargs)#

Set the spreading parameter for Lagrangian wallfilm particles.

set_subtet_intersection_tolerance(*args, **kwargs)#

Set the tolerance for subtet intersection calculations.

sliding_interface_crossover_fraction(*args, **kwargs)#

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

use_barycentric_sampling(*args, **kwargs)#

Use barycentric coordinates when sampling at planes.

use_particle_timestep_for_intersection_tolerance(*args, **kwargs)#

Use the particle timestep for the axisymmetric subtet intersection tolerance.

use_quad_face_centroid(*args, **kwargs)#

Use quad face centroids when creating subtets.

use_velocity_based_error_control(*args, **kwargs)#

Use adaptive time stepping based upon the particle velocity.

minimum_liquid_fraction(*args, **kwargs)#

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

mppic_settings(*args, **kwargs)#

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

predictor_corrector(*args, **kwargs)#

Enable predictor/corrector approach to track particles.

tracking_parameters(*args, **kwargs)#

Set parameters for the (initial) tracking step length.

tracking_scheme(*args, **kwargs)#

Specify a tracking scheme.

tracking_statistics(*args, **kwargs)#

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

underrelax_film_height(*args, **kwargs)#

Define underrelaxation factor for film height.

vaporization_limiting_factors(*args, **kwargs)#

Set Vaporization Fractional Change Limits.

verbosity(*args, **kwargs)#

Adjust the DPM tracker’s verbosity level.

class options(path, service)#

Bases: TUIMenu

Enter the options menu to set optional DPM models.

Methods:

allow_supercritical_pressure_vaporization(...)

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

brownian_motion(*args, **kwargs)

Enable/disable Brownian motion of particles.

convective_film_heat_transfer(*args, **kwargs)

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

current_positions_in_sample_file_format(...)

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

enable_contour_plots(*args, **kwargs)

Enable contour and vector plots of particle data.

ensemble_average(*args, **kwargs)

Set ensemble average cloud properties.

erosion_accretion(*args, **kwargs)

Enable/disable erosion/accretion.

include_lwf_particles_in_dpm_concentration(...)

Include LWF particle mass in DPM Concentration.

init_erosion_accretion_rate(*args, **kwargs)

Initialize erosion/accretion rates with Zero.

lowest_volatiles_mass_fraction(*args, **kwargs)

Set the lowest volatiles mass fraction.

maximum_udf_species(*args, **kwargs)

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

particle_radiation(*args, **kwargs)

Enable/disable particle radiation.

pressure_gradient_force(*args, **kwargs)

Enable/disable pressure gradient force.

remove_wall_film_temperature_limiter(*args, ...)

Remove the wall film temperature limiter.

saffman_lift_force(*args, **kwargs)

Enable/disable Saffman lift force.

scr_urea_deposition_risk_analysis(*args, ...)

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

set_minimum_particle_diameter(*args, **kwargs)

Set the minimum particle diameter.

set_thermolysis_limit(*args, **kwargs)

Set the thermolysis limit.

stagger_radius(*args, **kwargs)

Provide a stagger radius for non atomizer injections.

stagger_spatially_atomizer_injections(*args, ...)

Spatially stagger atomizer injections?.

stagger_spatially_standard_injections(*args, ...)

Spatially stagger non-atomizer injections?.

stagger_temporally(*args, **kwargs)

Stagger transient parcels for their first time step?.

staggering_factor(*args, **kwargs)

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

step_report_sig_figures(*args, **kwargs)

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

thermophoretic_force(*args, **kwargs)

Enable/disable thermophoretic force.

track_in_absolute_frame(*args, **kwargs)

Enable/disable tracking in absolute frame.

treat_multicomponent_saturation_temperature_failure(...)

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

two_way_coupling(*args, **kwargs)

Enable/disable calculation of DPM sources in TKE equation.

uniform_mass_distribution_for_injections(...)

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

use_absolute_pressure_for_vaporization(...)

Enable/disable using Absolute Pressure for Vaporization.

vaporization_heat_transfer_averaging(*args, ...)

Enable/disable correction for Vaporization heat transfer.

vaporization_options(*args, **kwargs)

Set Vaporization options.

virtual_mass_force(*args, **kwargs)

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

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

brownian_motion(*args, **kwargs)#

Enable/disable Brownian motion of particles.

convective_film_heat_transfer(*args, **kwargs)#

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

current_positions_in_sample_file_format(*args, **kwargs)#

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

enable_contour_plots(*args, **kwargs)#

Enable contour and vector plots of particle data.

ensemble_average(*args, **kwargs)#

Set ensemble average cloud properties.

erosion_accretion(*args, **kwargs)#

Enable/disable erosion/accretion.

include_lwf_particles_in_dpm_concentration(*args, **kwargs)#

Include LWF particle mass in DPM Concentration.

init_erosion_accretion_rate(*args, **kwargs)#

Initialize erosion/accretion rates with Zero.

lowest_volatiles_mass_fraction(*args, **kwargs)#

Set the lowest volatiles mass fraction.

maximum_udf_species(*args, **kwargs)#

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

particle_radiation(*args, **kwargs)#

Enable/disable particle radiation.

pressure_gradient_force(*args, **kwargs)#

Enable/disable pressure gradient force.

remove_wall_film_temperature_limiter(*args, **kwargs)#

Remove the wall film temperature limiter.

saffman_lift_force(*args, **kwargs)#

Enable/disable Saffman lift force.

scr_urea_deposition_risk_analysis(*args, **kwargs)#

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

set_minimum_particle_diameter(*args, **kwargs)#

Set the minimum particle diameter.

set_thermolysis_limit(*args, **kwargs)#

Set the thermolysis limit.

stagger_radius(*args, **kwargs)#

Provide a stagger radius for non atomizer injections.

stagger_spatially_atomizer_injections(*args, **kwargs)#

Spatially stagger atomizer injections?.

stagger_spatially_standard_injections(*args, **kwargs)#

Spatially stagger non-atomizer injections?.

stagger_temporally(*args, **kwargs)#

Stagger transient parcels for their first time step?.

staggering_factor(*args, **kwargs)#

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

step_report_sig_figures(*args, **kwargs)#

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

thermophoretic_force(*args, **kwargs)#

Enable/disable thermophoretic force.

track_in_absolute_frame(*args, **kwargs)#

Enable/disable tracking in absolute frame.

treat_multicomponent_saturation_temperature_failure(*args, **kwargs)#

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

two_way_coupling(*args, **kwargs)#

Enable/disable calculation of DPM sources in TKE equation.

uniform_mass_distribution_for_injections(*args, **kwargs)#

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

use_absolute_pressure_for_vaporization(*args, **kwargs)#

Enable/disable using Absolute Pressure for Vaporization.

vaporization_heat_transfer_averaging(*args, **kwargs)#

Enable/disable correction for Vaporization heat transfer.

vaporization_options(*args, **kwargs)#

Set Vaporization options.

virtual_mass_force(*args, **kwargs)#

Enable/disable virtual mass force.

class parallel(path, service)#

Bases: TUIMenu

Enter the parallel menu.

Methods:

enable_workpile(*args, **kwargs)

Enable/disable the particle workpile algorithm.

fix_source_term_accumulation_order(*args, ...)

Enforce deterministic order of source term accumulation.

hybrid_2domain(*args, **kwargs)

Use DPM domain to simulate particles.

hybrid_collision_model(*args, **kwargs)

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

hybrid_collision_unidirectional(*args, **kwargs)

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

hybrid_collision_variant(*args, **kwargs)

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

hybrid_workpile(*args, **kwargs)

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

n_threads(*args, **kwargs)

Set the number of processors to use for DPM.

report(*args, **kwargs)

Print particle workpile statistics.

use_hybrid(*args, **kwargs)

Set DPM parallel-mode to hybrid.

use_message_passing(*args, **kwargs)

Set DPM parallel-mode to message passing.

use_shared_memory(*args, **kwargs)

Set DPM parallel-mode to shared memory.

Classes:

expert(path, service)

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

Enable/disable the particle workpile algorithm.

class expert(path, service)#

Bases: TUIMenu

Enter the menu to set expert DPM parallel options.

Methods:

partition_method_hybrid_2domain(*args, **kwargs)

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

Set DPM Domain partition method.

fix_source_term_accumulation_order(*args, **kwargs)#

Enforce deterministic order of source term accumulation.

hybrid_2domain(*args, **kwargs)#

Use DPM domain to simulate particles.

hybrid_collision_model(*args, **kwargs)#

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

hybrid_collision_unidirectional(*args, **kwargs)#

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

hybrid_collision_variant(*args, **kwargs)#

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

hybrid_workpile(*args, **kwargs)#

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

n_threads(*args, **kwargs)#

Set the number of processors to use for DPM.

report(*args, **kwargs)#

Print particle workpile statistics.

use_hybrid(*args, **kwargs)#

Set DPM parallel-mode to hybrid.

use_message_passing(*args, **kwargs)#

Set DPM parallel-mode to message passing.

use_shared_memory(*args, **kwargs)#

Set DPM parallel-mode to shared memory.

class splash_options(path, service)#

Bases: TUIMenu

Enter the splash options menu to set optional parameters.

Methods:

orourke_splash_fraction(*args, **kwargs)

Select splash fraction method.

splash_pdf_limiting(*args, **kwargs)

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

Select splash fraction method.

splash_pdf_limiting(*args, **kwargs)#

Select splash pdf limiting method.

spray_model(*args, **kwargs)#

Enter the spray model menu.

class stripping_options(path, service)#

Bases: TUIMenu

Enter the stripping options menu to set optional parameters.

Methods:

diameter_coefficient(*args, **kwargs)

Set the stripping diameter coefficient.

mass_coefficient(*args, **kwargs)

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

Set the stripping diameter coefficient.

mass_coefficient(*args, **kwargs)#

Set the stripping mass coefficient.

unsteady_tracking(*args, **kwargs)#

Enable/disable unsteady particle tracking.

user_defined(*args, **kwargs)#

Set DPM user-defined functions.

class electrolysis(path, service)#

Bases: TUIMenu

Enter the electrolysis model setup menu.

Classes:

anode_setup(path, service)

Enter the menu for the anode controls.

cathode_setup(path, service)

Enter the menu for the cathode controls.

membrane_setup(path, service)

Specify parameters for electrolyte.

Methods:

electrical_tabs_setup(*args, **kwargs)

Specify settings for the electrical tabs.

model_options(*args, **kwargs)

Specify electrolysis model options.

parameters(*args, **kwargs)

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

Bases: TUIMenu

Enter the menu for the anode controls.

Methods:

catalyst_layer(*args, **kwargs)

Set parameters for the catalyst layer.

current_collector(*args, **kwargs)

Set parameters for the current collector.

electrolyte(*args, **kwargs)

Set parameters for the electrolyte.

flow_channel(*args, **kwargs)

Set parameters for the flow channel.

porous_layer(*args, **kwargs)

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

Set parameters for the catalyst layer.

current_collector(*args, **kwargs)#

Set parameters for the current collector.

electrolyte(*args, **kwargs)#

Set parameters for the electrolyte.

flow_channel(*args, **kwargs)#

Set parameters for the flow channel.

porous_layer(*args, **kwargs)#

Set parameters for the porous layer.

class cathode_setup(path, service)#

Bases: TUIMenu

Enter the menu for the cathode controls.

Methods:

catalyst_layer(*args, **kwargs)

Set parameters for the catalyst layer.

current_collector(*args, **kwargs)

Set parameters for the current collector.

electrolyte(*args, **kwargs)

Set parameters for the electrolyte.

flow_channel(*args, **kwargs)

Set parameters for the flow channel.

porous_layer(*args, **kwargs)

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

Set parameters for the catalyst layer.

current_collector(*args, **kwargs)#

Set parameters for the current collector.

electrolyte(*args, **kwargs)#

Set parameters for the electrolyte.

flow_channel(*args, **kwargs)#

Set parameters for the flow channel.

porous_layer(*args, **kwargs)#

Set parameters for the porous layer.

electrical_tabs_setup(*args, **kwargs)#

Specify settings for the electrical tabs.

class membrane_setup(path, service)#

Bases: TUIMenu

Specify parameters for electrolyte.

Methods:

catalyst_layer(*args, **kwargs)

Set parameters for the catalyst layer.

current_collector(*args, **kwargs)

Set parameters for the current collector.

electrolyte(*args, **kwargs)

Set parameters for the electrolyte.

flow_channel(*args, **kwargs)

Set parameters for the flow channel.

porous_layer(*args, **kwargs)

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

Set parameters for the catalyst layer.

current_collector(*args, **kwargs)#

Set parameters for the current collector.

electrolyte(*args, **kwargs)#

Set parameters for the electrolyte.

flow_channel(*args, **kwargs)#

Set parameters for the flow channel.

porous_layer(*args, **kwargs)#

Set parameters for the porous layer.

model_options(*args, **kwargs)#

Specify electrolysis model options.

parameters(*args, **kwargs)#

Specify electrolysis model parameters.

energy(*args, **kwargs)#

Enable/disable the energy model.

class eulerian_wallfilm(path, service)#

Bases: TUIMenu

Enter the Eulerian wall film model menu.

Classes:

coupled_solution(path, service)

Enter Eulerian wall film coupled solution menu.

implicit_options(path, service)

Enter Implicit Scheme Option (beta).

Methods:

enable_film_vof_transition_message(*args, ...)

Enable film-VOF transition message.

enable_wallfilm_model(*args, **kwargs)

Enable Eulerian wall film model.

film_material(*args, **kwargs)

Set film material and properties.

initialize_wallfilm_model(*args, **kwargs)

Initialize Eulerian wall film model.

list_film_walls(*args, **kwargs)

List film walls.

model_options(*args, **kwargs)

Set Eulerian wall film model options.

solution_options(*args, **kwargs)

Set Eulerian wall film model solution options.

solve_wallfilm_equation(*args, **kwargs)

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

Bases: TUIMenu

Enter Eulerian wall film coupled solution menu.

Methods:

enable_coupled_solution(*args, **kwargs)

Enable Eulerian wall film coupled solution.

enable_curvature_smoothing(*args, **kwargs)

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

Enable Eulerian wall film coupled solution.

enable_curvature_smoothing(*args, **kwargs)#

Enable Eulerian wall film curvature smoothing.

enable_film_vof_transition_message(*args, **kwargs)#

Enable film-VOF transition message.

enable_wallfilm_model(*args, **kwargs)#

Enable Eulerian wall film model.

film_material(*args, **kwargs)#

Set film material and properties.

class implicit_options(path, service)#

Bases: TUIMenu

Enter Implicit Scheme Option (beta).

Methods:

new_implicit_scheme(*args, **kwargs)

Enable alternative implicit scheme.

relative_error_residual(*args, **kwargs)

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

Enable alternative implicit scheme.

relative_error_residual(*args, **kwargs)#

Enable relative error residual.

initialize_wallfilm_model(*args, **kwargs)#

Initialize Eulerian wall film model.

list_film_walls(*args, **kwargs)#

List film walls.

model_options(*args, **kwargs)#

Set Eulerian wall film model options.

solution_options(*args, **kwargs)#

Set Eulerian wall film model solution options.

solve_wallfilm_equation(*args, **kwargs)#

Activate Eulerian wall film equations.

frozen_flux(*args, **kwargs)#

Enable/disable frozen flux formulation for transient flows.

class heat_exchanger(path, service)#

Bases: TUIMenu

Enter the heat exchanger menu.

Classes:

dual_cell_model(path, service)

Enter the dual cell model menu.

macro_model(path, service)

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

Bases: TUIMenu

Enter the dual cell model menu.

Methods:

add_heat_exchanger(*args, **kwargs)

Add heat-exchanger.

alternative_formulation(*args, **kwargs)

Enable/disable alternative formulation for heat transfer calculations.

delete_heat_exchanger(*args, **kwargs)

Delete heat-exchanger.

heat_exchanger(*args, **kwargs)

Enable/disable the dual cell heat-exchanger model.

modify_heat_exchanger(*args, **kwargs)

Modify heat-exchanger.

plot_NTU(*args, **kwargs)

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

write_NTU(*args, **kwargs)

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

Add heat-exchanger.

alternative_formulation(*args, **kwargs)#

Enable/disable alternative formulation for heat transfer calculations.

delete_heat_exchanger(*args, **kwargs)#

Delete heat-exchanger.

heat_exchanger(*args, **kwargs)#

Enable/disable the dual cell heat-exchanger model.

modify_heat_exchanger(*args, **kwargs)#

Modify heat-exchanger.

plot_NTU(*args, **kwargs)#

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

write_NTU(*args, **kwargs)#

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

class macro_model(path, service)#

Bases: TUIMenu

Enter the heat macro-model menu.

Methods:

delete_heat_exchanger_group(*args, **kwargs)

Delete heat-exchanger group.

heat_exchanger(*args, **kwargs)

Enable/disable heat-exchanger model.

heat_exchanger_group(*args, **kwargs)

Define heat-exchanger group.

heat_exchanger_macro_report(*args, **kwargs)

Report heat-exchanger information for all the macros.

heat_exchanger_model(*args, **kwargs)

Define heat-exchanger core model.

heat_exchanger_report(*args, **kwargs)

Report heat-exchanger information.

heat_exchanger_zone(*args, **kwargs)

Define heat-exchanger zone.

plot_NTU(*args, **kwargs)

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

write_NTU(*args, **kwargs)

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

Delete heat-exchanger group.

heat_exchanger(*args, **kwargs)#

Enable/disable heat-exchanger model.

heat_exchanger_group(*args, **kwargs)#

Define heat-exchanger group.

heat_exchanger_macro_report(*args, **kwargs)#

Report heat-exchanger information for all the macros.

heat_exchanger_model(*args, **kwargs)#

Define heat-exchanger core model.

heat_exchanger_report(*args, **kwargs)#

Report heat-exchanger information.

heat_exchanger_zone(*args, **kwargs)#

Define heat-exchanger zone.

plot_NTU(*args, **kwargs)#

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

write_NTU(*args, **kwargs)#

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

class multiphase(path, service)#

Bases: TUIMenu

Define multiphase model menu.

Methods:

body_force_formulation(*args, **kwargs)

Body force formulation.

coupled_level_set(*args, **kwargs)

Coupled level set.

interface_modeling_options(*args, **kwargs)

Interface Modeling Options.

mixture_parameters(*args, **kwargs)

Mixture parameters.

model(*args, **kwargs)

Specify multiphase model.

number_of_phases(*args, **kwargs)

Specify the number of phases.

regime_transition_modeling(*args, **kwargs)

Regime-transition-modeling-options.

vof_sub_models(*args, **kwargs)

VOF sub-models.

volume_fraction_parameters(*args, **kwargs)

Volume fraction parameters.

Classes:

explicit_expert_options(path, service)

Expert options for explicit formulation.

flow_regime_modeling(path, service)

Flow Regime Modeling.

hybrid_models(path, service)

Enter the menu to select hybrid models.

phases(path, service)

Enter the phases menu.

population_balance(path, service)

Enter the population balance model menu.

sub_models(path, service)

Enter the menu to select sub-models.

wet_steam(path, service)

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

Body force formulation.

coupled_level_set(*args, **kwargs)#

Coupled level set.

class explicit_expert_options(path, service)#

Bases: TUIMenu

Expert options for explicit formulation.

Methods:

solve_vof_every_iter(*args, **kwargs)

Solve volume fraction equation every iteration for explicit formulation.

sub_time_step_method(*args, **kwargs)

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

Classes:

volume_fraction_filtering(path, service)

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

Solve volume fraction equation every iteration for explicit formulation.

sub_time_step_method(*args, **kwargs)#

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

class volume_fraction_filtering(path, service)#

Bases: TUIMenu

Advanced volume fraction filtering controls for explicit formulation.

Methods:

enable(*args, **kwargs)

Enable volume fraction filtering treatment.

filtering_options(*args, **kwargs)

Select volume fraction filtering method.

vol_frac_cutoff(*args, **kwargs)

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

Enable volume fraction filtering treatment.

filtering_options(*args, **kwargs)#

Select volume fraction filtering method.

vol_frac_cutoff(*args, **kwargs)#

Enter node-averaged volume fraction cutoff.

class flow_regime_modeling(path, service)#

Bases: TUIMenu

Flow Regime Modeling.

Classes:

aiad_parameters(path, service)

AIAD parameters.

Methods:

enable(*args, **kwargs)

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

Bases: TUIMenu

AIAD parameters.

Methods:

critical_vf(*args, **kwargs)

Critical volume fraction for bubbly and droplet flow blending factors.

delta_grad(*args, **kwargs)

Parameter for determining transition width for free surface blending factor.

delta_vf(*args, **kwargs)

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

ncells_fs(*args, **kwargs)

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

Critical volume fraction for bubbly and droplet flow blending factors.

delta_grad(*args, **kwargs)#

Parameter for determining transition width for free surface blending factor.

delta_vf(*args, **kwargs)#

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

ncells_fs(*args, **kwargs)#

Parameter for determining interfacial width.

enable(*args, **kwargs)#

Enable flow regime modeling framework including phase state and morphology.

class hybrid_models(path, service)#

Bases: TUIMenu

Enter the menu to select hybrid models.

Methods:

ddpm(*args, **kwargs)

Enable the dense discrete phase model.

multi_fluid_vof(*args, **kwargs)

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

Enable the dense discrete phase model.

multi_fluid_vof(*args, **kwargs)#

Enable the multi-fluid VOF model.

interface_modeling_options(*args, **kwargs)#

Interface Modeling Options.

mixture_parameters(*args, **kwargs)#

Mixture parameters.

model(*args, **kwargs)#

Specify multiphase model.

number_of_phases(*args, **kwargs)#

Specify the number of phases.

class phases(path, service)#

Bases: TUIMenu

Enter the phases menu.

Classes:

iac_expert(path, service)

Enter the IAC expert setting menu.

set_domain_properties(path, service)

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

Bases: TUIMenu

Enter the IAC expert setting menu.

Methods:

hibiki_ishii_model(*args, **kwargs)

Set hi model coefficients.

iac_pseudo_time_step(*args, **kwargs)

Set iac pseudo-time.

ishii_kim_model(*args, **kwargs)

Set ik model coefficients.

yao_morel_model(*args, **kwargs)

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

Set hi model coefficients.

iac_pseudo_time_step(*args, **kwargs)#

Set iac pseudo-time.

ishii_kim_model(*args, **kwargs)#

Set ik model coefficients.

yao_morel_model(*args, **kwargs)#

Set ym model coefficients.

class set_domain_properties(path, service)#

Bases: TUIMenu

Enter the menu to set domain properties.

Methods:

change_phases_names(*args, **kwargs)

Change names for all defined phases?.

phase_domains(*args, **kwargs)

Enter the menu to select a specific phase domain.

Classes:

interaction_domain(path, service)

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

Change names for all defined phases?.

class interaction_domain(path, service)#

Bases: TUIMenu

Enter the menu to set the interaction domain properties.

Classes:

forces(path, service)

Enter the menu to set interfacial forces related models.

heat_mass_reactions(path, service)

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

interfacial_area(path, service)

Enter the menu to set interfacial area models.

model_transition(path, service)

Enter the menu to set model transition mechanisms.

numerics(path, service)

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

Bases: TUIMenu

Enter the menu to set interfacial forces related models.

Classes:

cavitation(path, service)

Enter the menu to set cavitation models.

interphase_discretization(path, service)

Enter the menu to set interphase discretization models.

interphase_viscous_dissipation(path, service)

Enter the menu to set interphase viscous dissipation related models.

lift(path, service)

Enter the menu to set lift models.

surface_tension(path, service)

Enter the menu to set surface tension models.

virtual_mass(path, service)

Enter the menu to set virtual mass models.

Methods:

drag(*args, **kwargs)

Specify the drag function for each pair of phases.

heat_coeff(*args, **kwargs)

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

interfacial_area(*args, **kwargs)

Set the interfacial area parameters for each pair of phases.

mass_transfer(*args, **kwargs)

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)

Set the model transition mechanism.

reactions(*args, **kwargs)

Define multiple heterogeneous reactions and stoichiometry.

restitution(*args, **kwargs)

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

slip_velocity(*args, **kwargs)

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

turbulence_interaction(*args, **kwargs)

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

turbulent_dispersion(*args, **kwargs)

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

wall_lubrication(*args, **kwargs)

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

Bases: TUIMenu

Enter the menu to set cavitation models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

drag(*args, **kwargs)#

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

heat_coeff(*args, **kwargs)#

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

interfacial_area(*args, **kwargs)#

Set the interfacial area parameters for each pair of phases.

class interphase_discretization(path, service)#

Bases: TUIMenu

Enter the menu to set interphase discretization models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class interphase_viscous_dissipation(path, service)#

Bases: TUIMenu

Enter the menu to set interphase viscous dissipation related models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class lift(path, service)#

Bases: TUIMenu

Enter the menu to set lift models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

mass_transfer(*args, **kwargs)#

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)#

Set the model transition mechanism.

reactions(*args, **kwargs)#

Define multiple heterogeneous reactions and stoichiometry.

restitution(*args, **kwargs)#

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

slip_velocity(*args, **kwargs)#

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

class surface_tension(path, service)#

Bases: TUIMenu

Enter the menu to set surface tension models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

turbulence_interaction(*args, **kwargs)#

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

turbulent_dispersion(*args, **kwargs)#

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

class virtual_mass(path, service)#

Bases: TUIMenu

Enter the menu to set virtual mass models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

wall_lubrication(*args, **kwargs)#

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

class heat_mass_reactions(path, service)#

Bases: TUIMenu

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

Classes:

cavitation(path, service)

Enter the menu to set cavitation models.

interphase_discretization(path, service)

Enter the menu to set interphase discretization models.

interphase_viscous_dissipation(path, service)

Enter the menu to set interphase viscous dissipation related models.

lift(path, service)

Enter the menu to set lift models.

surface_tension(path, service)

Enter the menu to set surface tension models.

virtual_mass(path, service)

Enter the menu to set virtual mass models.

Methods:

drag(*args, **kwargs)

Specify the drag function for each pair of phases.

heat_coeff(*args, **kwargs)

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

interfacial_area(*args, **kwargs)

Set the interfacial area parameters for each pair of phases.

mass_transfer(*args, **kwargs)

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)

Set the model transition mechanism.

reactions(*args, **kwargs)

Define multiple heterogeneous reactions and stoichiometry.

restitution(*args, **kwargs)

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

slip_velocity(*args, **kwargs)

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

turbulence_interaction(*args, **kwargs)

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

turbulent_dispersion(*args, **kwargs)

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

wall_lubrication(*args, **kwargs)

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

Bases: TUIMenu

Enter the menu to set cavitation models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

drag(*args, **kwargs)#

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

heat_coeff(*args, **kwargs)#

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

interfacial_area(*args, **kwargs)#

Set the interfacial area parameters for each pair of phases.

class interphase_discretization(path, service)#

Bases: TUIMenu

Enter the menu to set interphase discretization models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class interphase_viscous_dissipation(path, service)#

Bases: TUIMenu

Enter the menu to set interphase viscous dissipation related models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class lift(path, service)#

Bases: TUIMenu

Enter the menu to set lift models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

mass_transfer(*args, **kwargs)#

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)#

Set the model transition mechanism.

reactions(*args, **kwargs)#

Define multiple heterogeneous reactions and stoichiometry.

restitution(*args, **kwargs)#

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

slip_velocity(*args, **kwargs)#

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

class surface_tension(path, service)#

Bases: TUIMenu

Enter the menu to set surface tension models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

turbulence_interaction(*args, **kwargs)#

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

turbulent_dispersion(*args, **kwargs)#

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

class virtual_mass(path, service)#

Bases: TUIMenu

Enter the menu to set virtual mass models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

wall_lubrication(*args, **kwargs)#

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

class interfacial_area(path, service)#

Bases: TUIMenu

Enter the menu to set interfacial area models.

Classes:

cavitation(path, service)

Enter the menu to set cavitation models.

interphase_discretization(path, service)

Enter the menu to set interphase discretization models.

interphase_viscous_dissipation(path, service)

Enter the menu to set interphase viscous dissipation related models.

lift(path, service)

Enter the menu to set lift models.

surface_tension(path, service)

Enter the menu to set surface tension models.

virtual_mass(path, service)

Enter the menu to set virtual mass models.

Methods:

drag(*args, **kwargs)

Specify the drag function for each pair of phases.

heat_coeff(*args, **kwargs)

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

interfacial_area(*args, **kwargs)

Set the interfacial area parameters for each pair of phases.

mass_transfer(*args, **kwargs)

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)

Set the model transition mechanism.

reactions(*args, **kwargs)

Define multiple heterogeneous reactions and stoichiometry.

restitution(*args, **kwargs)

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

slip_velocity(*args, **kwargs)

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

turbulence_interaction(*args, **kwargs)

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

turbulent_dispersion(*args, **kwargs)

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

wall_lubrication(*args, **kwargs)

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

Bases: TUIMenu

Enter the menu to set cavitation models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

drag(*args, **kwargs)#

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

heat_coeff(*args, **kwargs)#

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

interfacial_area(*args, **kwargs)#

Set the interfacial area parameters for each pair of phases.

class interphase_discretization(path, service)#

Bases: TUIMenu

Enter the menu to set interphase discretization models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class interphase_viscous_dissipation(path, service)#

Bases: TUIMenu

Enter the menu to set interphase viscous dissipation related models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class lift(path, service)#

Bases: TUIMenu

Enter the menu to set lift models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

mass_transfer(*args, **kwargs)#

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)#

Set the model transition mechanism.

reactions(*args, **kwargs)#

Define multiple heterogeneous reactions and stoichiometry.

restitution(*args, **kwargs)#

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

slip_velocity(*args, **kwargs)#

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

class surface_tension(path, service)#

Bases: TUIMenu

Enter the menu to set surface tension models.

Methods:

cavitation(*args, **kwargs)

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

interphase_discr(*args, **kwargs)

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

interphase_visc_disp(*args, **kwargs)

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

jump_adhesion(*args, **kwargs)

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

lift(*args, **kwargs)

.

lift_montoya(*args, **kwargs)

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)

Select the surface tension model.

sfc_modeling(*args, **kwargs)

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

sfc_tension_coeff(*args, **kwargs)

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)

Specify the slope limiter to set a specific discretization scheme.

virtual_mass(*args, **kwargs)

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

visc_disp_factor(*args, **kwargs)

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)

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

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

interphase_discr(*args, **kwargs)#

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

interphase_visc_disp(*args, **kwargs)#

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

jump_adhesion(*args, **kwargs)#

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

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

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

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

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

virtual_mass(*args, **kwargs)#

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

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

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.

noniterative_time_advance(*args, **kwargs)#

Enable/disable the noniterative time advancement scheme.

nox(*args, **kwargs)#

Enable/disable the NOx model.

class nox_parameters(path, service)#

Bases: TUIMenu

Enter the NOx parameters menu.

Methods:

inlet_diffusion(*args, **kwargs)

Enable/disable inclusion of diffusion at inlets.

nox_chemistry(*args, **kwargs)

Select NOx chemistry model.

nox_expert(*args, **kwargs)

Select additional nox equations.

nox_turbulence_interaction(*args, **kwargs)

Set NOx-turbulence interaction model.
inlet_diffusion(*args, **kwargs)#

Enable/disable inclusion of diffusion at inlets.

nox_chemistry(*args, **kwargs)#

Select NOx chemistry model.

nox_expert(*args, **kwargs)#

Select additional nox equations.

nox_turbulence_interaction(*args, **kwargs)#

Set NOx-turbulence interaction model.

class optics(path, service)#

Bases: TUIMenu

Enter the optics model menu.

Classes:

beams(path, service)

.

statistics(path, service)

.

Methods:

enable(*args, **kwargs)

.

index_of_refraction(*args, **kwargs)

.

report(*args, **kwargs)

.

sampling_iterations(*args, **kwargs)

.

verbosity(*args, **kwargs)

.
class beams(path, service)#

Bases: TUIMenu

.

Methods:

add(*args, **kwargs)

Create a new beams object.

copy(*args, **kwargs)

.

delete(*args, **kwargs)

Delete object.

edit(*args, **kwargs)

Edit beams object.

list_beam_parameters(*args, **kwargs)

.

rename(*args, **kwargs)

Rename object.
add(*args, **kwargs)#

Create a new beams object.

copy(*args, **kwargs)#

.

delete(*args, **kwargs)#

Delete object.

edit(*args, **kwargs)#

Edit beams object.

list_beam_parameters(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename object.

enable(*args, **kwargs)#

.

index_of_refraction(*args, **kwargs)#

.

report(*args, **kwargs)#

.

sampling_iterations(*args, **kwargs)#

.

class statistics(path, service)#

Bases: TUIMenu

.

Methods:

reset_statistics(*args, **kwargs)

.

statistics_controls(*args, **kwargs)

.
reset_statistics(*args, **kwargs)#

.

statistics_controls(*args, **kwargs)#

.

verbosity(*args, **kwargs)#

.

potential_and_li_ion_battery(*args, **kwargs)#

Enable/disable the electric-potential model.

class radiation(path, service)#

Bases: TUIMenu

Enter the radiation models menu.

Methods:

apply_full_solar_irradiation(*args, **kwargs)

Enable/disable application of solar irradiation to first band with DO model.

beta_radiation_features(*args, **kwargs)

Enable Radiation Models with Non-Iterative Time Advancement (NITA) as Beta features in FL12.0.

blending_factor(*args, **kwargs)

Set numeric option for Discrete Ordinate model.

discrete_ordinates(*args, **kwargs)

Enable/disable the discrete ordinates radiation model.

discrete_transfer(*args, **kwargs)

Enable/disable discrete the transfer radiation model.

do_acceleration(*args, **kwargs)

Enable/disable acceleration of computation of DO model.

do_coupling(*args, **kwargs)

Enabled DO Energy Coupling.

fast_second_order_discrete_ordinate(*args, ...)

Enable/disable the fast-second-order option for Discrete Ordinate Model.

mc_model_parameters(*args, **kwargs)

Set parameters for montecarlo radiation model.

mc_under_relaxation(*args, **kwargs)

Set under-relaxation factor for montecarlo radiation sources used in the energy equation.

method_partially_specular_wall(*args, **kwargs)

Set method for partially specular wall with discrete ordinate model.

montecarlo(*args, **kwargs)

Enable/disable the Monte Carlo radiation model.

non_gray_model_parameters(*args, **kwargs)

Set parameters for non-gray model.

p1(*args, **kwargs)

Enable/disable the P1 radiation model.

radiation_iteration_parameters(*args, **kwargs)

Set iteration parameters for radiation models.

radiation_model_parameters(*args, **kwargs)

Set parameters for radiation models.

rosseland(*args, **kwargs)

Enable/disable the Rosseland radiation model.

s2s(*args, **kwargs)

Enable/disable the S2S radiation model.

solar(*args, **kwargs)

Enable/disable the solar model.

solar_calculator(*args, **kwargs)

Calculate sun direction and intensity.

solar_irradiation(*args, **kwargs)

Enable/disable the Solar irradiation model.

solution_method_for_do_coupling(*args, **kwargs)

Enable the solution method for DO/Energy Coupling.

target_cells_per_volume_cluster(*args, **kwargs)

Enter cells per volume cluster for Monte Carlo radiation model.

wsggm_cell_based(*args, **kwargs)

Enable/disable WSGGM cell based method.

Classes:

dtrm_parameters(path, service)

Enter the DTRM parameters menu.

s2s_parameters(path, service)

Enter the S2S parameters menu.

solar_parameters(path, service)

Enter the solar parameters menu.
apply_full_solar_irradiation(*args, **kwargs)#

Enable/disable application of solar irradiation to first band with DO model.

beta_radiation_features(*args, **kwargs)#

Enable Radiation Models with Non-Iterative Time Advancement (NITA) as Beta features in FL12.0.

blending_factor(*args, **kwargs)#

Set numeric option for Discrete Ordinate model.

discrete_ordinates(*args, **kwargs)#

Enable/disable the discrete ordinates radiation model.

discrete_transfer(*args, **kwargs)#

Enable/disable discrete the transfer radiation model.

do_acceleration(*args, **kwargs)#

Enable/disable acceleration of computation of DO model.

do_coupling(*args, **kwargs)#

Enabled DO Energy Coupling.

class dtrm_parameters(path, service)#

Bases: TUIMenu

Enter the DTRM parameters menu.

Methods:

check_ray_file(*args, **kwargs)

Read DTRM rays file.

controls(*args, **kwargs)

Set DTRM solution controls.

make_globs(*args, **kwargs)

Make globs (coarser mesh) for radiation.

ray_trace(*args, **kwargs)

Create DTRM rays for radiation.
check_ray_file(*args, **kwargs)#

Read DTRM rays file.

controls(*args, **kwargs)#

Set DTRM solution controls.

make_globs(*args, **kwargs)#

Make globs (coarser mesh) for radiation.

ray_trace(*args, **kwargs)#

Create DTRM rays for radiation.

fast_second_order_discrete_ordinate(*args, **kwargs)#

Enable/disable the fast-second-order option for Discrete Ordinate Model.

mc_model_parameters(*args, **kwargs)#

Set parameters for montecarlo radiation model.

mc_under_relaxation(*args, **kwargs)#

Set under-relaxation factor for montecarlo radiation sources used in the energy equation.

method_partially_specular_wall(*args, **kwargs)#

Set method for partially specular wall with discrete ordinate model.

montecarlo(*args, **kwargs)#

Enable/disable the Monte Carlo radiation model.

non_gray_model_parameters(*args, **kwargs)#

Set parameters for non-gray model.

p1(*args, **kwargs)#

Enable/disable the P1 radiation model.

radiation_iteration_parameters(*args, **kwargs)#

Set iteration parameters for radiation models.

radiation_model_parameters(*args, **kwargs)#

Set parameters for radiation models.

rosseland(*args, **kwargs)#

Enable/disable the Rosseland radiation model.

s2s(*args, **kwargs)#

Enable/disable the S2S radiation model.

class s2s_parameters(path, service)#

Bases: TUIMenu

Enter the S2S parameters menu.

Methods:

compute_clusters_and_vf_accelerated(*args, ...)

Compute/Write surface cluster first and then view factors.

compute_fpsc_values(*args, **kwargs)

Compute only fpsc values based on current settings.

compute_vf_accelerated(*args, **kwargs)

Compute/Write view factors from existing surface clusters.

compute_vf_only(*args, **kwargs)

Compute/write view factors only.

compute_write_vf(*args, **kwargs)

Compute/write surface clusters and view factors for S2S radiation model.

enable_mesh_interface_clustering(*args, **kwargs)

Enable clustering on mesh interfaces?.

non_participating_boundary_zones_temperature(...)

Set temperature for the non-participating boundary zones.

print_thread_clusters(*args, **kwargs)

Prints the following for all boundary threads: thread-id, number of faces, faces per surface cluster, and the number of surface clusters.

print_zonewise_radiation(*args, **kwargs)

Prints the zonewise incoming radiation, viewfactors, and average temperature.

read_vf_file(*args, **kwargs)

Read an S2S file.

set_global_faces_per_surface_cluster(*args, ...)

Set global value of faces per surface cluster for all boundary zones.

set_vf_parameters(*args, **kwargs)

Set the parameters needed for the view factor calculations.

split_angle(*args, **kwargs)

Set the split angle for the clustering algorithm.

use_new_cluster_algorithm(*args, **kwargs)

Use the new surface clustering algorithm.

use_old_cluster_algorithm(*args, **kwargs)

Use the old surface clustering algorithm.
compute_clusters_and_vf_accelerated(*args, **kwargs)#

Compute/Write surface cluster first and then view factors.

compute_fpsc_values(*args, **kwargs)#

Compute only fpsc values based on current settings.

compute_vf_accelerated(*args, **kwargs)#

Compute/Write view factors from existing surface clusters.

compute_vf_only(*args, **kwargs)#

Compute/write view factors only.

compute_write_vf(*args, **kwargs)#

Compute/write surface clusters and view factors for S2S radiation model.

enable_mesh_interface_clustering(*args, **kwargs)#

Enable clustering on mesh interfaces?.

non_participating_boundary_zones_temperature(*args, **kwargs)#

Set temperature for the non-participating boundary zones.

print_thread_clusters(*args, **kwargs)#

Prints the following for all boundary threads: thread-id, number of faces, faces per surface cluster, and the number of surface clusters.

print_zonewise_radiation(*args, **kwargs)#

Prints the zonewise incoming radiation, viewfactors, and average temperature.

read_vf_file(*args, **kwargs)#

Read an S2S file.

set_global_faces_per_surface_cluster(*args, **kwargs)#

Set global value of faces per surface cluster for all boundary zones.

set_vf_parameters(*args, **kwargs)#

Set the parameters needed for the view factor calculations.

split_angle(*args, **kwargs)#

Set the split angle for the clustering algorithm.

use_new_cluster_algorithm(*args, **kwargs)#

Use the new surface clustering algorithm.

use_old_cluster_algorithm(*args, **kwargs)#

Use the old surface clustering algorithm.

solar(*args, **kwargs)#

Enable/disable the solar model.

solar_calculator(*args, **kwargs)#

Calculate sun direction and intensity.

solar_irradiation(*args, **kwargs)#

Enable/disable the Solar irradiation model.

class solar_parameters(path, service)#

Bases: TUIMenu

Enter the solar parameters menu.

Methods:

autoread_solar_data(*args, **kwargs)

Set autoread solar data parameters.

autosave_solar_data(*args, **kwargs)

Set autosave solar data parameters.

ground_reflectivity(*args, **kwargs)

Set ground reflectivity parameters.

illumination_parameters(*args, **kwargs)

Set illumination parameters.

iteration_parameters(*args, **kwargs)

Set update parameters.

quad_tree_parameters(*args, **kwargs)

Set quad-tree refinement parameters.

scattering_fraction(*args, **kwargs)

Set scattering fraction parameters.

sol_adjacent_fluidcells(*args, **kwargs)

Enable solar load for adjacent fluid cells.

sol_camera_pos(*args, **kwargs)

Set camera position based on sun direction vector.

sol_on_demand(*args, **kwargs)

Enable solar load on demand.

solar_thread_control(*args, **kwargs)

Solar thread control.

sun_direction_vector(*args, **kwargs)

Set sun direction vector.

use_direction_from_sol_calc(*args, **kwargs)

Set direction computed from solar calculator.
autoread_solar_data(*args, **kwargs)#

Set autoread solar data parameters.

autosave_solar_data(*args, **kwargs)#

Set autosave solar data parameters.

ground_reflectivity(*args, **kwargs)#

Set ground reflectivity parameters.

illumination_parameters(*args, **kwargs)#

Set illumination parameters.

iteration_parameters(*args, **kwargs)#

Set update parameters.

quad_tree_parameters(*args, **kwargs)#

Set quad-tree refinement parameters.

scattering_fraction(*args, **kwargs)#

Set scattering fraction parameters.

sol_adjacent_fluidcells(*args, **kwargs)#

Enable solar load for adjacent fluid cells.

sol_camera_pos(*args, **kwargs)#

Set camera position based on sun direction vector.

sol_on_demand(*args, **kwargs)#

Enable solar load on demand.

solar_thread_control(*args, **kwargs)#

Solar thread control.

sun_direction_vector(*args, **kwargs)#

Set sun direction vector.

use_direction_from_sol_calc(*args, **kwargs)#

Set direction computed from solar calculator.

solution_method_for_do_coupling(*args, **kwargs)#

Enable the solution method for DO/Energy Coupling.

target_cells_per_volume_cluster(*args, **kwargs)#

Enter cells per volume cluster for Monte Carlo radiation model.

wsggm_cell_based(*args, **kwargs)#

Enable/disable WSGGM cell based method.

class shell_conduction(path, service)#

Bases: TUIMenu

Enter the shell conduction model menu.

Methods:

enhanced_encapsulation(*args, **kwargs)

Enable/disable enhanced encapsulation for shell conduction and S2S models.

multi_layer_shell(*args, **kwargs)

Enable/disable multi layer shell conduction model.

read_csv(*args, **kwargs)

Read shell conduction settings from a csv file.

save_shell_zones(*args, **kwargs)

Enable/Disable saving shell zones to case file.

settings(*args, **kwargs)

Enter Multi-layer Shell Conduction data.

write_csv(*args, **kwargs)

Write shell conduction settings to a csv file.
enhanced_encapsulation(*args, **kwargs)#

Enable/disable enhanced encapsulation for shell conduction and S2S models. This is not applicable if coupled sliding interface walls exists.

multi_layer_shell(*args, **kwargs)#

Enable/disable multi layer shell conduction model.

read_csv(*args, **kwargs)#

Read shell conduction settings from a csv file.

save_shell_zones(*args, **kwargs)#

Enable/Disable saving shell zones to case file.

settings(*args, **kwargs)#

Enter Multi-layer Shell Conduction data.

write_csv(*args, **kwargs)#

Write shell conduction settings to a csv file.

solidification_melting(*args, **kwargs)#

Enable/disable the solidification and melting model.

class solver(path, service)#

Bases: TUIMenu

Enter the menu to select the solver.

Methods:

adjust_solver_defaults_based_on_setup(*args, ...)

Enable/disable adjustment of solver defaults based on setup.

density_based_explicit(*args, **kwargs)

Enable/disable the coupled-explicit solver.

density_based_implicit(*args, **kwargs)

Enable/disable the coupled-implicit solver.

pressure_based(*args, **kwargs)

Enable/disable the segregated solver.
adjust_solver_defaults_based_on_setup(*args, **kwargs)#

Enable/disable adjustment of solver defaults based on setup.

density_based_explicit(*args, **kwargs)#

Enable/disable the coupled-explicit solver.

density_based_implicit(*args, **kwargs)#

Enable/disable the coupled-implicit solver.

pressure_based(*args, **kwargs)#

Enable/disable the segregated solver.

soot(*args, **kwargs)#

Enable/disable the soot model.

class soot_parameters(path, service)#

Bases: TUIMenu

Enter the soot parameters menu.

Methods:

inlet_diffusion(*args, **kwargs)

Enable/disable inclusion of diffusion at inlets.

modify_schmidt_number(*args, **kwargs)

Change Turbulent Schmidt Number for Soot/Nuclei Equations.

soot_model_parameters(*args, **kwargs)

Enter the soot model parameters menu.

soot_model_udfs(*args, **kwargs)

User defined functions for soot model.

soot_process_parameters(*args, **kwargs)

Set soot process parameters.

soot_radiation_interaction(*args, **kwargs)

Enable/disable the soot-radiation interaction model.

soot_turbulence_interaction(*args, **kwargs)

Set Soot-turbulence interaction model.
inlet_diffusion(*args, **kwargs)#

Enable/disable inclusion of diffusion at inlets.

modify_schmidt_number(*args, **kwargs)#

Change Turbulent Schmidt Number for Soot/Nuclei Equations.

soot_model_parameters(*args, **kwargs)#

Enter the soot model parameters menu.

soot_model_udfs(*args, **kwargs)#

User defined functions for soot model.

soot_process_parameters(*args, **kwargs)#

Set soot process parameters.

soot_radiation_interaction(*args, **kwargs)#

Enable/disable the soot-radiation interaction model.

soot_turbulence_interaction(*args, **kwargs)#

Set Soot-turbulence interaction model.

class species(path, service)#

Bases: TUIMenu

Enter the species models menu.

Methods:

CHEMKIN_CFD(*args, **kwargs)

Enable/disable CHEMKIN-CFD.

clear_isat_table(*args, **kwargs)

Clear the ISAT table.

coal_calculator(*args, **kwargs)

Set up coal modeling inputs.

combustion_expert(*args, **kwargs)

Set combustion expert parameters.

combustion_numerics(*args, **kwargs)

Set combustion numerics options.

decoupled_detailed_chemistry(*args, **kwargs)

Enable/disable the Decoupled Detailed Chemistry model.

diffusion_energy_source(*args, **kwargs)

Enable/disable diffusion energy source.

electro_chemical_surface_reactions(*args, ...)

Enable/disable electrochemical surface reactions.

epdf_energy(*args, **kwargs)

Enable/disable EPDF energy option.

flamelet_expert(*args, **kwargs)

Set flamelet expert parameters.

full_tabulation(*args, **kwargs)

Enable/disable building of a full 2 mixture fraction table.

heat_of_surface_reactions(*args, **kwargs)

Enable/disable heat of surface reactions.

ignition_model(*args, **kwargs)

Enable/disable the ignition model.

ignition_model_controls(*args, **kwargs)

Set ignition model parameters.

import_flamelet_for_restart(*args, **kwargs)

Import Flamelet File for Restart.

inert_transport_controls(*args, **kwargs)

Set inert transport model parameters.

inert_transport_model(*args, **kwargs)

Enable/disable the inert transport model.

init_unsteady_flamelet_prob(*args, **kwargs)

Initialize Unsteady Flamelet Probability.

inlet_diffusion(*args, **kwargs)

Enable/disable inclusion of diffusion at inlets.

integration_parameters(*args, **kwargs)

Set ISAT parameters.

liquid_energy_diffusion(*args, **kwargs)

Enable/disable energy diffusion for liquid regime.

liquid_micro_mixing(*args, **kwargs)

Enable/disable liquid micro mixing option.

mass_deposition_source(*args, **kwargs)

Enable/disable mass deposition source due to surface reactions.

mixing_model(*args, **kwargs)

Set PDF transport mixing model.

multicomponent_diffusion(*args, **kwargs)

Enable/disable multicomponent diffusion.

non_premixed_combustion(*args, **kwargs)

Enable/disable the non-premixed combustion model.

non_premixed_combustion_expert(*args, **kwargs)

Set PDF expert parameters.

non_premixed_combustion_parameters(*args, ...)

Set PDF parameters.

off(*args, **kwargs)

Enable/disable solution of species models.

partially_premixed_combustion(*args, **kwargs)

Enable/disable partially premixed combustion model.

partially_premixed_combustion_expert(*args, ...)

Set PDF expert parameters.

partially_premixed_combustion_grids(*args, ...)

Set user specified grid parameters for PDF and flamelet.

partially_premixed_combustion_parameters(...)

Set PDF parameters.

partially_premixed_properties(*args, **kwargs)

Set/Change partially premixed mixture properties.

particle_surface_reactions(*args, **kwargs)

Enable/disable particle surface reactions.

pdf_transport(*args, **kwargs)

Enable/disable the composition PDF transport combustion model.

pdf_transport_expert(*args, **kwargs)

Enable/disable PDF transport expert user.

premixed_combustion(*args, **kwargs)

Enable/disable the premixed combustion model.

premixed_model(*args, **kwargs)

Set premixed combustion model.

re_calc_par_premix_props(*args, **kwargs)

Re-calculate partially-premixed properties.

reacting_channel_model(*args, **kwargs)

Enable/Disable the Reacting Channel Model.

reacting_channel_model_options(*args, **kwargs)

Set Reacting Channel Model parameters.

reaction_diffusion_balance(*args, **kwargs)

Enable/disable reaction diffusion balance at reacting surface for surface reactions.

reactor_network_model(*args, **kwargs)

Enable/disable the Reactor Network model.

relax_to_equil(*args, **kwargs)

Enable/disable the Relaxation to Chemical Equilibrium model.

save_gradients(*args, **kwargs)

Enable/disable storage of species mass fraction gradients.

set_multi_regime_fgm(*args, **kwargs)

Set-multi-regim-fgm-parameters.

set_premixed_combustion(*args, **kwargs)

Set premixed combustion parameters.

set_turb_chem_interaction(*args, **kwargs)

Set Eddy-Dissipation Concept model constants.

spark_model(*args, **kwargs)

Set spark model parameters.

species_migration(*args, **kwargs)

Enable/disable ion species migration in electric field.

species_transport(*args, **kwargs)

Enable/disable the species transport model.

species_transport_expert(*args, **kwargs)

Set species transport expert options.

stiff_chemistry(*args, **kwargs)

Enable/disable stiff chemistry option.

surf_reaction_aggressiveness_factor(*args, ...)

Set the surface reaction aggressiveness factor.

surf_reaction_netm_params(*args, **kwargs)

Set the surface reaction parameters for the Non-Equilibrium Thermal Model.

thermal_diffusion(*args, **kwargs)

Enable/disable thermal diffusion.

thickened_flame_model(*args, **kwargs)

Enable/disable the Relaxation to Chemical Equilibrium model.

volumetric_reactions(*args, **kwargs)

Enable/disable volumetric reactions.

wall_surface_reactions(*args, **kwargs)

Enable/disable wall surface reactions.

Classes:

CHEMKIN_CFD_parameters(path, service)

Enter the expert CHEMKIN-CFD parameters menu.
CHEMKIN_CFD(*args, **kwargs)#

Enable/disable CHEMKIN-CFD.

class CHEMKIN_CFD_parameters(path, service)#

Bases: TUIMenu

Enter the expert CHEMKIN-CFD parameters menu.

Methods:

add_cell_monitor(*args, **kwargs)

Add a monitor cell for debug output.

advanced_options(*args, **kwargs)

Set advanced parameter options.

basic_options(*args, **kwargs)

Set basic parameter options.

delete_cell_monitors(*args, **kwargs)

Delete cell monitors.

list_cell_monitors(*args, **kwargs)

List cell monitors.
add_cell_monitor(*args, **kwargs)#

Add a monitor cell for debug output.

advanced_options(*args, **kwargs)#

Set advanced parameter options.

basic_options(*args, **kwargs)#

Set basic parameter options.

delete_cell_monitors(*args, **kwargs)#

Delete cell monitors.

list_cell_monitors(*args, **kwargs)#

List cell monitors.

clear_isat_table(*args, **kwargs)#

Clear the ISAT table.

coal_calculator(*args, **kwargs)#

Set up coal modeling inputs.

combustion_expert(*args, **kwargs)#

Set combustion expert parameters.

combustion_numerics(*args, **kwargs)#

Set combustion numerics options.

decoupled_detailed_chemistry(*args, **kwargs)#

Enable/disable the Decoupled Detailed Chemistry model.

diffusion_energy_source(*args, **kwargs)#

Enable/disable diffusion energy source.

electro_chemical_surface_reactions(*args, **kwargs)#

Enable/disable electrochemical surface reactions.

epdf_energy(*args, **kwargs)#

Enable/disable EPDF energy option.

flamelet_expert(*args, **kwargs)#

Set flamelet expert parameters.

full_tabulation(*args, **kwargs)#

Enable/disable building of a full 2 mixture fraction table.

heat_of_surface_reactions(*args, **kwargs)#

Enable/disable heat of surface reactions.

ignition_model(*args, **kwargs)#

Enable/disable the ignition model.

ignition_model_controls(*args, **kwargs)#

Set ignition model parameters.

import_flamelet_for_restart(*args, **kwargs)#

Import Flamelet File for Restart.

inert_transport_controls(*args, **kwargs)#

Set inert transport model parameters.

inert_transport_model(*args, **kwargs)#

Enable/disable the inert transport model.

init_unsteady_flamelet_prob(*args, **kwargs)#

Initialize Unsteady Flamelet Probability.

inlet_diffusion(*args, **kwargs)#

Enable/disable inclusion of diffusion at inlets.

integration_parameters(*args, **kwargs)#

Set ISAT parameters.

liquid_energy_diffusion(*args, **kwargs)#

Enable/disable energy diffusion for liquid regime.

liquid_micro_mixing(*args, **kwargs)#

Enable/disable liquid micro mixing option.

mass_deposition_source(*args, **kwargs)#

Enable/disable mass deposition source due to surface reactions.

mixing_model(*args, **kwargs)#

Set PDF transport mixing model.

multicomponent_diffusion(*args, **kwargs)#

Enable/disable multicomponent diffusion.

non_premixed_combustion(*args, **kwargs)#

Enable/disable the non-premixed combustion model.

non_premixed_combustion_expert(*args, **kwargs)#

Set PDF expert parameters.

non_premixed_combustion_parameters(*args, **kwargs)#

Set PDF parameters.

off(*args, **kwargs)#

Enable/disable solution of species models.

partially_premixed_combustion(*args, **kwargs)#

Enable/disable partially premixed combustion model.

partially_premixed_combustion_expert(*args, **kwargs)#

Set PDF expert parameters.

partially_premixed_combustion_grids(*args, **kwargs)#

Set user specified grid parameters for PDF and flamelet.

partially_premixed_combustion_parameters(*args, **kwargs)#

Set PDF parameters.

partially_premixed_properties(*args, **kwargs)#

Set/Change partially premixed mixture properties.

particle_surface_reactions(*args, **kwargs)#

Enable/disable particle surface reactions.

pdf_transport(*args, **kwargs)#

Enable/disable the composition PDF transport combustion model.

pdf_transport_expert(*args, **kwargs)#

Enable/disable PDF transport expert user.

premixed_combustion(*args, **kwargs)#

Enable/disable the premixed combustion model.

premixed_model(*args, **kwargs)#

Set premixed combustion model.

re_calc_par_premix_props(*args, **kwargs)#

Re-calculate partially-premixed properties.

reacting_channel_model(*args, **kwargs)#

Enable/Disable the Reacting Channel Model.

reacting_channel_model_options(*args, **kwargs)#

Set Reacting Channel Model parameters.

reaction_diffusion_balance(*args, **kwargs)#

Enable/disable reaction diffusion balance at reacting surface for surface reactions.

reactor_network_model(*args, **kwargs)#

Enable/disable the Reactor Network model.

relax_to_equil(*args, **kwargs)#

Enable/disable the Relaxation to Chemical Equilibrium model.

save_gradients(*args, **kwargs)#

Enable/disable storage of species mass fraction gradients.

set_multi_regime_fgm(*args, **kwargs)#

Set-multi-regim-fgm-parameters.

set_premixed_combustion(*args, **kwargs)#

Set premixed combustion parameters.

set_turb_chem_interaction(*args, **kwargs)#

Set Eddy-Dissipation Concept model constants.

spark_model(*args, **kwargs)#

Set spark model parameters.

species_migration(*args, **kwargs)#

Enable/disable ion species migration in electric field.

species_transport(*args, **kwargs)#

Enable/disable the species transport model.

species_transport_expert(*args, **kwargs)#

Set species transport expert options.

stiff_chemistry(*args, **kwargs)#

Enable/disable stiff chemistry option.

surf_reaction_aggressiveness_factor(*args, **kwargs)#

Set the surface reaction aggressiveness factor.

surf_reaction_netm_params(*args, **kwargs)#

Set the surface reaction parameters for the Non-Equilibrium Thermal Model.

thermal_diffusion(*args, **kwargs)#

Enable/disable thermal diffusion.

thickened_flame_model(*args, **kwargs)#

Enable/disable the Relaxation to Chemical Equilibrium model.

volumetric_reactions(*args, **kwargs)#

Enable/disable volumetric reactions.

wall_surface_reactions(*args, **kwargs)#

Enable/disable wall surface reactions.

steady(*args, **kwargs)#

Enable/disable the steady solution model.

class structure(path, service)#

Bases: TUIMenu

Enter the structure model menu.

Classes:

controls(path, service)

Enter the structure controls menu.

expert(path, service)

Enter the structure expert menu.

Methods:

linear_elasticity(*args, **kwargs)

Enable the linear elasticity model.

nonlinear_elasticity(*args, **kwargs)

Enable the nonlinear elasticity model.

structure_off(*args, **kwargs)

Disable the structural model.

thermal_effects(*args, **kwargs)

Enable structure thermal effects.
class controls(path, service)#

Bases: TUIMenu

Enter the structure controls menu.

Methods:

amg_stabilization(*args, **kwargs)

Set the AMG stabilization method for structural solver.

enhanced_strain(*args, **kwargs)

Enable enhanced strain element.

max_iter(*args, **kwargs)

Set the maximum number of iterations for structural solver.

numerical_damping_factor(*args, **kwargs)

Set structure damping parameters.

unsteady_damping_rayleigh(*args, **kwargs)

Enable/disable Newmark unsteady solution model.
amg_stabilization(*args, **kwargs)#

Set the AMG stabilization method for structural solver.

enhanced_strain(*args, **kwargs)#

Enable enhanced strain element.

max_iter(*args, **kwargs)#

Set the maximum number of iterations for structural solver.

numerical_damping_factor(*args, **kwargs)#

Set structure damping parameters.

unsteady_damping_rayleigh(*args, **kwargs)#

Enable/disable Newmark unsteady solution model.

class expert(path, service)#

Bases: TUIMenu

Enter the structure expert menu.

Methods:

explicit_fsi_force(*args, **kwargs)

Enable explicit fsi force.

include_pop_in_fsi_force(*args, **kwargs)

Enable inclusion of operating p into fsi force.

include_viscous_fsi_force(*args, **kwargs)

Enable inclusion of viscous fsi force.

starting_t_re_initialization(*args, **kwargs)

Set starting T-field re-initialization method.

steady_2way_fsi(*args, **kwargs)

Enable steady 2-way fsi workflow.
explicit_fsi_force(*args, **kwargs)#

Enable explicit fsi force.

include_pop_in_fsi_force(*args, **kwargs)#

Enable inclusion of operating p into fsi force.

include_viscous_fsi_force(*args, **kwargs)#

Enable inclusion of viscous fsi force.

starting_t_re_initialization(*args, **kwargs)#

Set starting T-field re-initialization method.

steady_2way_fsi(*args, **kwargs)#

Enable steady 2-way fsi workflow.

linear_elasticity(*args, **kwargs)#

Enable the linear elasticity model.

nonlinear_elasticity(*args, **kwargs)#

Enable the nonlinear elasticity model.

structure_off(*args, **kwargs)#

Disable the structural model.

thermal_effects(*args, **kwargs)#

Enable structure thermal effects.

swirl(*args, **kwargs)#

Enable/disable axisymmetric swirl velocity.

class system_coupling_settings(path, service)#

Bases: TUIMenu

Enter the system coupling model menu.

Classes:

htc(path, service)

Enter the heat transfer coeficient menu.

Methods:

specify_system_coupling_volumetric_cell_zones(...)

Enable/disable volumetric cell zones.

update_rigid_body_mesh_motion_before_mesh_transfer(...)

SC Enable/disable mesh motion.

use_face_or_element_based_data_transfer(...)

Enable/disable face based data transfer.
class htc(path, service)#

Bases: TUIMenu

Enter the heat transfer coeficient menu.

Classes:

htc_calculation_method(path, service)

Enter the htc calculation menu.

unsteady_statistics(path, service)

Enter the unsteady statistics menu.
class htc_calculation_method(path, service)#

Bases: TUIMenu

Enter the htc calculation menu.

Methods:

use_tref_in_htc_calculation(*args, **kwargs)

Enable/disable tref in htc computation.

use_wall_function_based_htc(*args, **kwargs)

Enable/disable wall function based htc computation.

use_yplus_based_htc_calculation(*args, **kwargs)

Enable/disable yplus in htc computation.
use_tref_in_htc_calculation(*args, **kwargs)#

Enable/disable tref in htc computation.

use_wall_function_based_htc(*args, **kwargs)#

Enable/disable wall function based htc computation.

use_yplus_based_htc_calculation(*args, **kwargs)#

Enable/disable yplus in htc computation.

class unsteady_statistics(path, service)#

Bases: TUIMenu

Enter the unsteady statistics menu.

Methods:

sc_enable_sub_stepping_option_per_coupling_step(...)

Enable/disable sub stepping option per coupling step.
sc_enable_sub_stepping_option_per_coupling_step(*args, **kwargs)#

Enable/disable sub stepping option per coupling step.

specify_system_coupling_volumetric_cell_zones(*args, **kwargs)#

Enable/disable volumetric cell zones.

update_rigid_body_mesh_motion_before_mesh_transfer(*args, **kwargs)#

SC Enable/disable mesh motion.

use_face_or_element_based_data_transfer(*args, **kwargs)#

Enable/disable face based data transfer.

class two_temperature(path, service)#

Bases: TUIMenu

Define two-temperature model menu.

Methods:

enable(*args, **kwargs)

Enable/disable the two-temperature model.

nasa9_enhancement(*args, **kwargs)

Apply nasa9 robustness enhancements in the two-temperature model.

robustness_enhancement(*args, **kwargs)

Apply robustness enhancements in the two-temperature model.

set_verbosity(*args, **kwargs)

Set two-temperature model verbosity option.

weak_ionization(*args, **kwargs)

Apply weak ionization in the two-temperature model.
enable(*args, **kwargs)#

Enable/disable the two-temperature model.

nasa9_enhancement(*args, **kwargs)#

Apply nasa9 robustness enhancements in the two-temperature model.

robustness_enhancement(*args, **kwargs)#

Apply robustness enhancements in the two-temperature model.

set_verbosity(*args, **kwargs)#

Set two-temperature model verbosity option.

weak_ionization(*args, **kwargs)#

Apply weak ionization in the two-temperature model.

unsteady_1st_order(*args, **kwargs)#

Enable/disable first-order unsteady solution model.

unsteady_2nd_order(*args, **kwargs)#

Enable/disable the second-order unsteady solution model.

unsteady_2nd_order_bounded(*args, **kwargs)#

Enable/disable bounded second-order unsteady formulation.

unsteady_global_time(*args, **kwargs)#

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

unsteady_structure_euler(*args, **kwargs)#

Enable/disable Backward Euler unsteady solution model.

unsteady_structure_newmark(*args, **kwargs)#

Enable/disable Newmark unsteady solution model.

vbm(*args, **kwargs)#

Enable/disable Virtual Blade Model.

virtual_blade_model(*args, **kwargs)#

Enter VBM model menu.

class viscous(path, service)#

Bases: TUIMenu

Enter the viscous model menu.

Methods:

add_transition_model(*args, **kwargs)

Enable/disable a transition model to account for transitional effects.

corner_flow_correction(*args, **kwargs)

Enable/disable the corner flow correction.

corner_flow_correction_ccorner(*args, **kwargs)

Set the corner flow correction coefficient CCORNER.

curvature_correction(*args, **kwargs)

Enable/disable the curvature correction.

curvature_correction_ccurv(*args, **kwargs)

Set the curvature correction coefficient CCURV.

des_limiter_option(*args, **kwargs)

Select DES limiter option.

detached_eddy_simulation(*args, **kwargs)

Enable/disable detached eddy simulation.

inviscid(*args, **kwargs)

Enable/disable the inviscid flow model.

k_kl_w(*args, **kwargs)

Enable/disable the k-kl-omega turbulence model.

ke1e(*args, **kwargs)

Enable/disable the KE1E turbulence model.

ke_easm(*args, **kwargs)

Enable/disable the EASM k-epsilon turbulence model.

ke_realizable(*args, **kwargs)

Enable/disable the realizable k-epsilon turbulence model.

ke_rng(*args, **kwargs)

Enable/disable the RNG k-epsilon turbulence model.

ke_standard(*args, **kwargs)

Enable/disable the standard k-epsilon turbulence model.

kw_bsl(*args, **kwargs)

Enable/disable the BSL k-omega turbulence model.

kw_easm(*args, **kwargs)

Enable/disable the EASM k-omega turbulence model.

kw_geko(*args, **kwargs)

Enable/disable the GEKO turbulence model.

kw_low_re_correction(*args, **kwargs)

Enable/disable the k-omega low Re option.

kw_shear_correction(*args, **kwargs)

Enable/disable the k-omega shear-flow correction option.

kw_sst(*args, **kwargs)

Enable/disable the SST k-omega turbulence model.

kw_standard(*args, **kwargs)

Enable/disable the standard k-omega turbulence model.

kw_wj_bsl_earsm(*args, **kwargs)

Enable/disable the EASM k-omega turbulence model.

laminar(*args, **kwargs)

Enable/disable the laminar flow model.

large_eddy_simulation(*args, **kwargs)

Enable/disable large eddy simulation.

les_dynamic_energy_flux(*args, **kwargs)

Enable/disable the dynamic sub-grid scale turbulent Prandtl Number.

les_dynamic_scalar_flux(*args, **kwargs)

Enable/disable the dynamic sub-grid scale turbulent Schmidt Number.

les_subgrid_dynamic_fvar(*args, **kwargs)

Enable/disable the dynamic subgrid-scale mixture fraction variance model.

les_subgrid_rng(*args, **kwargs)

Enable/disable the RNG subgrid-scale model.

les_subgrid_smagorinsky(*args, **kwargs)

Enable/disable the Smagorinsky-Lilly subgrid-scale model.

les_subgrid_tke(*args, **kwargs)

Enable/disable the kinetic energy transport subgrid-scale model.

les_subgrid_wale(*args, **kwargs)

Enable/disable the WALE subgrid-scale model.

les_subgrid_wmles(*args, **kwargs)

Enable/disable the WMLES subgrid-scale model.

les_subgrid_wmles_s_minus_omega(*args, **kwargs)

Enable/disable the WMLES S-Omega subgrid-scale model.

low_pressure_boundary_slip(*args, **kwargs)

Enable/disable the slip boundary formulation for low-pressure gas systems.

mixing_length(*args, **kwargs)

Enable/disable the mixing-length (algebraic) turbulence model.

reynolds_stress_model(*args, **kwargs)

Enable/disable the RSM turbulence model.

rng_differential_visc(*args, **kwargs)

Enable/disable the differential-viscosity model.

rng_swirl_model(*args, **kwargs)

Enable/disable swirl corrections for rng-model.

rsm_bsl_based(*args, **kwargs)

Enable/disable the Stress-BSL model.

rsm_linear_pressure_strain(*args, **kwargs)

Enable/disable the linear pressure-strain model in RSM.

rsm_omega_based(*args, **kwargs)

Enable/disable the Stress-omega model.

rsm_or_earsm_geko_option(*args, **kwargs)

Enable/disable the GEKO option for RSM or EARSM.

rsm_solve_tke(*args, **kwargs)

Enable/disable the solution of T.K.E.

rsm_ssg_pressure_strain(*args, **kwargs)

Enable/disable the quadratic pressure-strain model in RSM.

rsm_wall_echo(*args, **kwargs)

Enable/disable wall-echo effects in RSM model.

sa_alternate_prod(*args, **kwargs)

Enable/disable strain/vorticity production in Spalart-Allmaras model.

sa_damping(*args, **kwargs)

Enable/disable the full low-Reynolds number form of Spalart-Allmaras model.

sa_enhanced_wall_treatment(*args, **kwargs)

Enable/disable the enhanced wall treatment for the Spalart-Allmaras model.

sas(*args, **kwargs)

Enable/disable the SAS turbulence model.

spalart_allmaras(*args, **kwargs)

Enable/disable the Spalart-Allmaras turbulence model.

trans_sst_roughness_correlation(*args, **kwargs)

Enable/disable the Transition-SST roughness correlation option.

transition_sst(*args, **kwargs)

Enable/disable the transition SST turbulence model.

turb_buoyancy_effects(*args, **kwargs)

Select buoyancy effects on turbulence.

turb_compressibility(*args, **kwargs)

Enable/disable the compressibility correction option.

user_defined(*args, **kwargs)

Select user-defined functions to define the turbulent viscosity and the turbulent Prandtl and Schmidt numbers.

user_defined_transition(*args, **kwargs)

Set user-defined transition correlations.

v2f(*args, **kwargs)

Enable/disable the V2F turbulence model.

zero_equation_hvac(*args, **kwargs)

Enable/disable the zero-equation HVAC turbulence model.

Classes:

geko_options(path, service)

Enter the GEKO options menu.

multiphase_turbulence(path, service)

Enter the multiphase turbulence menu.

near_wall_treatment(path, service)

Enter the near wall treatment menu.

transition_model_options(path, service)

Enter the transition model options menu.

turbulence_expert(path, service)

Enter the turbulence expert menu.
add_transition_model(*args, **kwargs)#

Enable/disable a transition model to account for transitional effects.

corner_flow_correction(*args, **kwargs)#

Enable/disable the corner flow correction.

corner_flow_correction_ccorner(*args, **kwargs)#

Set the corner flow correction coefficient CCORNER.

curvature_correction(*args, **kwargs)#

Enable/disable the curvature correction.

curvature_correction_ccurv(*args, **kwargs)#

Set the curvature correction coefficient CCURV.

des_limiter_option(*args, **kwargs)#

Select DES limiter option.

detached_eddy_simulation(*args, **kwargs)#

Enable/disable detached eddy simulation.

class geko_options(path, service)#

Bases: TUIMenu

Enter the GEKO options menu.

Methods:

blending_function(*args, **kwargs)

Set the GEKO model blending function.

cbf_lam(*args, **kwargs)

Set the GEKO model coefficient CBF_LAM.

cbf_tur(*args, **kwargs)

Set the GEKO model coefficient CBF_TUR.

cjet(*args, **kwargs)

Set the GEKO model coefficient CJET.

cjet_aux(*args, **kwargs)

Set the GEKO model coefficient CJET_AUX.

cmix(*args, **kwargs)

Set the GEKO model coefficient CMIX.

cnw(*args, **kwargs)

Set the GEKO model coefficient CNW.

cnw_sub(*args, **kwargs)

Set the GEKO model coefficient CNW_SUB.

creal(*args, **kwargs)

Set the GEKO model coefficient CREAL.

csep(*args, **kwargs)

Set the GEKO model coefficient CSEP.

geko_defaults(*args, **kwargs)

Set GEKO options to default.

wall_distance_free(*args, **kwargs)

Enable/disable wall-distance-free version of GEKO model.
blending_function(*args, **kwargs)#

Set the GEKO model blending function.

cbf_lam(*args, **kwargs)#

Set the GEKO model coefficient CBF_LAM.

cbf_tur(*args, **kwargs)#

Set the GEKO model coefficient CBF_TUR.

cjet(*args, **kwargs)#

Set the GEKO model coefficient CJET.

cjet_aux(*args, **kwargs)#

Set the GEKO model coefficient CJET_AUX.

cmix(*args, **kwargs)#

Set the GEKO model coefficient CMIX.

cnw(*args, **kwargs)#

Set the GEKO model coefficient CNW.

cnw_sub(*args, **kwargs)#

Set the GEKO model coefficient CNW_SUB.

creal(*args, **kwargs)#

Set the GEKO model coefficient CREAL.

csep(*args, **kwargs)#

Set the GEKO model coefficient CSEP.

geko_defaults(*args, **kwargs)#

Set GEKO options to default.

wall_distance_free(*args, **kwargs)#

Enable/disable wall-distance-free version of GEKO model.

inviscid(*args, **kwargs)#

Enable/disable the inviscid flow model.

k_kl_w(*args, **kwargs)#

Enable/disable the k-kl-omega turbulence model.

ke1e(*args, **kwargs)#

Enable/disable the KE1E turbulence model.

ke_easm(*args, **kwargs)#

Enable/disable the EASM k-epsilon turbulence model.

ke_realizable(*args, **kwargs)#

Enable/disable the realizable k-epsilon turbulence model.

ke_rng(*args, **kwargs)#

Enable/disable the RNG k-epsilon turbulence model.

ke_standard(*args, **kwargs)#

Enable/disable the standard k-epsilon turbulence model.

kw_bsl(*args, **kwargs)#

Enable/disable the BSL k-omega turbulence model.

kw_easm(*args, **kwargs)#

Enable/disable the EASM k-omega turbulence model.

kw_geko(*args, **kwargs)#

Enable/disable the GEKO turbulence model.

kw_low_re_correction(*args, **kwargs)#

Enable/disable the k-omega low Re option.

kw_shear_correction(*args, **kwargs)#

Enable/disable the k-omega shear-flow correction option.

kw_sst(*args, **kwargs)#

Enable/disable the SST k-omega turbulence model.

kw_standard(*args, **kwargs)#

Enable/disable the standard k-omega turbulence model.

kw_wj_bsl_earsm(*args, **kwargs)#

Enable/disable the EASM k-omega turbulence model.

laminar(*args, **kwargs)#

Enable/disable the laminar flow model.

large_eddy_simulation(*args, **kwargs)#

Enable/disable large eddy simulation.

les_dynamic_energy_flux(*args, **kwargs)#

Enable/disable the dynamic sub-grid scale turbulent Prandtl Number.

les_dynamic_scalar_flux(*args, **kwargs)#

Enable/disable the dynamic sub-grid scale turbulent Schmidt Number.

les_subgrid_dynamic_fvar(*args, **kwargs)#

Enable/disable the dynamic subgrid-scale mixture fraction variance model.

les_subgrid_rng(*args, **kwargs)#

Enable/disable the RNG subgrid-scale model.

les_subgrid_smagorinsky(*args, **kwargs)#

Enable/disable the Smagorinsky-Lilly subgrid-scale model.

les_subgrid_tke(*args, **kwargs)#

Enable/disable the kinetic energy transport subgrid-scale model.

les_subgrid_wale(*args, **kwargs)#

Enable/disable the WALE subgrid-scale model.

les_subgrid_wmles(*args, **kwargs)#

Enable/disable the WMLES subgrid-scale model.

les_subgrid_wmles_s_minus_omega(*args, **kwargs)#

Enable/disable the WMLES S-Omega subgrid-scale model.

low_pressure_boundary_slip(*args, **kwargs)#

Enable/disable the slip boundary formulation for low-pressure gas systems.

mixing_length(*args, **kwargs)#

Enable/disable the mixing-length (algebraic) turbulence model.

class multiphase_turbulence(path, service)#

Bases: TUIMenu

Enter the multiphase turbulence menu.

Methods:

multiphase_options(*args, **kwargs)

Enable/disable multiphase options.

rsm_multiphase_models(*args, **kwargs)

Enable/disable the Reynolds Stress multiphase model.

subgrid_turbulence_contribution_aiad(*args, ...)

Enable/disable the Subgrid Turbulence Contribution for the AIAD model.

turbulence_multiphase_models(*args, **kwargs)

Select the k-epsilon multiphase model.
multiphase_options(*args, **kwargs)#

Enable/disable multiphase options.

rsm_multiphase_models(*args, **kwargs)#

Enable/disable the Reynolds Stress multiphase model.

subgrid_turbulence_contribution_aiad(*args, **kwargs)#

Enable/disable the Subgrid Turbulence Contribution for the AIAD model.

turbulence_multiphase_models(*args, **kwargs)#

Select the k-epsilon multiphase model.

class near_wall_treatment(path, service)#

Bases: TUIMenu

Enter the near wall treatment menu.

Methods:

enhanced_wall_treatment(*args, **kwargs)

Enable/disable enhanced wall functions.

menter_lechner(*args, **kwargs)

Enable/disable near wall treatment Menter-Lechner.

non_equilibrium_wall_fn(*args, **kwargs)

Enable/disable non-equilibrium wall functions.

scalable_wall_functions(*args, **kwargs)

Enable/disable scalable wall functions.

user_defined_wall_functions(*args, **kwargs)

Enable user defined wall functions.

wall_omega_treatment(*args, **kwargs)

Set wall omega treatment.

werner_wengle_wall_fn(*args, **kwargs)

Enable/disable Werner-Wengle wall functions.

wf_pressure_gradient_effects(*args, **kwargs)

Enable/disable wall function pressure-gradient effects.

wf_thermal_effects(*args, **kwargs)

Enable/disable wall function thermal effects.
enhanced_wall_treatment(*args, **kwargs)#

Enable/disable enhanced wall functions.

menter_lechner(*args, **kwargs)#

Enable/disable near wall treatment Menter-Lechner.

non_equilibrium_wall_fn(*args, **kwargs)#

Enable/disable non-equilibrium wall functions.

scalable_wall_functions(*args, **kwargs)#

Enable/disable scalable wall functions.

user_defined_wall_functions(*args, **kwargs)#

Enable user defined wall functions.

wall_omega_treatment(*args, **kwargs)#

Set wall omega treatment.

werner_wengle_wall_fn(*args, **kwargs)#

Enable/disable Werner-Wengle wall functions.

wf_pressure_gradient_effects(*args, **kwargs)#

Enable/disable wall function pressure-gradient effects.

wf_thermal_effects(*args, **kwargs)#

Enable/disable wall function thermal effects.

reynolds_stress_model(*args, **kwargs)#

Enable/disable the RSM turbulence model.

rng_differential_visc(*args, **kwargs)#

Enable/disable the differential-viscosity model.

rng_swirl_model(*args, **kwargs)#

Enable/disable swirl corrections for rng-model.

rsm_bsl_based(*args, **kwargs)#

Enable/disable the Stress-BSL model.

rsm_linear_pressure_strain(*args, **kwargs)#

Enable/disable the linear pressure-strain model in RSM.

rsm_omega_based(*args, **kwargs)#

Enable/disable the Stress-omega model.

rsm_or_earsm_geko_option(*args, **kwargs)#

Enable/disable the GEKO option for RSM or EARSM.

rsm_solve_tke(*args, **kwargs)#

Enable/disable the solution of T.K.E. in RSM model.

rsm_ssg_pressure_strain(*args, **kwargs)#

Enable/disable the quadratic pressure-strain model in RSM.

rsm_wall_echo(*args, **kwargs)#

Enable/disable wall-echo effects in RSM model.

sa_alternate_prod(*args, **kwargs)#

Enable/disable strain/vorticity production in Spalart-Allmaras model.

sa_damping(*args, **kwargs)#

Enable/disable the full low-Reynolds number form of Spalart-Allmaras model.

sa_enhanced_wall_treatment(*args, **kwargs)#

Enable/disable the enhanced wall treatment for the Spalart-Allmaras model. If disabled, no smooth blending between the viscous sublayer and the log-law formulation is employed, as was done in versions previous to Fluent14.

sas(*args, **kwargs)#

Enable/disable the SAS turbulence model.

spalart_allmaras(*args, **kwargs)#

Enable/disable the Spalart-Allmaras turbulence model.

trans_sst_roughness_correlation(*args, **kwargs)#

Enable/disable the Transition-SST roughness correlation option.

class transition_model_options(path, service)#

Bases: TUIMenu

Enter the transition model options menu.

Methods:

capg_hightu(*args, **kwargs)

Set the algebraic transition model coefficient CAPG_HIGHTU.

capg_lowtu(*args, **kwargs)

Set the algebraic transition model coefficient CAPG_LOWTU.

cbubble_c1(*args, **kwargs)

Set the algebraic transition model coefficient CBUBBLE_C1.

cbubble_c2(*args, **kwargs)

Set the algebraic transition model coefficient CBUBBLE_C2.

cfpg_hightu(*args, **kwargs)

Set the algebraic transition model coefficient CFPG_HIGHTU.

cfpg_lowtu(*args, **kwargs)

Set the algebraic transition model coefficient CFPG_LOWTU.

clambda_scale(*args, **kwargs)

Set the algebraic transition model coefficient CLAMBDA_SCALE.

critical_reynolds_number_correlation(*args, ...)

Set the critical Reynolds number correlation.

crossflow_transition(*args, **kwargs)

Enable/disable crossflow transition for the intermittency transition model.

ctu_hightu(*args, **kwargs)

Set the algebraic transition model coefficient CTU_HIGHTU.

ctu_lowtu(*args, **kwargs)

Set the algebraic transition model coefficient CTU_LOWTU.

rec_c1(*args, **kwargs)

Set the algebraic transition model coefficient REC_C1.

rec_c2(*args, **kwargs)

Set the algebraic transition model coefficient REC_C2.

rec_max(*args, **kwargs)

Set the algebraic transition model coefficient REC_MAX.

rv1_switch(*args, **kwargs)

Set the algebraic transition model coefficient RV1_SWITCH.
capg_hightu(*args, **kwargs)#

Set the algebraic transition model coefficient CAPG_HIGHTU.

capg_lowtu(*args, **kwargs)#

Set the algebraic transition model coefficient CAPG_LOWTU.

cbubble_c1(*args, **kwargs)#

Set the algebraic transition model coefficient CBUBBLE_C1.

cbubble_c2(*args, **kwargs)#

Set the algebraic transition model coefficient CBUBBLE_C2.

cfpg_hightu(*args, **kwargs)#

Set the algebraic transition model coefficient CFPG_HIGHTU.

cfpg_lowtu(*args, **kwargs)#

Set the algebraic transition model coefficient CFPG_LOWTU.

clambda_scale(*args, **kwargs)#

Set the algebraic transition model coefficient CLAMBDA_SCALE.

critical_reynolds_number_correlation(*args, **kwargs)#

Set the critical Reynolds number correlation.

crossflow_transition(*args, **kwargs)#

Enable/disable crossflow transition for the intermittency transition model.

ctu_hightu(*args, **kwargs)#

Set the algebraic transition model coefficient CTU_HIGHTU.

ctu_lowtu(*args, **kwargs)#

Set the algebraic transition model coefficient CTU_LOWTU.

rec_c1(*args, **kwargs)#

Set the algebraic transition model coefficient REC_C1.

rec_c2(*args, **kwargs)#

Set the algebraic transition model coefficient REC_C2.

rec_max(*args, **kwargs)#

Set the algebraic transition model coefficient REC_MAX.

rv1_switch(*args, **kwargs)#

Set the algebraic transition model coefficient RV1_SWITCH.

transition_sst(*args, **kwargs)#

Enable/disable the transition SST turbulence model.

turb_buoyancy_effects(*args, **kwargs)#

Select buoyancy effects on turbulence.

turb_compressibility(*args, **kwargs)#

Enable/disable the compressibility correction option.

class turbulence_expert(path, service)#

Bases: TUIMenu

Enter the turbulence expert menu.

Methods:

kato_launder_model(*args, **kwargs)

Enable/disable Kato-Launder modification for production.

kw_add_des(*args, **kwargs)

Enable/disable DES-mode with the current turbulence model.

kw_add_sas(*args, **kwargs)

Enable/disable the SAS-mode with the current turbulence model.

kw_vorticity_based_production(*args, **kwargs)

Enable/disable vorticity based production.

low_re_ke(*args, **kwargs)

Enable/disable the low-Re k-epsilon turbulence model.

low_re_ke_index(*args, **kwargs)

Enable/disable the low-Re k-epsilon model version.

non_newtonian_modification(*args, **kwargs)

Enable/disable non-Newtonian modification for Lam-Bremhorst model.

production_limiter(*args, **kwargs)

Enable/disable the Production Limiter.

restore_sst_v61(*args, **kwargs)

Enable/disable SST formulation of v6.1.

rke_cmu_rotation_term(*args, **kwargs)

Enable/disable inclusion of omega in the Cmu definition.

sbes_les_subgrid_dynamic_fvar(*args, **kwargs)

Enable/disable the dynamic subgrid-scale mixture fraction variance model.

sbes_sdes_hybrid_model(*args, **kwargs)

Select the SBES / SDES hybrid model.

sbes_sgs_option(*args, **kwargs)

Select SBES subgrid-scale model.

sbes_update_interval_k_omega(*args, **kwargs)

Set an integer value how often the k and omega equations are updated in a transient SBES run.

thermal_p_function(*args, **kwargs)

Enable/disable the Jayatilleke P function.

turb_add_sbes_sdes(*args, **kwargs)

Enable/disable SBES / SDES with the current turbulence model.

turb_non_newtonian(*args, **kwargs)

Enable/disable turbulence for non-Newtonian fluids.

turb_pk_compressible(*args, **kwargs)

Enable/disable turbulent production due to compressible divergence.

turbulence_damping(*args, **kwargs)

Enable/disable turbulence damping and set turbulence damping parameters.
kato_launder_model(*args, **kwargs)#

Enable/disable Kato-Launder modification for production.

kw_add_des(*args, **kwargs)#

Enable/disable DES-mode with the current turbulence model.

kw_add_sas(*args, **kwargs)#

Enable/disable the SAS-mode with the current turbulence model.

kw_vorticity_based_production(*args, **kwargs)#

Enable/disable vorticity based production.

low_re_ke(*args, **kwargs)#

Enable/disable the low-Re k-epsilon turbulence model.

low_re_ke_index(*args, **kwargs)#

Enable/disable the low-Re k-epsilon model version.

non_newtonian_modification(*args, **kwargs)#

Enable/disable non-Newtonian modification for Lam-Bremhorst model.

production_limiter(*args, **kwargs)#

Enable/disable the Production Limiter.

restore_sst_v61(*args, **kwargs)#

Enable/disable SST formulation of v6.1.

rke_cmu_rotation_term(*args, **kwargs)#

Enable/disable inclusion of omega in the Cmu definition.

sbes_les_subgrid_dynamic_fvar(*args, **kwargs)#

Enable/disable the dynamic subgrid-scale mixture fraction variance model.

sbes_sdes_hybrid_model(*args, **kwargs)#

Select the SBES / SDES hybrid model.

sbes_sgs_option(*args, **kwargs)#

Select SBES subgrid-scale model.

sbes_update_interval_k_omega(*args, **kwargs)#

Set an integer value how often the k and omega equations are updated in a transient SBES run.

thermal_p_function(*args, **kwargs)#

Enable/disable the Jayatilleke P function.

turb_add_sbes_sdes(*args, **kwargs)#

Enable/disable SBES / SDES with the current turbulence model.

turb_non_newtonian(*args, **kwargs)#

Enable/disable turbulence for non-Newtonian fluids.

turb_pk_compressible(*args, **kwargs)#

Enable/disable turbulent production due to compressible divergence.

turbulence_damping(*args, **kwargs)#

Enable/disable turbulence damping and set turbulence damping parameters.

user_defined(*args, **kwargs)#

Select user-defined functions to define the turbulent viscosity and the turbulent Prandtl and Schmidt numbers.

user_defined_transition(*args, **kwargs)#

Set user-defined transition correlations.

v2f(*args, **kwargs)#

Enable/disable the V2F turbulence model.

zero_equation_hvac(*args, **kwargs)#

Enable/disable the zero-equation HVAC turbulence model.

class named_expressions(path, service)#

Bases: TUIMenu

Manage named expressions.

Methods:

add(*args, **kwargs)

Add a new object.

compute(*args, **kwargs)

Compute expression.

copy(*args, **kwargs)

Copy expression.

delete(*args, **kwargs)

Delete an object.

edit(*args, **kwargs)

Edit an object.

export_to_tsv(*args, **kwargs)

Export expressions.

import_from_tsv(*args, **kwargs)

Export expressions.

list(*args, **kwargs)

List objects.

list_properties(*args, **kwargs)

List properties of an object.
add(*args, **kwargs)#

Add a new object.

compute(*args, **kwargs)#

Compute expression.

copy(*args, **kwargs)#

Copy expression.

delete(*args, **kwargs)#

Delete an object.

edit(*args, **kwargs)#

Edit an object.

export_to_tsv(*args, **kwargs)#

Export expressions.

import_from_tsv(*args, **kwargs)#

Export expressions.

list(*args, **kwargs)#

List objects.

list_properties(*args, **kwargs)#

List properties of an object.

class operating_conditions(path, service)#

Bases: TUIMenu

Enter the define operating conditions menu.

Methods:

gravity(*args, **kwargs)

Set gravitational acceleration.

gravity_mrf_behavior(*args, **kwargs)

Enable/disable the fix of gravity vector in a stationary reference frame.

operating_density(*args, **kwargs)

Multiphase flow Operating Density menu.

operating_pressure(*args, **kwargs)

Set the operating pressure.

operating_temperature(*args, **kwargs)

Set the operating temperature for Boussinesq.

reference_pressure_location(*args, **kwargs)

Set coordinates of reference pressure.

reference_pressure_method(*args, **kwargs)

Choosing reference pressure type.

set_state(*args, **kwargs)

Select state for real gas EOS subcritical condition.

use_inlet_temperature_for_operating_density(...)

Use Inlet Temperature to calculate Opearating Density.

used_ref_pressure_location(*args, **kwargs)

See the actual coordinates of reference pressure used.
gravity(*args, **kwargs)#

Set gravitational acceleration.

gravity_mrf_behavior(*args, **kwargs)#

Enable/disable the fix of gravity vector in a stationary reference frame.

operating_density(*args, **kwargs)#

Multiphase flow Operating Density menu.

operating_pressure(*args, **kwargs)#

Set the operating pressure.

operating_temperature(*args, **kwargs)#

Set the operating temperature for Boussinesq.

reference_pressure_location(*args, **kwargs)#

Set coordinates of reference pressure.

reference_pressure_method(*args, **kwargs)#

Choosing reference pressure type.

set_state(*args, **kwargs)#

Select state for real gas EOS subcritical condition.

use_inlet_temperature_for_operating_density(*args, **kwargs)#

Use Inlet Temperature to calculate Opearating Density.

used_ref_pressure_location(*args, **kwargs)#

See the actual coordinates of reference pressure used.

class overset_interfaces(path, service)#

Bases: TUIMenu

Enter the overset-interfaces menu.

Classes:

adapt(path, service)

Enter the overset adaption menu.

cut_control(path, service)

Enter the overset hole cut control menu.

options(path, service)

Enter the overset interface options menu.

Methods:

check(*args, **kwargs)

Check all overset interfaces.

clear(*args, **kwargs)

Clear an overset interface.

clear_all(*args, **kwargs)

Clear all overset interfaces.

create(*args, **kwargs)

Create an overset interface.

debug_hole_cut(*args, **kwargs)

Debugging tool for overset hole cutting.

delete(*args, **kwargs)

Delete an overset interface.

delete_all(*args, **kwargs)

Delete all overset interfaces.

display_cells(*args, **kwargs)

Display the marked overset cells.

fill_dci(*args, **kwargs)

Fill overset domain connectivity information (DCI).

find_all_bounding_cells(*args, **kwargs)

Find bounding cells for all cell centroids.

find_bounding_cell(*args, **kwargs)

Find bounding cell for given cell or search point.

free_dci(*args, **kwargs)

Free overset domain connectivity information (DCI).

grid_priorities(*args, **kwargs)

Edit grid priorities for an overset interface.

intersect(*args, **kwargs)

Intersect an overset interface.

intersect_all(*args, **kwargs)

Intersect all overset interfaces.

list(*args, **kwargs)

List all overset interfaces.

mark_cell_change(*args, **kwargs)

Mark overset interface related cell type change.

mark_cells(*args, **kwargs)

Mark overset interface related cell types.

read_dci_from_case(*args, **kwargs)

Read domain connectivity information (DCI) from case file.

set_mark_bounds(*args, **kwargs)

Set bounds (center, radius) for overset cell marking.

update_from_dci(*args, **kwargs)

Update all overset intrfaces from stored domain connectivity information (DCI).

write_cell_types(*args, **kwargs)

Write overset cell types into file.

write_dci(*args, **kwargs)

Save domain connectivity information (DCI) to a text file.

write_dci_to_case(*args, **kwargs)

Save domain connectivity information (DCI) to case file.
class adapt(path, service)#

Bases: TUIMenu

Enter the overset adaption menu.

Methods:

adapt_mesh(*args, **kwargs)

Mark and adapt the mesh to remove orphan cells and large donor-receptor cell size differences.

mark_adaption(*args, **kwargs)

Mark cells for overset orphan adaption and donor-receptor size differences.

Classes:

set(path, service)

Enter the overset adaption set menu.
adapt_mesh(*args, **kwargs)#

Mark and adapt the mesh to remove orphan cells and large donor-receptor cell size differences.

mark_adaption(*args, **kwargs)#

Mark cells for overset orphan adaption and donor-receptor size differences.

class set(path, service)#

Bases: TUIMenu

Enter the overset adaption set menu.

Methods:

adaption_sweeps(*args, **kwargs)

Set the number of adaption sweeps per overset adaption.

anisotropic(*args, **kwargs)

Enable the option to use anisotropic adaption in prismatic cells.

automatic(*args, **kwargs)

Enable the option to automatically adapt overset meshes during solution update.

buffer_layers(*args, **kwargs)

Set the number of cell layers marked in addition to the cells marked for orphan adaption.

gap_resolution(*args, **kwargs)

Set the target (minimum) gap resolution used when marking cells for gap adaption.

length_ratio_max(*args, **kwargs)

Set the length scale ratio threshold used to determine which cells are marked for adaption based on donor-receptor cell size differences.

mark_coarsening(*args, **kwargs)

Enable the option to coarsen the mesh during overset adaption.

mark_fixed_orphans(*args, **kwargs)

Enable the option to adapt for orphans which were removed by accepting neighbor donors.

mark_gaps(*args, **kwargs)

Enable the option to adapt underresolved gaps.

mark_orphans(*args, **kwargs)

Enable the option to adapt for orphan reduction.

mark_size(*args, **kwargs)

Enable the option to adapt for donor-receptor cell size differences.

maximum_refinement_level(*args, **kwargs)

Set the maximum level of refinement in overset adaption.
adaption_sweeps(*args, **kwargs)#

Set the number of adaption sweeps per overset adaption.

anisotropic(*args, **kwargs)#

Enable the option to use anisotropic adaption in prismatic cells.

automatic(*args, **kwargs)#

Enable the option to automatically adapt overset meshes during solution update.

buffer_layers(*args, **kwargs)#

Set the number of cell layers marked in addition to the cells marked for orphan adaption.

gap_resolution(*args, **kwargs)#

Set the target (minimum) gap resolution used when marking cells for gap adaption.

length_ratio_max(*args, **kwargs)#

Set the length scale ratio threshold used to determine which cells are marked for adaption based on donor-receptor cell size differences.

mark_coarsening(*args, **kwargs)#

Enable the option to coarsen the mesh during overset adaption.

mark_fixed_orphans(*args, **kwargs)#

Enable the option to adapt for orphans which were removed by accepting neighbor donors.

mark_gaps(*args, **kwargs)#

Enable the option to adapt underresolved gaps.

mark_orphans(*args, **kwargs)#

Enable the option to adapt for orphan reduction.

mark_size(*args, **kwargs)#

Enable the option to adapt for donor-receptor cell size differences.

maximum_refinement_level(*args, **kwargs)#

Set the maximum level of refinement in overset adaption.

check(*args, **kwargs)#

Check all overset interfaces.

clear(*args, **kwargs)#

Clear an overset interface.

clear_all(*args, **kwargs)#

Clear all overset interfaces.

create(*args, **kwargs)#

Create an overset interface.

class cut_control(path, service)#

Bases: TUIMenu

Enter the overset hole cut control menu.

Methods:

add(*args, **kwargs)

Add hole cut control for a boundary zone.

delete(*args, **kwargs)

Delete hole cut control for a boundary zone.

delete_all(*args, **kwargs)

Delete the hole cut controls for all boundary zones.

list(*args, **kwargs)

List the defined hole cut controls.

Classes:

cut_seeds(path, service)

Enter the overset hole cut seed menu.
add(*args, **kwargs)#

Add hole cut control for a boundary zone.

class cut_seeds(path, service)#

Bases: TUIMenu

Enter the overset hole cut seed menu.

Methods:

add(*args, **kwargs)

Add a hole cut seed.

cut_seeds_for_all_component_zones(*args, ...)

Enable that all component zones get a cut seed.

delete(*args, **kwargs)

Delete a hole cut seed.

delete_all(*args, **kwargs)

Delete all hole cut seeds.

list(*args, **kwargs)

List the defined hole cut seeds.
add(*args, **kwargs)#

Add a hole cut seed.

cut_seeds_for_all_component_zones(*args, **kwargs)#

Enable that all component zones get a cut seed.

delete(*args, **kwargs)#

Delete a hole cut seed.

delete_all(*args, **kwargs)#

Delete all hole cut seeds.

list(*args, **kwargs)#

List the defined hole cut seeds.

delete(*args, **kwargs)#

Delete hole cut control for a boundary zone.

delete_all(*args, **kwargs)#

Delete the hole cut controls for all boundary zones.

list(*args, **kwargs)#

List the defined hole cut controls.

debug_hole_cut(*args, **kwargs)#

Debugging tool for overset hole cutting.

delete(*args, **kwargs)#

Delete an overset interface.

delete_all(*args, **kwargs)#

Delete all overset interfaces.

display_cells(*args, **kwargs)#

Display the marked overset cells.

fill_dci(*args, **kwargs)#

Fill overset domain connectivity information (DCI).

find_all_bounding_cells(*args, **kwargs)#

Find bounding cells for all cell centroids.

find_bounding_cell(*args, **kwargs)#

Find bounding cell for given cell or search point.

free_dci(*args, **kwargs)#

Free overset domain connectivity information (DCI).

grid_priorities(*args, **kwargs)#

Edit grid priorities for an overset interface.

intersect(*args, **kwargs)#

Intersect an overset interface.

intersect_all(*args, **kwargs)#

Intersect all overset interfaces.

list(*args, **kwargs)#

List all overset interfaces.

mark_cell_change(*args, **kwargs)#

Mark overset interface related cell type change.

mark_cells(*args, **kwargs)#

Mark overset interface related cell types.

class options(path, service)#

Bases: TUIMenu

Enter the overset interface options menu.

Methods:

auto_create(*args, **kwargs)

Enable automatic creation of default overset interface.

dead_cell_update(*args, **kwargs)

Enable dead cell update in moving or dynamic mesh simulations.

donor_priority_method(*args, **kwargs)

Set method used to evaludate the cell donor priority.

expert(*args, **kwargs)

Enable additional overset options and tools.

mesh_interfaces(*args, **kwargs)

Allow mesh interfaces inside overset cell zones.

minimize_overlap(*args, **kwargs)

Enable overlap minimization for overset interfaces.

modified_donor_search(*args, **kwargs)

Enable modified and more extensive donor search.

modified_hole_cutting(*args, **kwargs)

Enable modified hole cutting parameters.

node_connected_donors(*args, **kwargs)

Enable node or face connected donor cells.

overlap_boundaries(*args, **kwargs)

Enable overset topologies with overlap boundaries.

parallel(*args, **kwargs)

Set options to control running overset in parallel.

partial_cut_faces(*args, **kwargs)

Enable enhanced hole cutting where cut faces partially overlap.

render_receptor_cells(*args, **kwargs)

Set the option to include receptor cells in postprocessing.

solve_island_removal(*args, **kwargs)

Set method used to control the removal of isolated patches of solve cells.

transient_caching(*args, **kwargs)

Set options to control caching of entities in transient overset simulations.

update_before_case_write(*args, **kwargs)

Enable update of overset interfaces before writing case file (CFF format only).

verbosity(*args, **kwargs)

Set overset mesh reporting verbosity.
auto_create(*args, **kwargs)#

Enable automatic creation of default overset interface.

dead_cell_update(*args, **kwargs)#

Enable dead cell update in moving or dynamic mesh simulations.

donor_priority_method(*args, **kwargs)#

Set method used to evaludate the cell donor priority.

expert(*args, **kwargs)#

Enable additional overset options and tools.

mesh_interfaces(*args, **kwargs)#

Allow mesh interfaces inside overset cell zones.

minimize_overlap(*args, **kwargs)#

Enable overlap minimization for overset interfaces.

Enable modified and more extensive donor search.

modified_hole_cutting(*args, **kwargs)#

Enable modified hole cutting parameters.

node_connected_donors(*args, **kwargs)#

Enable node or face connected donor cells.

overlap_boundaries(*args, **kwargs)#

Enable overset topologies with overlap boundaries.

parallel(*args, **kwargs)#

Set options to control running overset in parallel.

partial_cut_faces(*args, **kwargs)#

Enable enhanced hole cutting where cut faces partially overlap.

render_receptor_cells(*args, **kwargs)#

Set the option to include receptor cells in postprocessing.

solve_island_removal(*args, **kwargs)#

Set method used to control the removal of isolated patches of solve cells.

transient_caching(*args, **kwargs)#

Set options to control caching of entities in transient overset simulations.

update_before_case_write(*args, **kwargs)#

Enable update of overset interfaces before writing case file (CFF format only).

verbosity(*args, **kwargs)#

Set overset mesh reporting verbosity.

read_dci_from_case(*args, **kwargs)#

Read domain connectivity information (DCI) from case file.

set_mark_bounds(*args, **kwargs)#

Set bounds (center, radius) for overset cell marking.

update_from_dci(*args, **kwargs)#

Update all overset intrfaces from stored domain connectivity information (DCI).

write_cell_types(*args, **kwargs)#

Write overset cell types into file.

write_dci(*args, **kwargs)#

Save domain connectivity information (DCI) to a text file.

write_dci_to_case(*args, **kwargs)#

Save domain connectivity information (DCI) to case file.

class reference_frames(path, service)#

Bases: TUIMenu

Manage reference frames.

Methods:

add(*args, **kwargs)

Add a new object.

delete(*args, **kwargs)

Delete an object.

display(*args, **kwargs)

Display Reference Frame.

display_edit(*args, **kwargs)

Display and edit reference frame from graphics.

edit(*args, **kwargs)

Edit an object.

hide(*args, **kwargs)

Hide Reference Frame.

list(*args, **kwargs)

List objects.

list_properties(*args, **kwargs)

List properties of an object.
add(*args, **kwargs)#

Add a new object.

delete(*args, **kwargs)#

Delete an object.

display(*args, **kwargs)#

Display Reference Frame.

display_edit(*args, **kwargs)#

Display and edit reference frame from graphics.

edit(*args, **kwargs)#

Edit an object.

hide(*args, **kwargs)#

Hide Reference Frame.

list(*args, **kwargs)#

List objects.

list_properties(*args, **kwargs)#

List properties of an object.

class reference_values(path, service)#

Bases: TUIMenu

Reference value menu.

Methods:

area(*args, **kwargs)

Set reference area for normalization.

density(*args, **kwargs)

Set reference density for normalization.

depth(*args, **kwargs)

Set reference depth for volume calculation.

enthalpy(*args, **kwargs)

Set reference enthalpy for enthalpy damping and normalization.

length(*args, **kwargs)

Set reference length for normalization.

list(*args, **kwargs)

List current reference values.

pressure(*args, **kwargs)

Set reference pressure for normalization.

temperature(*args, **kwargs)

Set reference temperature for normalization.

velocity(*args, **kwargs)

Set reference velocity for normalization.

viscosity(*args, **kwargs)

Set reference viscosity for normalization.

yplus(*args, **kwargs)

Set reference yplus for normalization.

zone(*args, **kwargs)

Set reference zone.

Classes:

compute(path, service)

Enter the compute menu.
area(*args, **kwargs)#

Set reference area for normalization.

class compute(path, service)#

Bases: TUIMenu

Enter the compute menu.

Methods:

axis(*args, **kwargs)

Compute reference values from a zone of this type.

degassing(*args, **kwargs)

Compute reference values from a zone of this type.

dummy_entry(*args, **kwargs)

.

exhaust_fan(*args, **kwargs)

Compute reference values from a zone of this type.

fan(*args, **kwargs)

Compute reference values from a zone of this type.

fluid(*args, **kwargs)

Compute reference values from a zone of this type.

geometry(*args, **kwargs)

Compute reference values from a zone of this type.

inlet_vent(*args, **kwargs)

Compute reference values from a zone of this type.

intake_fan(*args, **kwargs)

Compute reference values from a zone of this type.

interface(*args, **kwargs)

Compute reference values from a zone of this type.

interior(*args, **kwargs)

Compute reference values from a zone of this type.

mass_flow_inlet(*args, **kwargs)

Compute reference values from a zone of this type.

mass_flow_outlet(*args, **kwargs)

Compute reference values from a zone of this type.

network(*args, **kwargs)

Compute reference values from a zone of this type.

network_end(*args, **kwargs)

Compute reference values from a zone of this type.

outflow(*args, **kwargs)

Compute reference values from a zone of this type.

outlet_vent(*args, **kwargs)

Compute reference values from a zone of this type.

overset(*args, **kwargs)

Compute reference values from a zone of this type.

periodic(*args, **kwargs)

Compute reference values from a zone of this type.

porous_jump(*args, **kwargs)

Compute reference values from a zone of this type.

pressure_far_field(*args, **kwargs)

Compute reference values from a zone of this type.

pressure_inlet(*args, **kwargs)

Compute reference values from a zone of this type.

pressure_outlet(*args, **kwargs)

Compute reference values from a zone of this type.

radiator(*args, **kwargs)

Compute reference values from a zone of this type.

rans_les_interface(*args, **kwargs)

Compute reference values from a zone of this type.

recirculation_inlet(*args, **kwargs)

Compute reference values from a zone of this type.

recirculation_outlet(*args, **kwargs)

Compute reference values from a zone of this type.

shadow(*args, **kwargs)

Compute reference values from a zone of this type.

solid(*args, **kwargs)

Compute reference values from a zone of this type.

symmetry(*args, **kwargs)

Compute reference values from a zone of this type.

velocity_inlet(*args, **kwargs)

Compute reference values from a zone of this type.

wall(*args, **kwargs)

Compute reference values from a zone of this type.
axis(*args, **kwargs)#

Compute reference values from a zone of this type.

degassing(*args, **kwargs)#

Compute reference values from a zone of this type.

dummy_entry(*args, **kwargs)#

.

exhaust_fan(*args, **kwargs)#

Compute reference values from a zone of this type.

fan(*args, **kwargs)#

Compute reference values from a zone of this type.

fluid(*args, **kwargs)#

Compute reference values from a zone of this type.

geometry(*args, **kwargs)#

Compute reference values from a zone of this type.

inlet_vent(*args, **kwargs)#

Compute reference values from a zone of this type.

intake_fan(*args, **kwargs)#

Compute reference values from a zone of this type.

interface(*args, **kwargs)#

Compute reference values from a zone of this type.

interior(*args, **kwargs)#

Compute reference values from a zone of this type.

mass_flow_inlet(*args, **kwargs)#

Compute reference values from a zone of this type.

mass_flow_outlet(*args, **kwargs)#

Compute reference values from a zone of this type.

network(*args, **kwargs)#

Compute reference values from a zone of this type.

network_end(*args, **kwargs)#

Compute reference values from a zone of this type.

outflow(*args, **kwargs)#

Compute reference values from a zone of this type.

outlet_vent(*args, **kwargs)#

Compute reference values from a zone of this type.

overset(*args, **kwargs)#

Compute reference values from a zone of this type.

periodic(*args, **kwargs)#

Compute reference values from a zone of this type.

porous_jump(*args, **kwargs)#

Compute reference values from a zone of this type.

pressure_far_field(*args, **kwargs)#

Compute reference values from a zone of this type.

pressure_inlet(*args, **kwargs)#

Compute reference values from a zone of this type.

pressure_outlet(*args, **kwargs)#

Compute reference values from a zone of this type.

radiator(*args, **kwargs)#

Compute reference values from a zone of this type.

rans_les_interface(*args, **kwargs)#

Compute reference values from a zone of this type.

recirculation_inlet(*args, **kwargs)#

Compute reference values from a zone of this type.

recirculation_outlet(*args, **kwargs)#

Compute reference values from a zone of this type.

shadow(*args, **kwargs)#

Compute reference values from a zone of this type.

solid(*args, **kwargs)#

Compute reference values from a zone of this type.

symmetry(*args, **kwargs)#

Compute reference values from a zone of this type.

velocity_inlet(*args, **kwargs)#

Compute reference values from a zone of this type.

wall(*args, **kwargs)#

Compute reference values from a zone of this type.

density(*args, **kwargs)#

Set reference density for normalization.

depth(*args, **kwargs)#

Set reference depth for volume calculation.

enthalpy(*args, **kwargs)#

Set reference enthalpy for enthalpy damping and normalization.

length(*args, **kwargs)#

Set reference length for normalization.

list(*args, **kwargs)#

List current reference values.

pressure(*args, **kwargs)#

Set reference pressure for normalization.

temperature(*args, **kwargs)#

Set reference temperature for normalization.

velocity(*args, **kwargs)#

Set reference velocity for normalization.

viscosity(*args, **kwargs)#

Set reference viscosity for normalization.

yplus(*args, **kwargs)#

Set reference yplus for normalization.

zone(*args, **kwargs)#

Set reference zone.

class turbo_model(path, service)#

Bases: TUIMenu

Turbo features menu.

Methods:

append_graphics_spectral_content(*args, **kwargs)

Define post-processing related spectral content.

append_phaselag_spectral_content(*args, **kwargs)

Define phaselag related spectral content.

blade_flutter_row(*args, **kwargs)

Define the periodic displacement row.

create_graphics_spectral_content(*args, **kwargs)

Define post-processing related spectral content.

create_phaselag_spectral_content(*args, **kwargs)

Define phaselag related spectral content.

create_turbomachine_description(*args, **kwargs)

Define turbomachine description.

delete_graphics_spectral_content(*args, **kwargs)

Delete post-processing related spectral content.

delete_phaselag_spectral_content(*args, **kwargs)

Delete phaselag related spectral content.

delete_turbomachine_description(*args, **kwargs)

Delete turbomachine description.

enable_turbo_model(*args, **kwargs)

Enable/disable turbo model menu.

graphics_extra_settings(*args, **kwargs)

Define phaselag related extra settings.

isentropic_efficiency(*args, **kwargs)

Compute isentropic efficiency using general property functions for enthalpy.

list_graphics_spectral_content(*args, **kwargs)

List post-processing related spectral content.

list_phaselag_state(*args, **kwargs)

List all phaselag related case settings.

list_turbomachine_description(*args, **kwargs)

List turbomachine description.

make_phaselag_from_boundaries(*args, **kwargs)

Make interface zones phase lagged.

make_phaselag_from_periodic(*args, **kwargs)

Convert periodic interface to phase lagged.

phaselag_extra_settings(*args, **kwargs)

Define phaselag related extra settings.

separate_nonoverlapping_interface_boundary(...)

Split a general turbo interface non-overlapping zone.

turbo_create(*args, **kwargs)

Create a general turbo interface.

turbo_interface_check(*args, **kwargs)

Check General Turbo Interface and Phase-lag.

Classes:

blade_flutter_harmonics(path, service)

Enter the blade flutter harmonics menu.

general_turbo_interface_settings(path, service)

Set General Turbo Interface options.

turbo_topology(path, service)

Define turbo topology.
append_graphics_spectral_content(*args, **kwargs)#

Define post-processing related spectral content.

append_phaselag_spectral_content(*args, **kwargs)#

Define phaselag related spectral content.

class blade_flutter_harmonics(path, service)#

Bases: TUIMenu

Enter the blade flutter harmonics menu.

Methods:

enable_harmonic_exports(*args, **kwargs)

Calculates/Deletes flutter harmonic export data.

write_aerodamping_vs_nodal_diameter(*args, ...)

Reads report definition file and Writes influence coefficient aerodynamic damping values vs nodal diameter.

write_harmonic_exports(*args, **kwargs)

Writes harmonic export data.
enable_harmonic_exports(*args, **kwargs)#

Calculates/Deletes flutter harmonic export data.

write_aerodamping_vs_nodal_diameter(*args, **kwargs)#

Reads report definition file and Writes influence coefficient aerodynamic damping values vs nodal diameter.

write_harmonic_exports(*args, **kwargs)#

Writes harmonic export data.

blade_flutter_row(*args, **kwargs)#

Define the periodic displacement row.

create_graphics_spectral_content(*args, **kwargs)#

Define post-processing related spectral content.

create_phaselag_spectral_content(*args, **kwargs)#

Define phaselag related spectral content.

create_turbomachine_description(*args, **kwargs)#

Define turbomachine description.

delete_graphics_spectral_content(*args, **kwargs)#

Delete post-processing related spectral content.

delete_phaselag_spectral_content(*args, **kwargs)#

Delete phaselag related spectral content.

delete_turbomachine_description(*args, **kwargs)#

Delete turbomachine description.

enable_turbo_model(*args, **kwargs)#

Enable/disable turbo model menu.

class general_turbo_interface_settings(path, service)#

Bases: TUIMenu

Set General Turbo Interface options.

Methods:

expert(*args, **kwargs)

Set the expert parameters for turbo interfaces.

Classes:

mixing_plane_model_settings(path, service)

Set the mixing plane model settings.
expert(*args, **kwargs)#

Set the expert parameters for turbo interfaces.

class mixing_plane_model_settings(path, service)#

Bases: TUIMenu

Set the mixing plane model settings.

Methods:

averaging_method(*args, **kwargs)

Set the averaging method for the mixing.

bands_type(*args, **kwargs)

To set the mixing plane bands type.

list_mixing_planes(*args, **kwargs)

List the settings of mixing planes in the case.

mixing_set_constraint(*args, **kwargs)

To set the mixing of primitive or total variable approach.

number_of_bands(*args, **kwargs)

Set the maximum number of bands to be used for mixing.
averaging_method(*args, **kwargs)#

Set the averaging method for the mixing.

bands_type(*args, **kwargs)#

To set the mixing plane bands type.

list_mixing_planes(*args, **kwargs)#

List the settings of mixing planes in the case.

mixing_set_constraint(*args, **kwargs)#

To set the mixing of primitive or total variable approach.

number_of_bands(*args, **kwargs)#

Set the maximum number of bands to be used for mixing.

graphics_extra_settings(*args, **kwargs)#

Define phaselag related extra settings.

isentropic_efficiency(*args, **kwargs)#

Compute isentropic efficiency using general property functions for enthalpy.

list_graphics_spectral_content(*args, **kwargs)#

List post-processing related spectral content.

list_phaselag_state(*args, **kwargs)#

List all phaselag related case settings.

list_turbomachine_description(*args, **kwargs)#

List turbomachine description.

make_phaselag_from_boundaries(*args, **kwargs)#

Make interface zones phase lagged.

make_phaselag_from_periodic(*args, **kwargs)#

Convert periodic interface to phase lagged.

phaselag_extra_settings(*args, **kwargs)#

Define phaselag related extra settings.

separate_nonoverlapping_interface_boundary(*args, **kwargs)#

Split a general turbo interface non-overlapping zone.

turbo_create(*args, **kwargs)#

Create a general turbo interface.

turbo_interface_check(*args, **kwargs)#

Check General Turbo Interface and Phase-lag.

class turbo_topology(path, service)#

Bases: TUIMenu

Define turbo topology.

Methods:

define_topology(*args, **kwargs)

Define a turbo topology.

delete(*args, **kwargs)

Delete a turbo topology.

mesh_method(*args, **kwargs)

Set turbo structured mesh generation method.

projection_method(*args, **kwargs)

Set 2D projection method.

search_method(*args, **kwargs)

Set search method for a topology.
define_topology(*args, **kwargs)#

Define a turbo topology.

delete(*args, **kwargs)#

Delete a turbo topology.

mesh_method(*args, **kwargs)#

Set turbo structured mesh generation method.

projection_method(*args, **kwargs)#

Set 2D projection method.

search_method(*args, **kwargs)#

Set search method for a topology.